Thermal Camera SDK 10.1.1
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
optris::RadiationParameters Class Reference

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

#include <RadiationParameters.h>

Collaboration diagram for optris::RadiationParameters:
Collaboration graph

Public Member Functions

OTC_SDK_API RadiationParameters () noexcept
 Constructor.
 
OTC_SDK_API void validate ()
 Validates and rectifies the radiation parameters.
 
OTC_SDK_API std::string toString () const noexcept
 Returns a string representation of the radiation parameters.
 

Public Attributes

float emissivity
 Emissivity.
 
float transmissivity
 Transmissivity.
 
float ambientTemperature
 Ambient temperature in °C.
 
bool estimateAmbientTemperature
 Estimate the ambient temperature.
 

Detailed Description

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

Member Function Documentation

◆ toString()

OTC_SDK_API std::string optris::RadiationParameters::toString ( ) const
noexcept

Returns a string representation of the radiation parameters.

Returns
string representation of the radiation parameters.

Member Data Documentation

◆ ambientTemperature

float optris::RadiationParameters::ambientTemperature

Ambient temperature in °C.

For an automated estimation of this temperature see estimateAmbientTemperature.

See also
estimateAmbientTemperature

◆ emissivity

float optris::RadiationParameters::emissivity

Emissivity.

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

◆ estimateAmbientTemperature

bool optris::RadiationParameters::estimateAmbientTemperature

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

Transmissivity.

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


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