Public Member Functions | Private Attributes | List of all members
crl::multisense::image::ExposureConfig Class Reference

#include <MultiSenseTypes.hh>

Public Member Functions

bool autoExposure () const
 
uint32_t autoExposureDecay () const
 
uint32_t autoExposureMax () const
 
uint16_t autoExposureRoiHeight () const
 
uint16_t autoExposureRoiWidth () const
 
uint16_t autoExposureRoiX () const
 
uint16_t autoExposureRoiY () const
 
float autoExposureTargetIntensity () const
 
float autoExposureThresh () const
 
uint32_t exposure () const
 
 ExposureConfig ()
 
float gain () const
 
void setAutoExposure (bool e)
 
void setAutoExposureDecay (uint32_t d)
 
void setAutoExposureMax (uint32_t m)
 
void setAutoExposureRoi (uint16_t start_x, uint16_t start_y, uint16_t width, uint16_t height)
 
void setAutoExposureTargetIntensity (float d)
 
void setAutoExposureThresh (float t)
 
void setExposure (uint32_t e)
 
void setGain (const float &g)
 

Private Attributes

uint32_t m_aeDecay
 
bool m_aeEnabled
 
uint32_t m_aeMax
 
float m_aeTargetIntensity
 
float m_aeThresh
 
uint16_t m_autoExposureRoiHeight
 
uint16_t m_autoExposureRoiWidth
 
uint16_t m_autoExposureRoiX
 
uint16_t m_autoExposureRoiY
 
uint32_t m_exposure
 
float m_gain
 

Detailed Description

Definition at line 509 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ ExposureConfig()

crl::multisense::image::ExposureConfig::ExposureConfig ( )
inline

Definition at line 511 of file MultiSenseTypes.hh.

Member Function Documentation

◆ autoExposure()

bool crl::multisense::image::ExposureConfig::autoExposure ( ) const
inline

Query the current image configuration's auto-exposure enable setting

Returns
The current image configuration's auto-exposure enable flag

Definition at line 616 of file MultiSenseTypes.hh.

◆ autoExposureDecay()

uint32_t crl::multisense::image::ExposureConfig::autoExposureDecay ( ) const
inline

Query the current image configuration's auto-exposure decay rate

Returns
The current configuration's auto-exposure decay rate

Definition at line 632 of file MultiSenseTypes.hh.

◆ autoExposureMax()

uint32_t crl::multisense::image::ExposureConfig::autoExposureMax ( ) const
inline

Query the current image configuration's maximum auto-exposure value

Returns
The current image configuration's maximum auto-exposure value

Definition at line 624 of file MultiSenseTypes.hh.

◆ autoExposureRoiHeight()

uint16_t crl::multisense::image::ExposureConfig::autoExposureRoiHeight ( ) const
inline

Query the current image configuration's auto-exposure ROI height value Will return crl::multisense::Roi_Full_Image for the default setting, when the ROI covers the entire image regardless of current resolution

Returns
The current image configuration's auto-exposure ROI height value

Definition at line 680 of file MultiSenseTypes.hh.

◆ autoExposureRoiWidth()

uint16_t crl::multisense::image::ExposureConfig::autoExposureRoiWidth ( ) const
inline

Query the current image configuration's auto-exposure ROI width value Will return crl::multisense::Roi_Full_Image for the default setting, when the ROI covers the entire image regardless of current resolution

Returns
The current image configuration's auto-exposure ROI width value

Definition at line 671 of file MultiSenseTypes.hh.

◆ autoExposureRoiX()

uint16_t crl::multisense::image::ExposureConfig::autoExposureRoiX ( ) const
inline

Query the current image configuration's auto-exposure ROI X value

Returns
The current image configuration's auto-exposure ROI X value

Definition at line 655 of file MultiSenseTypes.hh.

◆ autoExposureRoiY()

uint16_t crl::multisense::image::ExposureConfig::autoExposureRoiY ( ) const
inline

Query the current image configuration's auto-exposure ROI Y value

Returns
The current image configuration's auto-exposure ROI Y value

Definition at line 662 of file MultiSenseTypes.hh.

◆ autoExposureTargetIntensity()

float crl::multisense::image::ExposureConfig::autoExposureTargetIntensity ( ) const
inline

Query the current image configuration's auto-exposure target Intensity

Returns
The current configuration's auto-exposure decay rate

Definition at line 640 of file MultiSenseTypes.hh.

◆ autoExposureThresh()

float crl::multisense::image::ExposureConfig::autoExposureThresh ( ) const
inline

Query the current image configuration's auto-exposure threshold

Returns
The current image configuration's auto-exposure threshold

Definition at line 648 of file MultiSenseTypes.hh.

◆ exposure()

uint32_t crl::multisense::image::ExposureConfig::exposure ( ) const
inline

Query the current image configuration's exposure setting

Returns
the current image exposure setting in microseconds

Definition at line 608 of file MultiSenseTypes.hh.

◆ gain()

float crl::multisense::image::ExposureConfig::gain ( ) const
inline

