seOptics Class Reference

Sensor Effects optics class. More...

Public Types
enum	shapeType { Circular = 0, Rectangular = 1 }
	shapeType More...

Public Member Functions
	seOptics ()
	constructor
	~seOptics ()
	destructor
void	loadDefaults ()
	sets all the member data to default values.
void	setApertureWidth (const double dim)
	sets the aperture's width or horizontal dimension (mm)
double	getApertureWidth ()
	gets the aperture's width or horizontal dimension (mm)
void	setApertureShape (shapeType shape)
	sets the aperture's shape
shapeType	getApertureShape ()
	gets the aperture's shape
void	setApertureAspectRatio (const double ratio)
	sets the aperture's horizontal to vertical aspect ratio
double	getApertureAspectRatio ()
	gets the aperture's horizontal to vertical aspect ratio
void	setBlurSpotDiameter (const double size)
	sets the blur spot's diameter (mrad)
double	getBlurSpotDiameter ()
	gets the blur spot's diameter (mrad)
void	setFOVdegs (const double horzFov, const double vertFov)
	sets the fov of the sensor (deg)
void	getFOVdegs (double &horzFov, double &vertFov)
	gets the fov of the sensor (degs)
void	setMtfMotionBlurSize (const double size)
	sets the motion blur spot size (milliRad) currently this is not implemented as a motion blur but is added to the other MTFs
double	getMtfMotionBlurSize ()
	gets the motion blur spot size (milliRad) currently this is not implemented as a motion blur but is added to the other MTFs
void	setLensTransmittance (const double transmittance)
	sets the len's transmittance - is applied as an additional gain factor
double	getLensTransmittance ()
	gets the len's transmittance - is applied as an additional gain factor
void	setFilterEnable (const bool flag)
	sets the filter enable flag
bool	isFilterEnable ()
	gets the filter enable flag.
void	setOptimizedFilterEnable (const bool flag)
	sets the flag to select a performance optimized filtering technique
bool	isOptimizedFilterEnable ()
	gets the optimized filter enable flag.
void	setFilterAdjustment (double adjustment)
	sets the adjustment that is multiplied by the calculated filter size.
double	getFilterAdjustment ()
	gets the adjustment that is multiplied by the calculated filter size.
void	setHaloEnable (const bool flag)
bool	isHaloEnable ()
	gets the halo enable flag.
void	setHaloThreshold (const double value)
	sets the halo threshold value
double	getHaloThreshold ()
	gets the halo threshold value
void	setHaloRadius (const double value)
	sets the halo Radius in pixels
double	getHaloRadius ()
	gets the halo Radius in pixels
void	setHaloIntensity (const double intensity)
	sets the halo intensity
double	getHaloIntensity ()
	gets the halo intensity
void	setHaloThresholdAdjustment (double threshold)
	sets the adjustment that is multiplied by the given halo threshold.
double	getHaloThresholdAdjustment ()
	gets the adjustment that is multiplied by the given halo threshold.
void	setUserDefinedMTFenable (bool enable)
	Set the user defined MTF enable If set then the file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.
bool	getUserDefinedMTFenable ()
	Get the user defined MTF enable.
void	setUserDefinedMTFfilename (char *filename)
	Set the user defined MTF filename this file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.
char *	getUserDefinedMTFfilename ()
	get the user defined MTF filename
bool	isDirty ()
	Specifies whether the seOptics has been changed.
void	setDirty ()
	Specify whether the seOptics has been changed.
void	clrDirty ()
	Clear the flag that specifies whether the seOptics has been changed.

Private Attributes
double	m_apertureWidth
	Aperture width.
shapeType	m_apertureShape
	Aperture shape - circular or rectangular.
double	m_apertureAspectRatio
	Aperture's aspect ratio - horizontal to vertical.
double	m_blurSpotDiameter
	blur spot diameter
double	m_horizontalFov
	horizontal fov (deg)
double	m_verticalFov
	vertical fov (deg)
