class: seSenSim More...

Public Member Functions
	seSenSim ()
	constructor
	~seSenSim ()
	destructor
bool	initialize ()
	initialize sensor effects
void	outputImage (char filename, float inputImage, long numCols, long numRows)
	output an floating point image to a file.
void	applyCpuSensorEffects (float *inputImage, long numCols, long numRows)
	apply slow-time cpu based sensor effects
double	getFocalLength () const
	gets the aperture's focal length (cm)
double	getFNumber () const
	gets the aperture's f number (unitless)
seDetector *	getDetector () const
	gets Detector object pointer
seOptics *	getOptics () const
	gets Optics object pointer
seFilter *	getFilter ()
	gets Filter object pointer
seElectronics *	getElectronics () const
	gets Noise object pointer
seGainLevel *	getGainLevel () const
	gets gain/level object pointer
void	setSensorEffectsFlags (bool enable, bool gpuEnable, bool filterEnable, bool noiseEnable, bool gainEnable, bool haloEnable, bool motionBlurEnable=false)
	Sets the sensor effects enable flags in the interface.
bool	isSensorEffectsOn () const
	Gets the sensor effects enable flags in the interface.
void	setInputSize (int w, int h, bool use888Encoding=false)
	set input size in width and height When the input size changes everything is initialized to work with the new resolution.
void	setInputOffset (int x, int y)
	set input offset
void	setDisplaySize (int w, int h)
	set display size in width and height
void	setDisplayOffset (int x, int y, bool clearBuffer=true)
	set display offset
void	applyGpuSensorEffects (int inputTextureId, float *inputImage=NULL, bool swapBuffer=false, bool useTextureRect=false, int outputTextureId=0)
	description: applies all of the enabled sensor effects using the Gpu.
void	getMTFSamples (int numSamples, double &xCutoffFreq, double &yCutoffFreq, double xMTF, double yMTF) const
	Get both the horizontal and vertical mtf for a given number of samples, compute the cutoff frequencies and return the data in the provided arrays.
bool	isFilterOn () const
	indicates that filtering is on.
bool	isNoiseOn () const
	indicates that noise processing is on.
bool	isHaloOn () const
bool	isMotionBlurOn () const
bool	isGainOn () const
	indicates that gain and level processing is on.
bool	isGpuSensorEffectsOn () const
	indicates that GPU real-time sensor effects processing is on.
void	setFilterAdjustment (double adjustment)
	Adjust the filter.
void	setNoiseAdjustment (double adjustment)
	Adjust the noise.
void	setGainAdjustment (double adjustment)
	Adjust the gain.
void	setLevelAdjustment (double adjustment)
	Adjust the level.
double	getFilterAdjustment () const
	Get the filter adjustment.
double	getNoiseAdjustment () const
	Get the noise adjustment.
double	getGainAdjustment () const
	Get the gain adjustment.
double	getLevelAdjustment () const
	Get the level adjustment.
bool	isBlackHotEnable () const
	Return true if blackhot is enabled.
void	setBlackHotEnable (bool flag)
	Set the blackhot enable on or off.
void	setBandpass (const double ax, const double bx)
	set the bandpass.
bool	isFullColorEnable () const
	Return true if full color is enabled. Higher level function for non license version.
void	setFullColorEnable (bool flag)
	Set the full color enable on or off. Higher level function for non license version.
void	setSaveImage (char *saveFileName, bool preAperture=false, bool continuous=false, bool flip=true)
	setup saving the radiance image output of sensim into a raw floating point format.
void	setStopContinuous ()
	Tell seGpuProcessor to stop recording radiance images continuously.
void	setSaveImageFileName (char *saveFileName)
	setup file name for saving the radiance image output of sensim into a raw floating point format.
void	setSavePreApertureImage (bool preAperture)
	setup saving the radiance image output of sensim before the sensor effects are added (pre-aperture).
void	setSaveContinuousImages (bool continuous)
	setup saving the radiance image output into a continuous image stream.
void	setFlipSaveImages (bool flip)
	setup to flip the image that is saved to match ImageJ.
void	setSaveRadianceImageEnable ()
	Cause the saving the radiance image(s) output of sensim to begin.
void	setSaveRadianceImageArrayEnable (bool enable)
	Cause the saving the radiance image(s) output of sensim to begin without saving files to disk.
float *	getRadianceImageArray () const
	get image array containing radiance image.
float *	getObjectIDImageArray () const
	get image array containing object ID image.
float *	getDownSampledRadianceImageArray () const
	get the down sampled image array containing radiance image.
float *	getDownSampledObjectIDImageArray () const
	get the down sampled image array containing object ID image.
void	getDownSampledImageSize (int &width, int &height) const
	get the size of the down sampled image
void	setDownSampledImagesEnable (bool bEnable)
	get the flag for enabling down sampled image captures
bool	getDownSampledImagesEnable () const
	get the flag determining the state of down sampled image captures
void	setObjectIDRenderingEnable (bool bEnable)
	set the state for object ID rendering for object ID buffer captures
bool	getObjectIDRenderingEnable () const
	set the state for object ID rendering and buffer captures
bool	initializeLicense ()
	check the license and display the SenSimRT version This should be called before any other methods to verify that a SenSim license is available.
bool	licenseCheck () const
	Checks for SenSimRT license registration - the initializeLicense method must first be called.
bool	openGLCheck () const
	Check if there is a rendering context.
const char *	getVersion () const
	gets the version of SenSimRT
void	setDisplayTextureID (GLuint textureID, bool enable=true)
	sets the texture ID for the display texture feature and also the enable flag.

Private Attributes
bool	m_enableSensorEffects
	Overall enable flag for sensor effects.
bool	m_enableGPUSensorEffects
	Flag that enables the GPU-based sensor effects rather than the CPU-based.
