Holds the radiation parameters for a frame or a measurement field. More...

#include <RadiationParameters.h>

Collaboration diagram for optris::RadiationParameters:

Static Public Member Functions
static OTC_SDK_API void	validate (RadiationParameters &radiation) noexcept
	Validates the radiation parameters.

static OTC_SDK_API void	validate (float &parameter) noexcept
	Validates emissivity and transmissivity parameter values.

Public Attributes
float	emissivity = 1.F
	Emissivity.

float	transmissivity = 1.F
	Transmissivity.

float	ambientTemperature = INVALID_TEMPERATURE
	Ambient temperature in °C.

bool	estimateAmbientTemperature = true
	Estimate the ambient temperature.

Detailed Description

Holds the radiation parameters for a frame or a measurement field.

Member Function Documentation

◆ validate() [1/2]

static OTC_SDK_API void optris::RadiationParameters::validate ( float & parameter )

staticnoexcept

Validates emissivity and transmissivity parameter values.

Clamps the parameter value to [0.01, 1.1].

Parameters

[in,out] parameter to validate.

◆ validate() [2/2]

static OTC_SDK_API void optris::RadiationParameters::validate ( RadiationParameters & radiation )

staticnoexcept

Validates the radiation parameters.

Clamps emissivity and transmissivity values to [0.01, 1.1]. If ambientTemperature is less than or equal to INVALID_TEMPERATURE, estimateAmbientTemperature will be set to true.

Parameters

[in,out] radiation parameters to validate.

Member Data Documentation

◆ ambientTemperature

float optris::RadiationParameters::ambientTemperature = INVALID_TEMPERATURE

Ambient temperature in °C.

For an automated estimation of this temperature see estimateAmbientTemperature.

See also: estimateAmbientTemperature

◆ emissivity

float optris::RadiationParameters::emissivity = 1.F

Emissivity.

Its value will be limited to [0.01, 1.1].

◆ estimateAmbientTemperature

bool optris::RadiationParameters::estimateAmbientTemperature = true

Estimate the ambient temperature.

Attention: This flag will have no effect if a source other than the SDK is used to determine the ambient temperature value (for example a process interface).

If set to true

the ambient temperature will be estimated from internal temperature probe readings
the ambient temperature estimate will be updated, if the probe readings change significantly.
the value of ambientTemperature will be ignored.

If set to false

the value of ambientTemperature will be applied.
the value of ambientTemperature will not be updated.

◆ transmissivity

float optris::RadiationParameters::transmissivity = 1.F

Transmissivity.