double	m_mtfMotionBlurSize
	motion blur mtf size
double	m_lensTransmittance
	Lens Transmittance.
bool	m_filterEnable
	enable flag for filtering
bool	m_optimizedFilterEnable
	enable flag for peforming optimized filtering
double	m_filterAdjustment
	percent of the calculated filter that is applied
bool	m_haloEnable
	enable flag to process halos
double	m_haloThreshold
	Threshold to trigger a halo.
double	m_haloRadius
	radius of the halos
double	m_haloIntensity
	intensity scale factor for halos
double	m_haloThresholdAdjustment
	adjustment multiplied by the halo threshold
bool	m_userDefinedMTFenable
	flag indicating the use of user defined MTF data
char	m_userDefinedMTFfilename [512]
	file name for user defined MTF data
bool	m_dirty
	dirty flag for optics object

Detailed Description

Sensor Effects optics class.

Holds the data related to the optics portion of a device.

Member Enumeration Documentation

enum seOptics::shapeType

shapeType

Specifies the shape of the aperture

Enumerator:

Circular
Rectangular

Constructor & Destructor Documentation

seOptics::seOptics

(

)

constructor

seOptics::~seOptics

(

)

destructor

Member Function Documentation

void seOptics::loadDefaults

(

)

sets all the member data to default values.

void seOptics::setApertureWidth ( const double  dim )

inline

sets the aperture's width or horizontal dimension (mm)

Parameters

dim

double seOptics::getApertureWidth ( )

inline

gets the aperture's width or horizontal dimension (mm)

Returns

double

void seOptics::setApertureShape ( shapeType  shape )

inline

sets the aperture's shape

Parameters

shape

- circular or rectangular

shapeType seOptics::getApertureShape ( )

inline

gets the aperture's shape

Returns

shapeType - circular or rectangular

void seOptics::setApertureAspectRatio ( const double  ratio )

inline

sets the aperture's horizontal to vertical aspect ratio

Parameters

ratio

double seOptics::getApertureAspectRatio ( )

inline

gets the aperture's horizontal to vertical aspect ratio

Returns

double

void seOptics::setBlurSpotDiameter ( const double  size )

inline

sets the blur spot's diameter (mrad)

Parameters

size

double seOptics::getBlurSpotDiameter ( )

inline

gets the blur spot's diameter (mrad)

Returns

double

void seOptics::setFOVdegs ( const double  horzFov, const double  vertFov  )

inline

sets the fov of the sensor (deg)

Parameters

horzFov
vertFov

void seOptics::getFOVdegs ( double &  horzFov, double &  vertFov  )

inline

gets the fov of the sensor (degs)

Parameters

horzFov
vertFov

void seOptics::setMtfMotionBlurSize ( const double  size )

inline

sets the motion blur spot size (milliRad) currently this is not implemented as a motion blur but is added to the other MTFs

Parameters

size

double seOptics::getMtfMotionBlurSize ( )

inline

gets the motion blur spot size (milliRad) currently this is not implemented as a motion blur but is added to the other MTFs

Returns

double

void seOptics::setLensTransmittance ( const double  transmittance )

inline

sets the len's transmittance - is applied as an additional gain factor

Parameters

transmittance

double seOptics::getLensTransmittance ( )

inline

gets the len's transmittance - is applied as an additional gain factor

Returns

double

void seOptics::setFilterEnable ( const bool  flag )

inline

sets the filter enable flag

Parameters

flag

bool seOptics::isFilterEnable ( )

inline

gets the filter enable flag.

Returns

bool

void seOptics::setOptimizedFilterEnable ( const bool  flag )

inline

sets the flag to select a performance optimized filtering technique

Parameters

flag

bool seOptics::isOptimizedFilterEnable ( )

inline

gets the optimized filter enable flag.

Returns

bool

void seOptics::setFilterAdjustment ( double  adjustment )

inline

sets the adjustment that is multiplied by the calculated filter size.

This can be used as an adjustment knob/slider.

