LibMultiSense
LibMultiSense Documentation
Loading...
Searching...
No Matches
multisense::MultiSenseConfig::LightingConfig::ExternalConfig Struct Reference

Lighting config for lights driven by GPIO outputs from the MultiSense. More...

#include <MultiSenseTypes.hh>

Public Types

enum class  FlashMode : uint8_t { NONE , SYNC_WITH_MAIN_STEREO , SYNC_WITH_AUX }
 Different flash modes for the camera. More...
 

Public Member Functions

bool operator== (const ExternalConfig &rhs) const
 Equality operator.
 

Public Attributes

float intensity = 0.0f
 Lighting brightness ranging from 0 to 100.0.
 
FlashMode flash = FlashMode::NONE
 Configure flash mode.
 
uint32_t pulses_per_exposure = 1
 The number of pulses of the light per single exposure.
 
std::chrono::microseconds startup_time {0}
 The time it takes for the light to reach full brightness.
 

Detailed Description

Lighting config for lights driven by GPIO outputs from the MultiSense.

Definition at line 968 of file MultiSenseTypes.hh.

Member Enumeration Documentation

◆ FlashMode

Different flash modes for the camera.

Enumerator
NONE 
SYNC_WITH_MAIN_STEREO 
SYNC_WITH_AUX 

Definition at line 973 of file MultiSenseTypes.hh.

Member Function Documentation

◆ operator==()

bool multisense::MultiSenseConfig::LightingConfig::ExternalConfig::operator== ( const ExternalConfig rhs) const
inline

Equality operator.

Definition at line 1008 of file MultiSenseTypes.hh.

Member Data Documentation

◆ flash

FlashMode multisense::MultiSenseConfig::LightingConfig::ExternalConfig::flash = FlashMode::NONE

Configure flash mode.

Definition at line 988 of file MultiSenseTypes.hh.

◆ intensity

float multisense::MultiSenseConfig::LightingConfig::ExternalConfig::intensity = 0.0f

Lighting brightness ranging from 0 to 100.0.

A value of 0 will turn off the LEDs

Definition at line 983 of file MultiSenseTypes.hh.

◆ pulses_per_exposure

uint32_t multisense::MultiSenseConfig::LightingConfig::ExternalConfig::pulses_per_exposure = 1

The number of pulses of the light per single exposure.

This is used to trigger the light or output signal multiple times after a single exposure. For values greater than 1, pulses will occur between the exposures, not during. This can be used to leverage human persistence of vision to make the light appear as though it is not flashing

Definition at line 997 of file MultiSenseTypes.hh.

◆ startup_time

std::chrono::microseconds multisense::MultiSenseConfig::LightingConfig::ExternalConfig::startup_time {0}

The time it takes for the light to reach full brightness.

This will be used to ensure the light is at full brightness when the image is exposed

Definition at line 1003 of file MultiSenseTypes.hh.


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