CloudSoftwareHardware
Software Stack
DepthAI
OAK Apps
AI Models

ON THIS PAGE

  • ThermalConfig
  • Examples of functionality
  • Reference

ThermalConfig

The ThermalConfig message is used to configure the Thermal node.
It allows runtime control over thermal imaging parameters, flat field correction (FFC), ambient parameters, gain modes, brightness, contrast and denoising algorithms.You can send this message dynamically via the node's inputConfig input queue to update parameters while streaming.

Examples of functionality

Reference

class

dai::ThermalConfig

#include ThermalConfig.hpp
variable
ThermalAmbientParams ambientParams
variable
variable
ThermalImageParams imageParams
function
ThermalConfig()
Construct ThermalConfig message.
function
~ThermalConfig()
inline function
void serialize(std::vector< std::uint8_t > & metadata, DatatypeEnum & datatype)
function
struct

dai::ThermalConfig::ThermalAmbientParams

#include ThermalConfig.hpp
variable
std::optional< uint16_t > distance
variable
std::optional< uint16_t > reflectionTemperature
variable
std::optional< uint16_t > atmosphericTemperature
variable
std::optional< uint8_t > targetEmissivity
variable
std::optional< uint8_t > atmosphericTransmittance
variable
std::optional< ThermalGainMode > gainMode
function
struct

dai::ThermalConfig::ThermalFFCParams

variable
std::optional< bool > autoFFC
variable
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.
variable
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.
variable
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.
variable
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.
variable
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.
variable
std::optional< bool > closeManualShutter
variable
std::optional< uint16_t > antiFallProtectionThresholdHighGainMode
variable
std::optional< uint16_t > antiFallProtectionThresholdLowGainMode
function
DEPTHAI_SERIALIZE(ThermalFFCParams, autoFFC, minFFCInterval, maxFFCInterval, autoFFCTempThreshold, fallProtection, minShutterInterval, closeManualShutter, antiFallProtectionThresholdHighGainMode, antiFallProtectionThresholdLowGainMode)
struct

dai::ThermalConfig::ThermalImageParams

variable
std::optional< uint8_t > timeNoiseFilterLevel
variable
std::optional< uint8_t > spatialNoiseFilterLevel
variable
std::optional< uint8_t > digitalDetailEnhanceLevel
variable
std::optional< uint8_t > brightnessLevel
variable
std::optional< uint8_t > contrastLevel
variable
std::optional< ThermalImageOrientation > orientation
function
enum

ThermalImageOrientation

enumerator
Normal
enumerator
Mirror
enumerator
Flip
enumerator
MirrorFlip
enum

ThermalGainMode

Thermal sensor gain mode. Use low gain in high energy environments.
enumerator
LOW
enumerator
HIGH

Need assistance?

Head over to Discussion Forum for technical support or any other questions you might have.