Query the gain applied to the camera

Returns
Return the current image configurations gain

Definition at line 687 of file MultiSenseTypes.hh.

◆ setAutoExposure()

void crl::multisense::image::ExposureConfig::setAutoExposure ( bool  e)
inline

Set auto-exposure enable flag. Default value: true

Parameters
eA boolean used to enable or disable auto-exposure

Definition at line 533 of file MultiSenseTypes.hh.

◆ setAutoExposureDecay()

void crl::multisense::image::ExposureConfig::setAutoExposureDecay ( uint32_t  d)
inline

Set the desired auto-exposure decay rate. Default value: 7

Parameters
dThe auto-exposure decay rate [0, 20]

Definition at line 549 of file MultiSenseTypes.hh.

◆ setAutoExposureMax()

void crl::multisense::image::ExposureConfig::setAutoExposureMax ( uint32_t  m)
inline

Set the desired maximum auto-exposure value. Default value: 5000000

Parameters
mThe maximum auto-exposure value in microseconds

Definition at line 541 of file MultiSenseTypes.hh.

◆ setAutoExposureRoi()

void crl::multisense::image::ExposureConfig::setAutoExposureRoi ( uint16_t  start_x,
uint16_t  start_y,
uint16_t  width,
uint16_t  height 
)
inline

Set the desired ROI to use when computing the auto-exposure. x axis is horizontal and y axis is vertical. (0,0) coordinate starts in the upper left corner of the image. If (x + w > image width) or (y + h > image height) the sensor will return an error. Setting to default:(0,0,crl::multisense::Roi_Full_Image,crl::multisense::Roi_Full_Image) will use the entire image for the ROI regardless of the current resolution This feature is only available in sensor firmware version 4.3 and greater

Parameters
start_xThe X coordinate where the ROI starts
start_yThe Y coordinate where the ROI starts
widthThe width of the ROI
heightThe height of the ROI

Definition at line 583 of file MultiSenseTypes.hh.

◆ setAutoExposureTargetIntensity()

void crl::multisense::image::ExposureConfig::setAutoExposureTargetIntensity ( float  d)
inline

Set the desired auto-exposure target Intensity . Default value: 0.95

Parameters
dThe auto-exposure target intensity [0.0, 1.0]

Definition at line 557 of file MultiSenseTypes.hh.

◆ setAutoExposureThresh()

void crl::multisense::image::ExposureConfig::setAutoExposureThresh ( float  t)
inline

Set the desired auto-exposure threshold. This is the percentage of the image that should be white. Default value: 0.75

Parameters
tThe desired auto-exposure threshold [0.0, 1.0]

Definition at line 566 of file MultiSenseTypes.hh.

◆ setExposure()

void crl::multisense::image::ExposureConfig::setExposure ( uint32_t  e)
inline

Set the exposure time used to capture images. Note auto exposure must be disabled for this to take effect. Default value: 10000

Parameters
eThe output exposure time in microseconds [10, 5000000]

Definition at line 525 of file MultiSenseTypes.hh.

◆ setGain()

void crl::multisense::image::ExposureConfig::setGain ( const float &  g)
inline

Set the gain applied to the camera

Parameters
sThe gain to apply to this camera

Definition at line 597 of file MultiSenseTypes.hh.

Member Data Documentation

◆ m_aeDecay

uint32_t crl::multisense::image::ExposureConfig::m_aeDecay
private

Definition at line 693 of file MultiSenseTypes.hh.

◆ m_aeEnabled

bool crl::multisense::image::ExposureConfig::m_aeEnabled
private

Definition at line 691 of file MultiSenseTypes.hh.

◆ m_aeMax

uint32_t crl::multisense::image::ExposureConfig::m_aeMax
private

Definition at line 692 of file MultiSenseTypes.hh.

◆ m_aeTargetIntensity

float crl::multisense::image::ExposureConfig::m_aeTargetIntensity
private

Definition at line 701 of file MultiSenseTypes.hh.

◆ m_aeThresh

float crl::multisense::image::ExposureConfig::m_aeThresh
private

Definition at line 694 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiHeight

uint16_t crl::multisense::image::ExposureConfig::m_autoExposureRoiHeight
private

Definition at line 699 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiWidth

uint16_t crl::multisense::image::ExposureConfig::m_autoExposureRoiWidth
private

Definition at line 698 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiX

uint16_t crl::multisense::image::ExposureConfig::m_autoExposureRoiX
private

Definition at line 696 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiY

uint16_t crl::multisense::image::ExposureConfig::m_autoExposureRoiY
private

Definition at line 697 of file MultiSenseTypes.hh.

◆ m_exposure

uint32_t crl::multisense::image::ExposureConfig::m_exposure
private

Definition at line 687 of file MultiSenseTypes.hh.

◆ m_gain

float crl::multisense::image::ExposureConfig::m_gain
private

Definition at line 702 of file MultiSenseTypes.hh.

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

multisense_lib
Author(s):
autogenerated on Sat Jun 24 2023 03:01:21