Critical Link MityCam SoC Firmware  1.0
Critical Link MityCam SoC Firmware
SocCamera::tcBlackLevelEstimator Class Referenceabstract

#include <BlackLevelEstimator.h>

Collaboration diagram for SocCamera::tcBlackLevelEstimator:

Public Member Functions

 tcBlackLevelEstimator ()
 
virtual ~tcBlackLevelEstimator ()
 
virtual teNackCode setBlackLevel (int selector, float &value)=0
 
virtual teNackCode getBlackLevel (int selector, float &value)=0
 
virtual teNackCode setBlackLevelAuto (int selector, int mode)=0
 

Static Public Attributes

static const int gnBlackLevelAuto_Off = 0
 
static const int gnBlackLevelAuto_Once = 1
 
static const int gnBlackLevelAuto_Continuous = 2
 

Detailed Description

This interface allows a sensor board to implement the SFNC Analog Black level GenICam control interface in a consistent manner.

Constructor & Destructor Documentation

◆ tcBlackLevelEstimator()

SocCamera::tcBlackLevelEstimator::tcBlackLevelEstimator ( )
inline

◆ ~tcBlackLevelEstimator()

virtual SocCamera::tcBlackLevelEstimator::~tcBlackLevelEstimator ( )
inlinevirtual

Member Function Documentation

◆ getBlackLevel()

virtual teNackCode SocCamera::tcBlackLevelEstimator::getBlackLevel ( int  selector,
float &  value 
)
pure virtual

Gets the selected black level value.

Parameters
selectorsee AnalogControl::eeAnalogSelected
value[out]the computed black level for the given selector.
Returns
non-zero on error

◆ setBlackLevel()

virtual teNackCode SocCamera::tcBlackLevelEstimator::setBlackLevel ( int  selector,
float &  value 
)
pure virtual

Sets a static black level value to use when BlackLevelAuto is OFF. (SFNC 6.7)

Note
the value may be updated at the call site if quantization is required.
Parameters
selectorsee AnalogControl::eeAnalogSelected
value[in,out]the static black level to save for the given selector.
Returns
non-zero on error

◆ setBlackLevelAuto()

virtual teNackCode SocCamera::tcBlackLevelEstimator::setBlackLevelAuto ( int  selector,
int  mode 
)
pure virtual

Sets the black level automatic operating mode. (SFNC 6.8)

Parameters
selectorsee AnalogControl::eeAnalogSelected
modesee AnalogControl::eeAnalogAuto
Returns
non-zero on error

Member Data Documentation

◆ gnBlackLevelAuto_Continuous

const int SocCamera::tcBlackLevelEstimator::gnBlackLevelAuto_Continuous = 2
static

◆ gnBlackLevelAuto_Off

const int SocCamera::tcBlackLevelEstimator::gnBlackLevelAuto_Off = 0
static

From SFNC 6.8

◆ gnBlackLevelAuto_Once

const int SocCamera::tcBlackLevelEstimator::gnBlackLevelAuto_Once = 1
static

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