doxygen/html/classSampler.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pbrt: Sampler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Sampler Class Reference</h1><!-- doxytag: class="Sampler" -->
<p><code>#include &lt;<a class="el" href="sampling_8h_source.html">sampling.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Sampler:</div>
<div class="dynsection">
 <div class="center">
  <img src="classSampler.png" usemap="#Sampler_map" alt=""/>
  <map id="Sampler_map" name="Sampler_map">
<area href="classBestCandidateSampler.html" alt="BestCandidateSampler" shape="rect" coords="0,56,139,80"/>
<area href="classLDSampler.html" alt="LDSampler" shape="rect" coords="149,56,288,80"/>
<area href="classRandomSampler.html" alt="RandomSampler" shape="rect" coords="298,56,437,80"/>
<area href="classStratifiedSampler.html" alt="StratifiedSampler" shape="rect" coords="447,56,586,80"/>
</map>
 </div>
</div>

<p><a href="classSampler-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#afbbbd238b78dd3024686c852b69fa64e">~Sampler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a4ac91cb80ce3fdd345dc66cc2455debe">Sampler</a> (int xstart, int xend, int ystart, int yend, int spp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#ac88005b971bde8082b2eda26ee1812f8">GetNextSample</a> (<a class="el" href="structSample.html">Sample</a> *sample)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a602a93ebc17bcbeeac87890dcbfe8d67">TotalSamples</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#ad2ca20cd81ffb6fc242c3f0cf6c9812f">RoundSize</a> (int size) const =0</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a32b4ad77407cd6063590828e92d4fdb9">xPixelStart</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#a4a849a8c413ca1560edcaa788a79bade">xPixelEnd</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#afc1a0ab7d6de5341150e87b02b9822fd">yPixelStart</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#ac8b3c8b228e9de66cc8441e619d25d4a">yPixelEnd</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampler.html#ac00cddc4c3f80939f4b2dd871b7ffdfa">samplesPerPixel</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00030">30</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afbbbd238b78dd3024686c852b69fa64e"></a><!-- doxytag: member="Sampler::~Sampler" ref="afbbbd238b78dd3024686c852b69fa64e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Sampler::~Sampler </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8cpp_source.html#l00030">30</a> of file <a class="el" href="sampling_8cpp_source.html">sampling.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4ac91cb80ce3fdd345dc66cc2455debe"></a><!-- doxytag: member="Sampler::Sampler" ref="a4ac91cb80ce3fdd345dc66cc2455debe" args="(int xstart, int xend, int ystart, int yend, int spp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Sampler::Sampler </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>xstart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>xend</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ystart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>yend</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>spp</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8cpp_source.html#l00032">32</a> of file <a class="el" href="sampling_8cpp_source.html">sampling.cpp</a>.</p>

<p>References <a class="el" href="sampling_8h_source.html#l00046">samplesPerPixel</a>, <a class="el" href="sampling_8h_source.html#l00045">xPixelEnd</a>, <a class="el" href="sampling_8h_source.html#l00045">xPixelStart</a>, <a class="el" href="sampling_8h_source.html#l00045">yPixelEnd</a>, and <a class="el" href="sampling_8h_source.html#l00045">yPixelStart</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac88005b971bde8082b2eda26ee1812f8"></a><!-- doxytag: member="Sampler::GetNextSample" ref="ac88005b971bde8082b2eda26ee1812f8" args="(Sample *sample)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Sampler::GetNextSample </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSample.html">Sample</a> *&nbsp;</td>
          <td class="paramname"> <em>sample</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classBestCandidateSampler.html#aaa90de1908919b36de8f292742d74da4">BestCandidateSampler</a>, <a class="el" href="classLDSampler.html#a64dc8dbea88ef1594af042849315c79e">LDSampler</a>, <a class="el" href="classRandomSampler.html#a879215e980b5107c6384b40b4cf5cffd">RandomSampler</a>, and <a class="el" href="classStratifiedSampler.html#ac496cfbdecce54fbd3c5732352f5986b">StratifiedSampler</a>.</p>

<p>Referenced by <a class="el" href="scene_8cpp_source.html#l00032">Scene::Render()</a>.</p>

</div>
</div>
<a class="anchor" id="ad2ca20cd81ffb6fc242c3f0cf6c9812f"></a><!-- doxytag: member="Sampler::RoundSize" ref="ad2ca20cd81ffb6fc242c3f0cf6c9812f" args="(int size) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Sampler::RoundSize </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>size</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classBestCandidateSampler.html#aa7f8f993e90663e5e402a74470607965">BestCandidateSampler</a>, <a class="el" href="classLDSampler.html#aa395aef1067c6a10e2bdd4e89ffbe674">LDSampler</a>, <a class="el" href="classRandomSampler.html#ab900c6473c77beaa21cc5195005bac5d">RandomSampler</a>, and <a class="el" href="classStratifiedSampler.html#a65838638b577d61d4cde9cff6b72c692">StratifiedSampler</a>.</p>

<p>Referenced by <a class="el" href="photonmap_8cpp_source.html#l00125">PhotonIntegrator::RequestSamples()</a>, <a class="el" href="irradiancecache_8cpp_source.html#l00100">IrradianceCache::RequestSamples()</a>, <a class="el" href="igi_8cpp_source.html#l00075">IGIIntegrator::RequestSamples()</a>, <a class="el" href="exphotonmap_8cpp_source.html#l00271">ExPhotonIntegrator::RequestSamples()</a>, and <a class="el" href="directlighting_8cpp_source.html#l00039">DirectLighting::RequestSamples()</a>.</p>

