Encapsulates the metadata of frames provided by the devices. More...

#include <FrameMetadata.h>

Collaboration diagram for optris::FrameMetadata:

Public Member Functions
OTC_SDK_API	FrameMetadata () noexcept
	Constructor.

OTC_SDK_API void	setFrom (const FrameMetadata2 &raw) noexcept
	Sets the metadata from the raw metadata provided by the processing pipeline.

bool	isThermalDataReliable () const noexcept
	Indicates whether the provided thermal data is reliable.

unsigned int	getCounter () const noexcept
	Returns a consecutive number for each received frame.

unsigned int	getCounterHardware () const noexcept
	Returns the frame number received from the device.

long long	getTimestamp () const noexcept
	Returns the frame timestamp in UNITS (10000000 units per second).

long long	getTimestampMedia () const noexcept
	Returns the media timestamp.

FlagState	getFlagState () const noexcept
	Returns the state of the shutter flag at frame capturing time.

void	setFlagState (FlagState flagState) noexcept
	Sets the state of the shutter flag.

float	getTemperatureFlag () const noexcept
	Returns the shutter flag temperature in °C at frame capturing time.

float	getTemperatureBox () const noexcept
	Returns the housing temperature in °C at frame capturing time.

float	getTemperatureChip () const noexcept
	Returns the sensor chip temperature in °C at frame capturing time.

RadiationParameterSource	getEmissivitySource () const noexcept
	Returns the source of the standard emissivity value.

RadiationParameterSource	getTransmissivitySource () const noexcept
	Returns the source of the standard transmissivity value.

RadiationParameterSource	getAmbientTemperatureSource () const noexcept
	Returns the source of the standard ambient temperature value.

RadiationParameters	getRadiationParameters () const noexcept
	Returns the standard radiation parameters.

OTC_SDK_API void	setRadiationParameters (const RadiationParameters &radiation) noexcept
	Sets the standard radiation parameters used to process the frame. Intended for code paths that reconstruct a FrameMetadata from an external source (ZMQ wire, recorded frames, tests) where the SDK's internal processing pipeline isn't the producer of this metadata.

OTC_SDK_API float	getPifAiValue (int deviceIndex, int pinIndex) const
	Returns the analog input value on the given PIF channel.

OTC_SDK_API bool	getPifDiValue (int deviceIndex, int pinIndex) const
	Returns the digital input value on the given PIF channel.

int	getPifActualDeviceCount () const noexcept
	Returns the count of actually connected PIF devices.

int	getPifConfigurableDeviceCount () const noexcept
	Returns the count of configurable PIF devices.

int	getPifAiCountPerDevice () const noexcept
	Returns the count of analog input channels per PIF device.

int	getPifDiCountPerDevice () const noexcept
	Returns the count of digital input channels per PIF device.

Detailed Description

Encapsulates the metadata of frames provided by the devices.

This metadata is passed alongside the frame data from the devices via the streaming interface (e.g. USB, Ethernet).

Member Function Documentation

◆ getAmbientTemperatureSource()

RadiationParameterSource optris::FrameMetadata::getAmbientTemperatureSource ( ) const

inlinenoexcept

Returns the source of the standard ambient temperature value.

Returns: source of the standard ambient temperature value.

◆ getCounter()

unsigned int optris::FrameMetadata::getCounter ( ) const

inlinenoexcept

Returns a consecutive number for each received frame.

Returns: consecutive number for each received frame.

◆ getCounterHardware()

unsigned int optris::FrameMetadata::getCounterHardware ( ) const

inlinenoexcept

Returns the frame number received from the device.

Note: This counter may overflow.

Returns: frame number received from the device.

◆ getEmissivitySource()

RadiationParameterSource optris::FrameMetadata::getEmissivitySource ( ) const

inlinenoexcept

Returns the source of the standard emissivity value.

Returns: source of the standard emissivity value.

◆ getFlagState()

FlagState optris::FrameMetadata::getFlagState ( ) const

inlinenoexcept

Returns the state of the shutter flag at frame capturing time.

Returns: state of the shutter flag at frame capturing time.

◆ getPifActualDeviceCount()

int optris::FrameMetadata::getPifActualDeviceCount ( ) const

inlinenoexcept

Returns the count of actually connected PIF devices.

Returns: count of actually connected PIF devices.

◆ getPifAiCountPerDevice()

int optris::FrameMetadata::getPifAiCountPerDevice ( ) const

inlinenoexcept

Returns the count of analog input channels per PIF device.

Returns: count of analog input channels per PIF device.

◆ getPifAiValue()

OTC_SDK_API float optris::FrameMetadata::getPifAiValue	(	int	deviceIndex,
		int	pinIndex ) const

Returns the analog input value on the given PIF channel.

Warning: The input values returned from channels on PIF devices that are just configurable but not actually connected to the camera (actualDeviceCount <= deviceIndex < configurableDeviceCount) are invalid!

Parameters