Parameters

adjustment

double seOptics::getFilterAdjustment ( )

inline

gets the adjustment that is multiplied by the calculated filter size.

This can be used as an adjustment knob/slider.

Returns

double

void seOptics::setHaloEnable ( const bool  flag )

inline

Parameters

flag

bool seOptics::isHaloEnable ( )

inline

gets the halo enable flag.

Returns

bool

void seOptics::setHaloThreshold ( const double  value )

inline

sets the halo threshold value

Parameters

value

double seOptics::getHaloThreshold ( )

inline

gets the halo threshold value

Returns

threshold

void seOptics::setHaloRadius ( const double  value )

inline

sets the halo Radius in pixels

Parameters

value

double seOptics::getHaloRadius ( )

inline

gets the halo Radius in pixels

Returns

radius

void seOptics::setHaloIntensity ( const double  intensity )

inline

sets the halo intensity

Parameters

intensity

double seOptics::getHaloIntensity ( )

inline

gets the halo intensity

Returns

intensity

void seOptics::setHaloThresholdAdjustment ( double  threshold )

inline

sets the adjustment that is multiplied by the given halo threshold.

This can be used as an adjustment knob/slider.

Parameters

threshold

- 0.0 to 1.0

double seOptics::getHaloThresholdAdjustment ( )

inline

gets the adjustment that is multiplied by the given halo threshold.

This can be used as an adjustment knob/slider.

Returns

double - 0.0 to 1.0

void seOptics::setUserDefinedMTFenable ( bool  enable )

inline

Set the user defined MTF enable If set then the file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.

bool seOptics::getUserDefinedMTFenable ( )

inline

Get the user defined MTF enable.

void seOptics::setUserDefinedMTFfilename

(

char *

filename

)

Set the user defined MTF filename this file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.

The file format is: number of samples (integer) maximum horizontal frequency maximum vertical frequency (cycles/mrad) MTF x value and MTF y value for each frequency step from 0.0 to the maximum frequecy. (unitless)

Parameters

filename

char* seOptics::getUserDefinedMTFfilename ( )

inline

get the user defined MTF filename

Returns

char *

bool seOptics::isDirty ( )

inline

Specifies whether the seOptics has been changed.

Returns

bool

void seOptics::setDirty ( )

inline

Specify whether the seOptics has been changed.

void seOptics::clrDirty ( )

inline

Clear the flag that specifies whether the seOptics has been changed.

Member Data Documentation

double seOptics::m_apertureWidth

private

Aperture width.

shapeType seOptics::m_apertureShape

private

Aperture shape - circular or rectangular.

double seOptics::m_apertureAspectRatio

private

Aperture's aspect ratio - horizontal to vertical.

double seOptics::m_blurSpotDiameter

private

blur spot diameter

double seOptics::m_horizontalFov

private

horizontal fov (deg)

double seOptics::m_verticalFov

private

vertical fov (deg)

double seOptics::m_mtfMotionBlurSize

private

motion blur mtf size

double seOptics::m_lensTransmittance

private

Lens Transmittance.

bool seOptics::m_filterEnable

private

enable flag for filtering

bool seOptics::m_optimizedFilterEnable

private

enable flag for peforming optimized filtering

double seOptics::m_filterAdjustment

private

percent of the calculated filter that is applied

bool seOptics::m_haloEnable

private

enable flag to process halos

double seOptics::m_haloThreshold

private

Threshold to trigger a halo.

double seOptics::m_haloRadius

private

radius of the halos

double seOptics::m_haloIntensity

private

intensity scale factor for halos

double seOptics::m_haloThresholdAdjustment

private

adjustment multiplied by the halo threshold

bool seOptics::m_userDefinedMTFenable

private

flag indicating the use of user defined MTF data

char seOptics::m_userDefinedMTFfilename[512]

private

file name for user defined MTF data

bool seOptics::m_dirty

private

dirty flag for optics object

---

The documentation for this class was generated from the following file:

• seOptics.h