#include <MultiSenseTypes.hh>

Public Member Functions
	ExposureConfig ()

void	setExposure (uint32_t e)
	Set the exposure time used to capture images. More...

void	setAutoExposure (bool e)
	Set auto-exposure enable flag. More...

void	setAutoExposureMax (uint32_t m)
	Set the desired maximum auto-exposure value. More...

void	setAutoExposureDecay (uint32_t d)
	Set the desired auto-exposure decay rate. More...

void	setAutoExposureTargetIntensity (float d)
	Set the desired auto-exposure target Intensity . More...

void	setAutoExposureThresh (float t)
	Set the desired auto-exposure threshold. More...

void	setAutoExposureRoi (uint16_t start_x, uint16_t start_y, uint16_t width, uint16_t height)
	Set the desired ROI to use when computing the auto-exposure. More...

void	setExposureSource (const DataSource &s)
	Set the stream source which these exposure parameters should apply to. More...

void	setGain (const float &g)
	Set the gain applied to the camera. More...

uint32_t	exposure () const
	Query the current image configuration's exposure setting. More...

bool	autoExposure () const
	Query the current image configuration's auto-exposure enable setting. More...

uint32_t	autoExposureMax () const
	Query the current image configuration's maximum auto-exposure value. More...

uint32_t	autoExposureDecay () const
	Query the current image configuration's auto-exposure decay rate. More...

float	autoExposureTargetIntensity () const
	Query the current image configuration's auto-exposure target Intensity. More...

float	autoExposureThresh () const
	Query the current image configuration's auto-exposure threshold. More...

uint16_t	autoExposureRoiX () const
	Query the current image configuration's auto-exposure ROI X value. More...

uint16_t	autoExposureRoiY () const
	Query the current image configuration's auto-exposure ROI Y value. More...

uint16_t	autoExposureRoiWidth () const
	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. More...

uint16_t	autoExposureRoiHeight () const
	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. More...

DataSource	exposureSource () const
	Query the image source which the exposure parameters correspond with. More...

float	gain () const
	Query the gain applied to the camera. More...

Private Attributes
uint32_t	m_exposure

bool	m_aeEnabled

uint32_t	m_aeMax

uint32_t	m_aeDecay

float	m_aeThresh

uint16_t	m_autoExposureRoiX

uint16_t	m_autoExposureRoiY

uint16_t	m_autoExposureRoiWidth

uint16_t	m_autoExposureRoiHeight

DataSource	m_exposureSource

float	m_aeTargetIntensity

float	m_gain

Detailed Description

Definition at line 498 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ ExposureConfig()

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

inline

Definition at line 500 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 613 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 629 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 621 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 677 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 668 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 652 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 659 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 637 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 645 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 605 of file MultiSenseTypes.hh.

◆ exposureSource()

DataSource crl::multisense::image::ExposureConfig::exposureSource ( ) const

inline

Query the image source which the exposure parameters correspond with.

Returns: Return the image source associated with the exposure parameters

Definition at line 684 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 691 of file MultiSenseTypes.hh.

◆ setAutoExposure()

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

inline

Set auto-exposure enable flag.

Default value: true

Parameters

e	A boolean used to enable or disable auto-exposure

Definition at line 522 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

d	The auto-exposure decay rate [0, 20]

Definition at line 538 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

m	The maximum auto-exposure value in microseconds

Definition at line 530 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_x	The X coordinate where the ROI starts
start_y	The Y coordinate where the ROI starts
width	The width of the ROI
height	The height of the ROI

Definition at line 572 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

d	The auto-exposure target intensity [0.0, 1.0]

Definition at line 546 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

t	The desired auto-exposure threshold [0.0, 1.0]

Definition at line 555 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

e	The output exposure time in microseconds [10, 5000000]

Definition at line 514 of file MultiSenseTypes.hh.

◆ setExposureSource()

void crl::multisense::image::ExposureConfig::setExposureSource ( const DataSource & s )

inline

Set the stream source which these exposure parameters should apply to.

Parameters

s	The image stream to apply these exposure parameters to

Definition at line 586 of file MultiSenseTypes.hh.

◆ setGain()

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

inline

Set the gain applied to the camera.

Parameters

s	The gain to apply to this camera

Definition at line 594 of file MultiSenseTypes.hh.

Member Data Documentation

◆ m_aeDecay

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

private

Definition at line 697 of file MultiSenseTypes.hh.

◆ m_aeEnabled

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

private

Definition at line 695 of file MultiSenseTypes.hh.

◆ m_aeMax

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

private

Definition at line 696 of file MultiSenseTypes.hh.

◆ m_aeTargetIntensity

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

private

Definition at line 706 of file MultiSenseTypes.hh.

◆ m_aeThresh

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

private

Definition at line 698 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiHeight

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

private

Definition at line 703 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiWidth

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

private

Definition at line 702 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiX

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

private

Definition at line 700 of file MultiSenseTypes.hh.

◆ m_autoExposureRoiY

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

private

Definition at line 701 of file MultiSenseTypes.hh.

◆ m_exposure

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

private

Definition at line 691 of file MultiSenseTypes.hh.

◆ m_exposureSource

DataSource crl::multisense::image::ExposureConfig::m_exposureSource

private

Definition at line 704 of file MultiSenseTypes.hh.

◆ m_gain

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

private

Definition at line 707 of file MultiSenseTypes.hh.

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

/home/malvarado/crl/LibMultiSense/source/LibMultiSense/include/MultiSense/MultiSenseTypes.hh

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExposureConfig()

Member Function Documentation

◆ autoExposure()

◆ autoExposureDecay()

◆ autoExposureMax()

◆ autoExposureRoiHeight()

◆ autoExposureRoiWidth()

◆ autoExposureRoiX()

◆ autoExposureRoiY()

◆ autoExposureTargetIntensity()

◆ autoExposureThresh()

◆ exposure()

◆ exposureSource()

◆ gain()

◆ setAutoExposure()

◆ setAutoExposureDecay()

◆ setAutoExposureMax()

◆ setAutoExposureRoi()

◆ setAutoExposureTargetIntensity()

◆ setAutoExposureThresh()

◆ setExposure()

◆ setExposureSource()

◆ setGain()

Member Data Documentation

◆ m_aeDecay

◆ m_aeEnabled

◆ m_aeMax

◆ m_aeTargetIntensity

◆ m_aeThresh

◆ m_autoExposureRoiHeight

◆ m_autoExposureRoiWidth

◆ m_autoExposureRoiX

◆ m_autoExposureRoiY

◆ m_exposure

◆ m_exposureSource

◆ m_gain