Class ThermalConfig

• Defined in File ThermalConfig.hpp

Nested Relationships

Nested Types

• Struct ThermalConfig::ThermalAmbientParams

• Struct ThermalConfig::ThermalFFCParams

• Struct ThermalConfig::ThermalImageParams

Inheritance Relationships

Base Type

• public dai::Buffer (Class Buffer)

Class Documentation

class ThermalConfig : public dai::Buffer

ThermalConfig message. Currently unused.

Public Types

enum ThermalImageOrientation

Orientation of the image.

Values:

enumerator Normal

enumerator Mirror

enumerator Flip

enumerator MirrorFlip

enum ThermalGainMode

Thermal sensor gain mode. Use low gain in high energy environments.

Values:

enumerator LOW

enumerator HIGH

Public Functions

ThermalConfig() = default

Construct ThermalConfig message.

virtual ~ThermalConfig()

virtual void serialize(std::vector<std::uint8_t> &metadata, DatatypeEnum &datatype) const override

DEPTHAI_SERIALIZE(ThermalConfig, ambientParams, ffcParams, imageParams)

Public Members

ThermalAmbientParams ambientParams

Ambient factors that affect the temperature measurement of a Thermal sensor.

ThermalFFCParams ffcParams

Parameters for Flat-Field-Correction.

ThermalImageParams imageParams

Image signal processing parameters on the sensor.

struct ThermalAmbientParams

Ambient factors that affect the temperature measurement of a Thermal sensor.

Public Functions

DEPTHAI_SERIALIZE(ThermalAmbientParams, distance, reflectionTemperature, atmosphericTemperature, targetEmissivity, atmosphericTransmittance, gainMode)

Public Members

std::optional<uint16_t> distance

Distance to the measured object. unit:cnt(128cnt=1m), range:0-25600(0-200m)

std::optional<uint16_t> reflectionTemperature

Reflection temperature. unit:K, range:230-500(high gain), 230-900(low gain)

std::optional<uint16_t> atmosphericTemperature

Atmospheric temperature. unit:K, range:230-500(high gain), 230-900(low gain)

std::optional<uint8_t> targetEmissivity

Emissivity. unit:1/128, range:1-128(0.01-1)

std::optional<uint8_t> atmosphericTransmittance

Atmospheric transmittance. unit:1/128, range:1-128(0.01-1)

std::optional<ThermalGainMode> gainMode

Gain mode, low or high.

struct ThermalFFCParams

Public Functions

DEPTHAI_SERIALIZE(ThermalFFCParams, autoFFC, minFFCInterval, maxFFCInterval, autoFFCTempThreshold, fallProtection, minShutterInterval, closeManualShutter, antiFallProtectionThresholdHighGainMode, antiFallProtectionThresholdLowGainMode)

Public Members

std::optional<bool> autoFFC

Auto Flat-Field-Correction. Controls wheather the shutter is controlled by the sensor module automatically or not.

std::optional<uint16_t> minFFCInterval

Minimum FFC interval when auto FFC is enabled. The time interval between two FFC should not be less than this value.

std::optional<uint16_t> maxFFCInterval

Maximum FFC interval when auto FFC is enabled. The time interval between two FFC should not be more than this value.

std::optional<uint16_t> autoFFCTempThreshold

Auto FFC trigger threshold. The condition for triggering the auto FFC is that the change of Vtemp value exceeds a certain threshold, which is called the Auto FFC trigger threshold.

std::optional<bool> fallProtection

The shutter blade may open/close abnormally during strong mechanical shock (such as fall), and a monitoring process is designed in the firmware to correct the abnormal shutter switch in time. Turn on or off the fall protect mechanism.

std::optional<uint16_t> minShutterInterval

Frequent FFC will cause shutter heating, resulting in abnormal FFC effect and abnormal temperature measurement. Regardless of which mechanism triggers FFC, the minimum trigger interval must be limited.

std::optional<bool> closeManualShutter

Set this to True/False to close/open the shutter when autoFFC is disabled.

std::optional<uint16_t> antiFallProtectionThresholdHighGainMode

std::optional<uint16_t> antiFallProtectionThresholdLowGainMode

struct ThermalImageParams

Public Functions

DEPTHAI_SERIALIZE(ThermalImageParams, timeNoiseFilterLevel, spatialNoiseFilterLevel, digitalDetailEnhanceLevel, brightnessLevel, contrastLevel, orientation)

Public Members

std::optional<uint8_t> timeNoiseFilterLevel

0-3. Time noise filter level. Filters out the noise that appears over time.

std::optional<uint8_t> spatialNoiseFilterLevel

0-3. Spatial noise filter level.

std::optional<uint8_t> digitalDetailEnhanceLevel

0-4 Digital etail enhance level.

std::optional<uint8_t> brightnessLevel

Image brightness level, 0-255.

std::optional<uint8_t> contrastLevel

Image contrast level, 0-255.

std::optional<ThermalImageOrientation> orientation

Orientation of the image. Computed on the sensor.