bool	m_enableFilterEffects
	Flag that enables the Filtering effect.
bool	m_enableGainEffects
	Flag that enables the Gain/Level effect.
bool	m_enableNoiseEffects
	Flag that enables the noise effect.
bool	m_enableMotionBlurEffects
	Flag that enables the motion blur effect.
bool	m_enableHaloEffects
	Flag that enables the halo effect.
bool	m_license
	Flag indicating that the license is valid.
seDetector *	m_detector
	Detector object pointer.
seOptics *	m_optics
	Optics object pointer.
seElectronics *	m_electronics
	Electronics object pointer.
seGainLevel *	m_gainLevel
	Gain and level object pointer.
seFilter *	m_filter
	Filter object pointer.
seNoise *	m_noise
	Noise object pointer.
seGpuProcessor *	m_gpuProcessor
	Gpu processor object pointer.
Implementation *	m_impl

Detailed Description

class: seSenSim

Top level class for sensor effects processing using SenSimRT techniques

Constructor & Destructor Documentation

seSenSim::seSenSim ( )

constructor

seSenSim::~seSenSim ( )

destructor

Member Function Documentation

bool seSenSim::initialize ( )

initialize sensor effects

void seSenSim::outputImage	(	char *	filename,
		float *	inputImage,
		long	numCols,
		long	numRows
	)

output an floating point image to a file.

Parameters

filename
inputImage
numCols
numRows

void seSenSim::applyCpuSensorEffects	(	float *	inputImage,
		long	numCols,
		long	numRows
	)

apply slow-time cpu based sensor effects

Parameters

*inputImage
numCols
numRows

double seSenSim::getFocalLength ( ) const

gets the aperture's focal length (cm)

Returns: double

double seSenSim::getFNumber ( ) const

gets the aperture's f number (unitless)

Returns: double

seDetector* seSenSim::getDetector ( ) const

gets Detector object pointer

Returns: seDetector

seOptics* seSenSim::getOptics ( ) const

gets Optics object pointer

Returns: seOptics

seFilter* seSenSim::getFilter ( )

inline

gets Filter object pointer

Returns: seFilter

seElectronics* seSenSim::getElectronics ( ) const

gets Noise object pointer

Returns: seNoise gets Electronics object pointer; seElectronics

seGainLevel* seSenSim::getGainLevel ( ) const

gets gain/level object pointer

Returns: seGainLevel

void seSenSim::setSensorEffectsFlags	(	bool	enable,
		bool	gpuEnable,
		bool	filterEnable,
		bool	noiseEnable,
		bool	gainEnable,
		bool	haloEnable,
		bool	motionBlurEnable = `false`
	)

inline

Sets the sensor effects enable flags in the interface.

Parameters

enable
gpuEnable
filterEnable
noiseEnable
gainEnable
haloEnable
motionBlurEnable

bool seSenSim::isSensorEffectsOn ( ) const

inline

Gets the sensor effects enable flags in the interface.

Returns: bool - sensor effects enable flag

void seSenSim::setInputSize	(	int	w,
		int	h,
		bool	use888Encoding = `false`
	)

set input size in width and height When the input size changes everything is initialized to work with the new resolution.

Parameters

w	- width of input texture
h	- height of input texture
use888Encoding	- use if 888 encoding is changing in real-time

void seSenSim::setInputOffset	(	int	x,
		int	y
	)

set input offset

Parameters

x	- x offset of the input
y	- y offset of the input

void seSenSim::setDisplaySize	(	int	w,
		int	h
	)

set display size in width and height

Parameters

w	- width of display output
h	- height of display outpu

void seSenSim::setDisplayOffset	(	int	x,
		int	y,
		bool	clearBuffer = `true`
	)

set display offset

Parameters

x	- x offset of the display
y	- y offset of the display
clearBuffer	- when offsets are not -1,-1 this flag determines whether the back buffer should be cleared.

void seSenSim::applyGpuSensorEffects	(	int	inputTextureId,
		float *	inputImage = `NULL`,
		bool	swapBuffer = `false`,
		bool	useTextureRect = `false`,
		int	outputTextureId = `0`
	)

description: applies all of the enabled sensor effects using the Gpu.

Parameters

inputTextureId	- optional texture to read the input from instead of the framebuffer
inputImage	- no longer used - now saveImage API is used
swapBuffer
useTextureRect
outputTextureId	- optional texture to save the SensorFX output to instead of the framebuffer

void seSenSim::getMTFSamples	(	int	numSamples,
		double &	xCutoffFreq,
		double &	yCutoffFreq,
		double *	xMTF,
		double *	yMTF
	)		const

Get both the horizontal and vertical mtf for a given number of samples, compute the cutoff frequencies and return the data in the provided arrays.

Parameters

numSamples
&xCutoffFreq
&yCutoffFreq
*xMTF
*yMTF

bool seSenSim::isFilterOn ( ) const

inline

indicates that filtering is on.

Returns: bool - flag indicating whether filtering is on.

bool seSenSim::isNoiseOn ( ) const

inline

indicates that noise processing is on.

Returns: bool - flag indicating whether noise processing is on.

bool seSenSim::isHaloOn ( ) const

inline

Returns: bool

bool seSenSim::isMotionBlurOn ( ) const

inline

Returns: bool

bool seSenSim::isGainOn ( ) const

inline

indicates that gain and level processing is on.

Returns: bool - flag indicating whether gain and level processing is on.

bool seSenSim::isGpuSensorEffectsOn ( ) const

inline

indicates that GPU real-time sensor effects processing is on.

Returns: bool - flag indicating whether GPU real-time sensor effects processing is on.

void seSenSim::setFilterAdjustment ( double adjustment )

Adjust the filter.