optris::IRImagerConfig Class Reference

Holds the SDK settings found in the configuration file. More...

#include <IRImagerConfig.h>

Collaboration diagram for optris::IRImagerConfig:

Public Member Functions
OTC_SDK_API	IRImagerConfig () noexcept
	Constructor.
OTC_SDK_API void	validate ()
	Validates the configuration settings.

Public Attributes
int	version
	Version of the configuration file.
unsigned long	serialNumber
	Serial number of the device.
std::string	connectionInterface
	Interface used to connect to the device (USB, Ethernet).
IpAddress	ipAddress
	IP address of the device.
unsigned short	port
	Local UDP port to which the device sends data to.
bool	checkIp
	Flag indicating whether to only process UDP packages from the IP address specified by the ipAddress member variable.
int	connectionTimeout
	Specifies the time in seconds that has to elapse without no new frame received until an connection timeout occurs.
unsigned short	bufferQueueSize
	Internal queue size for buffers holding received frames.
int	width
	Width in pixels of the output frame.
int	height
	Height in pixels of the output frame.
int	framerate
	Output framerate in Hz.
float	subsampledFramerate
	Subsampled output framerate.
int	fieldOfView
	Field of view of the optics in degree.
std::string	opticsText
	Optional text further specifying the used optics.
bool	enableSoSCorrection
	Use Size of Source Correction if available in calibration data.
int	minTemperature
	Lower limit of the desired temperature range in °C.
int	maxTemperature
	Upper limit of the desired temperature range in °C.
bool	enableExtendedTemperatureRange
	Extends the chosen temperature range if possible.
bool	enableHighPrecisionTemperature
	Use high precision temperatures if available.
bool	autoFlag
	Enable the automatic triggering of flag cycles.
float	minInterval
	Minimum time in seconds that has to pass before a new flag cycle can be triggered.
float	maxInterval
	Maximum time in seconds that can pass before a new flag cycle is forced.
std::string	chipHeatingMode
	Specified how and if the sensor chip is beeing heated.
float	chipHeatingTemperature
	Temperature in °C for the fixed chipHeatingMode.
float	focusMotorPosition
	Position of the focus motor in % ([0, 100]).
RadiationParameters	radiation
	Radiation parameters for the overall thermal frame.
bool	enableMultiThreading
	Activate multithreading for postprocessing.
bool	failSafeFlagTimeouts
	Indicates whether a flag timeout that caused the failure of a flag cycle should trigger the fail safe.
int	failSafeFlagTimeoutsMaxCycleFailures
	Specifies the number of failed flag cycles to be tolerated before fail safe is triggered due to flag timeouts.
bool	failSafeProcessingChainTimeouts
	Indicates whether a failure of the processing chain to reach all of its endpoints (thermal frame and measurement fields) within a given time frame should trigger the fail safe.
std::vector< MeasurementFieldConfig >	measurementFields
	Measurement field configuration.
PifConfig	processInterface
	Processing interface configuration.

Detailed Description

Holds the SDK settings found in the configuration file.

Member Function Documentation

validate()

OTC_SDK_API void optris::IRImagerConfig::validate

(

)

Validates the configuration settings.

If a faulty setting can be replaced by a valid default this method will do so automatically and print a log warning message. If no valid default is available a SDKException is throws instead.

Exceptions

SDKException

if configuration contains uncorrectable invalid settings.

Member Data Documentation

autoFlag

bool optris::IRImagerConfig::autoFlag

Enable the automatic triggering of flag cycles.

Optris thermal cameras feature an internal shutter flag. It need to be closed periodically for the SDK to compensate for drifting temperature measurements.

If set to true, flag cycles will be automatically triggered when one of the temperatures measured by internal probes changes by more than 0.1 °C.

bufferQueueSize

unsigned short optris::IRImagerConfig::bufferQueueSize

Internal queue size for buffers holding received frames.

This setting has no influence on the size of the buffers. Their size is determined by the used video format.

checkIp

bool optris::IRImagerConfig::checkIp

Flag indicating whether to only process UDP packages from the IP address specified by the ipAddress member variable.

Set to true to activate this check or set to false to deactivate it.

chipHeatingMode

std::string optris::IRImagerConfig::chipHeatingMode

Specified how and if the sensor chip is beeing heated.

The following modes are available:

• floating: The sensor chip will not be heated.
• auto : The sensor chip will be heated to the temperature specified in the calibrations.
• fixed : The sensor chip will be heated to the temperature specified by the chipHeatingTemperature settings.