[in]	deviceIndex	of the PIF device.
[in]	pinIndex	of the pin on the specified PIF device.

Returns: analog input value on the given PIF channel.

Exceptions

SDKException if either the device or pin index is out of range.

◆ getPifConfigurableDeviceCount()

int optris::FrameMetadata::getPifConfigurableDeviceCount ( ) const

inlinenoexcept

Returns the count of configurable PIF devices.

Returns: count of configurable PIF devices.

◆ getPifDiCountPerDevice()

int optris::FrameMetadata::getPifDiCountPerDevice ( ) const

inlinenoexcept

Returns the count of digital input channels per PIF device.

Returns: count of digital input channels per PIF device.

◆ getPifDiValue()

OTC_SDK_API bool optris::FrameMetadata::getPifDiValue	(	int	deviceIndex,
		int	pinIndex ) const

Returns the digital input value on the given PIF channel.

Warning: The input values returned from channels on PIF devices that are just configurable but not actually connected to the camera (actualDeviceCount <= deviceIndex < configurableDeviceCount) are invalid!

Parameters

[in]	deviceIndex	of the PIF device.
[in]	pinIndex	of the pin on the specified PIF device.

Returns: digital input value on the given PIF channel.

Exceptions

SDKException if either the device or pin index is out of range.

◆ getRadiationParameters()

RadiationParameters optris::FrameMetadata::getRadiationParameters ( ) const

inlinenoexcept

Returns the standard radiation parameters.

The standard radiation parameters are used to process the thermal frame and all measurement fields that do not specify a custom emissivity. Measurement fields with a custom emissivity, however, will still utilize the transmissivity and ambient temperature from the standard radiation parameters.

Attention: The standard radiation parameters may be modified via the process interface (PIF) and through automated ambient temperature estimations. This method return the parameters set in the configuration or via IRImager::setRadiationParameters().

To get the set/configured parameters see IRImager::getRadiationParameters().

Returns: standard radiation parameters.

◆ getTemperatureBox()

float optris::FrameMetadata::getTemperatureBox ( ) const

inlinenoexcept

Returns the housing temperature in °C at frame capturing time.

Returns: housing temperature in °C at frame capturing time.

◆ getTemperatureChip()

float optris::FrameMetadata::getTemperatureChip ( ) const

inlinenoexcept

Returns the sensor chip temperature in °C at frame capturing time.

Returns: sensor chip temperature in °C at frame capturing time.

◆ getTemperatureFlag()

float optris::FrameMetadata::getTemperatureFlag ( ) const

inlinenoexcept

Returns the shutter flag temperature in °C at frame capturing time.

Returns: shutter flag temperature in °C at frame capturing time.

◆ getTimestamp()

long long optris::FrameMetadata::getTimestamp ( ) const

inlinenoexcept

Returns the frame timestamp in UNITS (10000000 units per second).

Returns: frame timestamp in UNITS (10000000 units per second).

◆ getTimestampMedia()

long long optris::FrameMetadata::getTimestampMedia ( ) const

inlinenoexcept

Returns the media timestamp.

Returns: media timestamp.

◆ getTransmissivitySource()

RadiationParameterSource optris::FrameMetadata::getTransmissivitySource ( ) const

inlinenoexcept

Returns the source of the standard transmissivity value.

Returns: source of the standard transmissivity value.

◆ isThermalDataReliable()

bool optris::FrameMetadata::isThermalDataReliable ( ) const

inlinenoexcept

Indicates whether the provided thermal data is reliable.

During the initial startup calibration the provided thermal data is not reliable. This is equivalent to the shutter flag being in the Initializing state

Returns: true if the provided thermal data is reliable. False otherwise.

◆ setFlagState()

void optris::FrameMetadata::setFlagState ( FlagState flagState )

inlinenoexcept

Sets the state of the shutter flag.

Parameters

[in] flagState to set.

◆ setRadiationParameters()

void optris::FrameMetadata::setRadiationParameters ( const RadiationParameters & radiation )

inlinenoexcept

Sets the standard radiation parameters used to process the frame. Intended for code paths that reconstruct a FrameMetadata from an external source (ZMQ wire, recorded frames, tests) where the SDK's internal processing pipeline isn't the producer of this metadata.

Parameters

[in] radiation the radiation parameters to store.

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

FrameMetadata.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getAmbientTemperatureSource()

◆ getCounter()

◆ getCounterHardware()

◆ getEmissivitySource()

◆ getFlagState()

◆ getPifActualDeviceCount()

◆ getPifAiCountPerDevice()

◆ getPifAiValue()

◆ getPifConfigurableDeviceCount()

◆ getPifDiCountPerDevice()

◆ getPifDiValue()

◆ getRadiationParameters()

◆ getTemperatureBox()

◆ getTemperatureChip()

◆ getTemperatureFlag()

◆ getTimestamp()

◆ getTimestampMedia()

◆ getTransmissivitySource()

◆ isThermalDataReliable()

◆ setFlagState()

◆ setRadiationParameters()