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	setTemperatures (float flag, float box, float chip) noexcept
	Set the flag, box and chip temperatures in °C.

OTC_SDK_API bool	getPifDigitalInputValue (int channel) const
	Returns the digital input value on the given PIF channel.

OTC_SDK_API float	getPifAnalogInputValue (int channel) const
	Returns the analog input value on the given PIF channel.

int	getPifDigitalInputChannelCount () const noexcept
	Returns the count of digital PIF input channel count.

int	getPifAnalogInputChannelCount () const noexcept
	Returns the count of analog PIF input channel count.

void	setPifInputChannelCounts (int digital, int analog) noexcept
	Sets the counts of the PIF input channels.

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

OTC_SDK_API void	setPifAnalogInputValue (int channel, float value)
	Sets the value of the specified PIF analog 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)
	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 )

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.

Returns: frame metadata object.

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

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

◆ getPifAnalogInputChannelCount()

int optris::FrameMetadata::getPifAnalogInputChannelCount ( ) const

inlinenoexcept

Returns the count of analog PIF input channel count.

Returns: count of analog PIF input channel count.

◆ getPifAnalogInputValue()

OTC_SDK_API float optris::FrameMetadata::getPifAnalogInputValue ( int channel ) const

Returns the analog input value on the given PIF channel.

Parameters

[in] channel number for which the input value is desired.

Returns: analog input value on the given PIF channel.

Exceptions

SDKException if channel number is out of bounds.

◆ getPifDigitalInputChannelCount()

int optris::FrameMetadata::getPifDigitalInputChannelCount ( ) const

inlinenoexcept

Returns the count of digital PIF input channel count.

Returns: count of digital PIF input channel count.

◆ getPifDigitalInputValue()

OTC_SDK_API bool optris::FrameMetadata::getPifDigitalInputValue ( int channel ) const

Returns the digital input value on the given PIF channel.

Parameters

[in] channel number for which the input value is desired.

Returns: digital input value on the given PIF channel.

Exceptions

SDKException if channel number is out of bounds.

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

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

◆ setPifAnalogInputValue()

OTC_SDK_API void optris::FrameMetadata::setPifAnalogInputValue	(	int	channel,
		float	value )

Sets the value of the specified PIF analog input channel.

Parameters

[in]	channel	analog input channel.
[in]	value	to set.

Exceptions

SDKException if channel number is out of bounds.

◆ setPifDigitalInputValue()

OTC_SDK_API void optris::FrameMetadata::setPifDigitalInputValue	(	int	channel,
		bool	value )

Sets the value of the specified PIF digital input channel.

Parameters

[in]	channel	digital input channel.
[in]	value	to set.

Exceptions

SDKException if channel number is out of bounds.

◆ setPifInputChannelCounts()

void optris::FrameMetadata::setPifInputChannelCounts	(	int	digital,
		int	analog )

inlinenoexcept

Sets the counts of the PIF input channels.

Parameters

[in]	digital	input channel count.
[in]	analog	input channel count.

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

◆ setTemperatures()

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

inlinenoexcept

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

Parameters

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

◆ 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()

◆ getCounter()

◆ getCounterHardware()

◆ getFlagState()

◆ getPifAnalogInputChannelCount()

◆ getPifAnalogInputValue()

◆ getPifDigitalInputChannelCount()

◆ getPifDigitalInputValue()

◆ getSize()

◆ getTemperatureBox()

◆ getTemperatureChip()

◆ getTemperatureFlag()

◆ getTimestamp()

◆ getTimestampMedia()

◆ isFrameDataReliable()

◆ setCounters()

◆ setFlagState()

◆ setPifAnalogInputValue()

◆ setPifDigitalInputValue()

◆ setPifInputChannelCounts()

◆ setSize()

◆ setTemperatures()

◆ setTimestamps()