SensorSampler.h

Go to the documentation of this file.

/**<!-------------------------------------------------------------------->
   @class  SensorSampler
   @author Travis Fischer (fisch0920@gmail.com)
   @author Matthew Jacobs (jacobs.mh@gmail.com)
   @date   Fall 2008
   
   @brief
      Sampler which selects a point on a sensor (camera) in the scene. 
   Successive invocations of SensorSampler 
   <!-------------------------------------------------------------------->**/

#ifndef SENSOR_SAMPLER_H_
#define SENSOR_SAMPLER_H_

#include <stats/Sampler.h>

class Camera;

class SensorSampler : public Sampler {
   
   public:
      ///@name Constructors
      //@{-----------------------------------------------------------------
      
      inline SensorSampler(Camera *camera)
         : Sampler(), m_camera(camera)
      { }
      
      virtual ~SensorSampler()
      { }
      
      
      //@}-----------------------------------------------------------------
      ///@name Initialization
      //@{-----------------------------------------------------------------
      
      /**
       * @brief
       *    Should perform any initialization of this random variable which 
       * may be necessary to speed or prepare sampling
       * 
       * @note should be called before calling sample or getPdf
       */
      virtual void init();
      
      
      //@}-----------------------------------------------------------------
      ///@name Main usage interface
      //@{-----------------------------------------------------------------
      
      /**
       * @returns a randomly chosen event x, sampled from this random 
       *    variable's sample space
       * @note consecutive calls to sample are expected to return 
       *    independent, identically distributed (IID) samples
       */
      virtual Event sample();
      
      /**
       * @returns the probability density with which the given event would be 
       *    sampled according to the underlying probability density function
       * @note the given event is assumed to lie within this random variable's
       *    sample space
       */
      virtual real_t getPdf(const Event &event) PURE_FUNCTION;
      
      
      //@}-----------------------------------------------------------------
      
   protected:
      Camera *m_camera;
};

#endif // SENSOR_SAMPLER_H_