Encapsulates the configuration of a measurement field. More...

#include <MeasurementFieldConfig.h>

Collaboration diagram for optris::MeasurementFieldConfig:

Public Member Functions
OTC_SDK_API	MeasurementFieldConfig () noexcept
	Constructor.

OTC_SDK_API void	validate () const
	Validates the configuration settings.

Public Attributes
std::string	name
	Name of the measurement field.

FieldShape	shape
	Shape of the measurement field.

FieldMode	mode
	Mode for the measurement field.

int	positionX
	x position of the measurement field in pixels.

int	positionY
	y position of the measurement field in pixels.

int	width
	Width of the measurement field in pixels.

int	height
	Height of the measurement field in pixels.

float	emissivity
	Emissivity for the measurement field.

float	transmissivity
	Transmissivity for the measurement field.

float	ambientTemperature
	Ambient temperature in °C for the measurement field.

Detailed Description

Encapsulates the configuration of a measurement field.

Member Function Documentation

◆ validate()

OTC_SDK_API void optris::MeasurementFieldConfig::validate ( ) const

Validates the configuration settings.

Exceptions

SDKException if the configuration contains invalid settings.

Member Data Documentation

◆ ambientTemperature

float optris::MeasurementFieldConfig::ambientTemperature

Ambient temperature in °C for the measurement field.

If set to INVALID_TEMPERATURE (-100) or less, the SDK will estimate the ambient temperature based on internal thermal probe readings.

◆ emissivity

float optris::MeasurementFieldConfig::emissivity

Emissivity for the measurement field.

Should be in [0.01, 1.1].

◆ height

int optris::MeasurementFieldConfig::height

Height of the measurement field in pixels.

Applicable for the following shapes:

rectangle

◆ positionX

int optris::MeasurementFieldConfig::positionX

x position of the measurement field in pixels.

Depending of the shape of the field this may refer to different things:

rectangle: Position of the upper left corner.

◆ positionY

int optris::MeasurementFieldConfig::positionY

y position of the measurement field in pixels.

Depending of the shape of the field this may refer to different things:

rectangle: Position of the upper left corner.

◆ transmissivity

float optris::MeasurementFieldConfig::transmissivity

Transmissivity for the measurement field.

Should be in [0.01, 1.1].

◆ width

int optris::MeasurementFieldConfig::width

Width of the measurement field in pixels.