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.

int	getSize () const noexcept
	Returns the size of the raw metadata structure in bytes.

void	setSize (int size) noexcept
	Sets the size of the raw metadata structure in bytes.

bool	isFrameDataReliable () const noexcept
	Returns whether the data provided in the associated frame 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.

void	setCounters (unsigned int counter, unsigned int counterHardware) noexcept
	Sets the frame counters.

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

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

void	setTimestamps (long long timestamp, long long timestampMedia) noexcept
	Sets the timestamps.

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.

void	setProbeTemperatures (float flag, float box, float chip) noexcept
	Set the flag, box and chip probe temperatures in °C.

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

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

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

RadiationParameters	getRadiationParameters () const noexcept
	Grants read access to the radiation parameters use to process the thermal frame.

void	setRadiationParameterSources (RadiationParameterSource emissivitySource, RadiationParameterSource ambientTemperatureSource) noexcept
	Sets the radiation parameters sources.

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.

OTC_SDK_API void	setPifCounts (int actualDeviceCount, int configurableDeviceCount, int aiCountPerDevice, int diCountPerDevice) noexcept
	Sets the counts of the PIF devices and input channels.

OTC_SDK_API void	setPifAiValue (int deviceIndex, int pinIndex, float value)
	Sets the value of the specified PIF analog input channel.

OTC_SDK_API void	setPifDiValue (int deviceIndex, int pinIndex, bool value)
	Sets the value of the specified PIF digital input channel.

OTC_SDK_API FrameMetadata	clone () const noexcept
	Returns a complete copy of this metadata.

Static Public Member Functions
static FrameMetadata	fromRawMetadata (FrameMetadata2 *raw, bool initializing, int pifActualDeviceCount, int pifConfigurableDeviceCount)
	Creates a frame metadata object from raw metadata.

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

◆ clone()

FrameMetadata optris::FrameMetadata::clone ( ) const

inlinenoexcept

Returns a complete copy of this metadata.

Returns: a complete copy of this metadata.

◆ fromRawMetadata()

static FrameMetadata optris::FrameMetadata::fromRawMetadata	(	FrameMetadata2 *	raw,
		bool	initializing,
		int	pifActualDeviceCount,
		int	pifConfigurableDeviceCount )

static

Creates a frame metadata object from raw metadata.

Parameters

[in]	raw	metadata to convert.
[in]	initializing	true if the device is currently performing the startup calibrations. False otherwise.
[in]	pifActualDeviceCount	count of actually connected PIF devices.
[in]	pifConfigurableDeviceCount	count of configurable PIF devices.

Returns: frame metadata object.

◆ getAmbientTemperatureSource()

RadiationParameterSource optris::FrameMetadata::getAmbientTemperatureSource ( ) const

inlinenoexcept

Returns the source of the ambient temperature value.

Returns: source of the 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 form the device.

◆ getEmissivitySource()

RadiationParameterSource optris::FrameMetadata::getEmissivitySource ( ) const

inlinenoexcept

Returns the source of the emissivity value.

Returns: source of the 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

Grants read access to the radiation parameters use to process the thermal frame.

Attention: The 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 vis IRImager::setRadiationParameters().

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

Returns: read access to the radiation parameters use to process the thermal frame.

◆ getSize()

int optris::FrameMetadata::getSize ( ) const

inlinenoexcept

Returns the size of the raw metadata structure in bytes.

Returns: size of the raw metadata structure in bytes.

◆ 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 time stamp.

◆ getTransmissivitySource()

RadiationParameterSource optris::FrameMetadata::getTransmissivitySource ( ) const

inlinenoexcept

Returns the source of the transmissivity value.

Returns: source of the transmissivity value.

◆ isFrameDataReliable()

bool optris::FrameMetadata::isFrameDataReliable ( ) const

inlinenoexcept

Returns whether the data provided in the associated frame is reliable.

During the initial startup calibration the data provide by the device is not reliable.

Returns: true if the data provided in the associated frame is reliable. False otherwise.

◆ setCounters()

void optris::FrameMetadata::setCounters	(	unsigned int	counter,
		unsigned int	counterHardware )

inlinenoexcept

Sets the frame counters.

Parameters

[in]	counter	to set.
[in]	counterHardware	to set.

◆ setFlagState()

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

inlinenoexcept

Sets the state of the shutter flag.

Parameters

[in] flagState to set.

◆ setPifAiValue()

OTC_SDK_API void optris::FrameMetadata::setPifAiValue	(	int	deviceIndex,
		int	pinIndex,
		float	value )

Sets the value of the specified PIF analog input channel.

Parameters

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

Exceptions

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

◆ setPifCounts()

OTC_SDK_API void optris::FrameMetadata::setPifCounts	(	int	actualDeviceCount,
		int	configurableDeviceCount,
		int	aiCountPerDevice,
		int	diCountPerDevice )

noexcept

Sets the counts of the PIF devices and input channels.

Parameters

[in]	actualDeviceCount	count of actual connected PIF devices.
[in]	configurableDeviceCount	count of configurable PIF devices.
[in]	aiCountPerDevice	count of analog input channels per PIF device.
[in]	diCountPerDevice	count of digital input channels per PIF device.

◆ setPifDiValue()

OTC_SDK_API void optris::FrameMetadata::setPifDiValue	(	int	deviceIndex,
		int	pinIndex,
		bool	value )

Sets the value of the specified PIF digital input channel.

Parameters

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

Exceptions

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

◆ setProbeTemperatures()

void optris::FrameMetadata::setProbeTemperatures	(	float	flag,
		float	box,
		float	chip )

inlinenoexcept

Set the flag, box and chip probe temperatures in °C.

Parameters

[in]	flag	temperature in °C.
[in]	box	temperature in °C.
[in]	chip	temperature in °C.

◆ setRadiationParameterSources()

void optris::FrameMetadata::setRadiationParameterSources	(	RadiationParameterSource	emissivitySource,
		RadiationParameterSource	ambientTemperatureSource )

inlinenoexcept

Sets the radiation parameters sources.

Parameters

[in]	emissivitySource	to set.
[in]	ambientTemperatureSource	to set.

◆ setSize()

void optris::FrameMetadata::setSize ( int size )

inlinenoexcept

Sets the size of the raw metadata structure in bytes.

Parameters

[in] size of the raw metadata structure in bytes.

◆ setTimestamps()

void optris::FrameMetadata::setTimestamps	(	long long	timestamp,
		long long	timestampMedia )

inlinenoexcept

Sets the timestamps.

Parameters

[in]	timestamp	frame timestamp in UNITS (10000000 units per second).
[in]	timestampMedia	media timestamp.

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

FrameMetadata.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ clone()

◆ fromRawMetadata()

◆ getAmbientTemperatureSource()

◆ getCounter()

◆ getCounterHardware()

◆ getEmissivitySource()

◆ getFlagState()

◆ getPifActualDeviceCount()

◆ getPifAiCountPerDevice()

◆ getPifAiValue()

◆ getPifConfigurableDeviceCount()

◆ getPifDiCountPerDevice()

◆ getPifDiValue()

◆ getRadiationParameters()

◆ getSize()

◆ getTemperatureBox()

◆ getTemperatureChip()

◆ getTemperatureFlag()

◆ getTimestamp()

◆ getTimestampMedia()

◆ getTransmissivitySource()

◆ isFrameDataReliable()

◆ setCounters()

◆ setFlagState()

◆ setPifAiValue()

◆ setPifCounts()

◆ setPifDiValue()

◆ setProbeTemperatures()

◆ setRadiationParameterSources()

◆ setSize()

◆ setTimestamps()