</div>
</div>
<a class="anchor" id="a602a93ebc17bcbeeac87890dcbfe8d67"></a><!-- doxytag: member="Sampler::TotalSamples" ref="a602a93ebc17bcbeeac87890dcbfe8d67" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Sampler::TotalSamples </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00038">38</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>

<p>Referenced by <a class="el" href="scene_8cpp_source.html#l00032">Scene::Render()</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ac00cddc4c3f80939f4b2dd871b7ffdfa"></a><!-- doxytag: member="Sampler::samplesPerPixel" ref="ac00cddc4c3f80939f4b2dd871b7ffdfa" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classSampler.html#ac00cddc4c3f80939f4b2dd871b7ffdfa">Sampler::samplesPerPixel</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00046">46</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>

<p>Referenced by <a class="el" href="sampling_8cpp_source.html#l00032">Sampler()</a>.</p>

</div>
</div>
<a class="anchor" id="a4a849a8c413ca1560edcaa788a79bade"></a><!-- doxytag: member="Sampler::xPixelEnd" ref="a4a849a8c413ca1560edcaa788a79bade" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classSampler.html#a4a849a8c413ca1560edcaa788a79bade">Sampler::xPixelEnd</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00045">45</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>

<p>Referenced by <a class="el" href="stratified_8cpp_source.html#l00087">StratifiedSampler::GetNextSample()</a>, <a class="el" href="random_8cpp_source.html#l00076">RandomSampler::GetNextSample()</a>, <a class="el" href="lowdiscrepancy_8cpp_source.html#l00076">LDSampler::GetNextSample()</a>, <a class="el" href="bestcandidate_8cpp_source.html#l00075">BestCandidateSampler::GetNextSample()</a>, and <a class="el" href="sampling_8cpp_source.html#l00032">Sampler()</a>.</p>

</div>
</div>
<a class="anchor" id="a32b4ad77407cd6063590828e92d4fdb9"></a><!-- doxytag: member="Sampler::xPixelStart" ref="a32b4ad77407cd6063590828e92d4fdb9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classSampler.html#a32b4ad77407cd6063590828e92d4fdb9">Sampler::xPixelStart</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00045">45</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>

<p>Referenced by <a class="el" href="bestcandidate_8cpp_source.html#l00061">BestCandidateSampler::BestCandidateSampler()</a>, <a class="el" href="stratified_8cpp_source.html#l00087">StratifiedSampler::GetNextSample()</a>, <a class="el" href="random_8cpp_source.html#l00076">RandomSampler::GetNextSample()</a>, <a class="el" href="lowdiscrepancy_8cpp_source.html#l00076">LDSampler::GetNextSample()</a>, <a class="el" href="bestcandidate_8cpp_source.html#l00075">BestCandidateSampler::GetNextSample()</a>, <a class="el" href="lowdiscrepancy_8cpp_source.html#l00057">LDSampler::LDSampler()</a>, <a class="el" href="random_8cpp_source.html#l00045">RandomSampler::RandomSampler()</a>, <a class="el" href="sampling_8cpp_source.html#l00032">Sampler()</a>, and <a class="el" href="stratified_8cpp_source.html#l00051">StratifiedSampler::StratifiedSampler()</a>.</p>

</div>
</div>
<a class="anchor" id="ac8b3c8b228e9de66cc8441e619d25d4a"></a><!-- doxytag: member="Sampler::yPixelEnd" ref="ac8b3c8b228e9de66cc8441e619d25d4a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classSampler.html#ac8b3c8b228e9de66cc8441e619d25d4a">Sampler::yPixelEnd</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00045">45</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>

<p>Referenced by <a class="el" href="stratified_8cpp_source.html#l00087">StratifiedSampler::GetNextSample()</a>, <a class="el" href="random_8cpp_source.html#l00076">RandomSampler::GetNextSample()</a>, <a class="el" href="lowdiscrepancy_8cpp_source.html#l00076">LDSampler::GetNextSample()</a>, <a class="el" href="bestcandidate_8cpp_source.html#l00075">BestCandidateSampler::GetNextSample()</a>, and <a class="el" href="sampling_8cpp_source.html#l00032">Sampler()</a>.</p>

</div>
</div>
<a class="anchor" id="afc1a0ab7d6de5341150e87b02b9822fd"></a><!-- doxytag: member="Sampler::yPixelStart" ref="afc1a0ab7d6de5341150e87b02b9822fd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classSampler.html#afc1a0ab7d6de5341150e87b02b9822fd">Sampler::yPixelStart</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sampling_8h_source.html#l00045">45</a> of file <a class="el" href="sampling_8h_source.html">sampling.h</a>.</p>

<p>Referenced by <a class="el" href="bestcandidate_8cpp_source.html#l00061">BestCandidateSampler::BestCandidateSampler()</a>, <a class="el" href="bestcandidate_8cpp_source.html#l00075">BestCandidateSampler::GetNextSample()</a>, <a class="el" href="lowdiscrepancy_8cpp_source.html#l00057">LDSampler::LDSampler()</a>, <a class="el" href="random_8cpp_source.html#l00045">RandomSampler::RandomSampler()</a>, <a class="el" href="sampling_8cpp_source.html#l00032">Sampler()</a>, and <a class="el" href="stratified_8cpp_source.html#l00051">StratifiedSampler::StratifiedSampler()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="sampling_8h_source.html">sampling.h</a></li>
<li><a class="el" href="sampling_8cpp_source.html">sampling.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>