LibMultiSense
LibMultiSense Documentation
multisense::MultiSenseConfig::AutoExposureConfig Struct Reference

Auto-exposure specific configuration. More...

#include <MultiSenseTypes.hh>

Collaboration diagram for multisense::MultiSenseConfig::AutoExposureConfig:

Public Member Functions

bool operator== (const AutoExposureConfig &rhs) const
 Equality operator. More...
 

Public Attributes

std::chrono::microseconds max_exposure_time {10000}
 The max exposure time auto exposure algorithm can set in microseconds Valid range is [0, 33000]. More...
 
uint32_t decay = 3
 The desired auto-exposure decay rate. More...
 
float target_intensity = 0.5f
 The auto-exposure algorithm in digital imaging endeavors to achieve a specified target intensity, which is represented as a ratio. More...
 
float target_threshold = 0.85f
 The fraction of pixels which must be equal or below the pixel value set by the target intensity pixel value. More...
 
float max_gain = 2.0f
 The auto exposure algorithm adjusts both exposure and gain. More...
 
AutoExposureRoiConfig roi {}
 The auto exposure region-of-interest used to restrict the portion of the image which the auto exposure algorithm is run on. More...
 

Detailed Description

Auto-exposure specific configuration.

Definition at line 566 of file MultiSenseTypes.hh.

Member Function Documentation

◆ operator==()

bool multisense::MultiSenseConfig::AutoExposureConfig::operator== ( const AutoExposureConfig rhs) const
inline

Equality operator.

Definition at line 612 of file MultiSenseTypes.hh.

Member Data Documentation

◆ decay

uint32_t multisense::MultiSenseConfig::AutoExposureConfig::decay = 3

The desired auto-exposure decay rate.

A larger value increases the number of frames it takes for the current auto exposure desired exposure to apply. Valid range is [1, 20]

Definition at line 579 of file MultiSenseTypes.hh.

◆ max_exposure_time

std::chrono::microseconds multisense::MultiSenseConfig::AutoExposureConfig::max_exposure_time {10000}

The max exposure time auto exposure algorithm can set in microseconds Valid range is [0, 33000].

Definition at line 572 of file MultiSenseTypes.hh.

◆ max_gain

float multisense::MultiSenseConfig::AutoExposureConfig::max_gain = 2.0f

The auto exposure algorithm adjusts both exposure and gain.

This caps the gain the auto exposure algorithm can use

Definition at line 601 of file MultiSenseTypes.hh.

◆ roi

AutoExposureRoiConfig multisense::MultiSenseConfig::AutoExposureConfig::roi {}

The auto exposure region-of-interest used to restrict the portion of the image which the auto exposure algorithm is run on.

Definition at line 607 of file MultiSenseTypes.hh.

◆ target_intensity

float multisense::MultiSenseConfig::AutoExposureConfig::target_intensity = 0.5f

The auto-exposure algorithm in digital imaging endeavors to achieve a specified target intensity, which is represented as a ratio.

This ratio, when multiplied by the maximum potential pixel brightness (255 for 8-bit images), produces the 'target auto-exposure pixel value'. The algorithm then adjusts the exposure of the camera to ensure a given 'target threshold' percentage of image pixels fall below this target intensity. This process maintains an ideal brightness balance, preventing overexposure or underexposure.

Definition at line 589 of file MultiSenseTypes.hh.

◆ target_threshold

float multisense::MultiSenseConfig::AutoExposureConfig::target_threshold = 0.85f

The fraction of pixels which must be equal or below the pixel value set by the target intensity pixel value.

Definition at line 595 of file MultiSenseTypes.hh.


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