Case insensitive.

connectionInterface

std::string optris::IRImagerConfig::connectionInterface

Interface used to connect to the device (USB, Ethernet).

Case insensitive.

connectionTimeout

int optris::IRImagerConfig::connectionTimeout

Specifies the time in seconds that has to elapse without no new frame received until an connection timeout occurs.

If connection timeout is detected the IRImager instance will call the IRImagerClient::onConnectionTimeout() callback.

enableExtendedTemperatureRange

bool optris::IRImagerConfig::enableExtendedTemperatureRange

Extends the chosen temperature range if possible.

When extending the temperature range you do not need to change the values for minTemperature and maxTemperature. The range is always specified by the non extended temperatures.

Warning

Extended temperature ranges are intended to help you align the field of view of your camera. The precision of the temperature measurements in this mode may not be within the specification.

enableHighPrecisionTemperature

bool optris::IRImagerConfig::enableHighPrecisionTemperature

Use high precision temperatures if available.

If true, high precision temperatures will automatically be used if the device and the chosen temperature range supports them.

enableMultiThreading

bool optris::IRImagerConfig::enableMultiThreading

Activate multithreading for postprocessing.

Warning

Experimental setting.

enableSoSCorrection

bool optris::IRImagerConfig::enableSoSCorrection

Use Size of Source Correction if available in calibration data.

If true, Size of Source Correction will automatically be used if available in calibration data.

failSafeFlagTimeouts

bool optris::IRImagerConfig::failSafeFlagTimeouts

Indicates whether a flag timeout that caused the failure of a flag cycle should trigger the fail safe.

A flag timeout occurs when the shutter flag does not reach its expected state within a given time frame. If this happens, the current flag cycle will be considered to have failed.

failSafeFlagTimeoutsMaxCycleFailures

int optris::IRImagerConfig::failSafeFlagTimeoutsMaxCycleFailures

Specifies the number of failed flag cycles to be tolerated before fail safe is triggered due to flag timeouts.

See also

IRImagerConfig::failSafeTriggerOnFlagTimeout

failSafeProcessingChainTimeouts

bool optris::IRImagerConfig::failSafeProcessingChainTimeouts

Indicates whether a failure of the processing chain to reach all of its endpoints (thermal frame and measurement fields) within a given time frame should trigger the fail safe.

If set to false, the fail safe will still be triggered when the processing chain itself crashes or gets stuck.

fieldOfView

int optris::IRImagerConfig::fieldOfView

Field of view of the optics in degree.

If the field of view is set to 0 and the opticsText is empty the SDK will use the first available optics.

focusMotorPosition

float optris::IRImagerConfig::focusMotorPosition

Position of the focus motor in % ([0, 100]).

Should be in [0., 100.]. Set to a value less than 0 for the SDK to ignore this setting.

framerate

int optris::IRImagerConfig::framerate

Output framerate in Hz.

If width, height and framerate are all set to 0 the SDK will use the first available video format.

height

int optris::IRImagerConfig::height

Height in pixels of the output frame.

If width, height and framerate are all set to 0 the SDK will use the first available video format.

maxTemperature

int optris::IRImagerConfig::maxTemperature

Upper limit of the desired temperature range in °C.

Always use the temperatures for the not extended range.

If the minimum and maximum temperature are set to 0 the SDK will use the first available temperature range.

minTemperature

int optris::IRImagerConfig::minTemperature

Lower limit of the desired temperature range in °C.

Always use the temperatures for the not extended range.

If the minimum and maximum temperature are set to 0 the SDK will use the first available temperature range.

opticsText

std::string optris::IRImagerConfig::opticsText

Optional text further specifying the used optics.

If the field of view is set to 0 and the opticsText is empty the SDK will use the first available optics.

radiation

RadiationParameters optris::IRImagerConfig::radiation

Radiation parameters for the overall thermal frame.

For the radiation parameters of measurement fields see the MeasurementFieldConfig class.

subsampledFramerate

float optris::IRImagerConfig::subsampledFramerate

Subsampled output framerate.

The SDK internally reduces the output framerate to this value. This setting has no effect on the device itself, meaning the device will always send frames at the rate specified by the framerate member variable.

Set to a value in [0, framerate] to achieve subsampling or set to a value to less than 0 to deactivate this feature.

width

int optris::IRImagerConfig::width

Width in pixels of the output frame.

If width, height and framerate are all set to 0 the SDK will use the first available video format.

---

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

• IRImagerConfig.h