Metrics related to this capture. More...

#include <Zivid/FrameInfo.h>

Classes
class	AcquisitionTime
	Acquisition Time is the duration from the start of the capture to when the camera has acquired the last image. After this time, the camera has finished its acquisition and you can move the robot, or capture with another camera with overlapping field of view. Acquisition Time is equal to the time it takes for the Camera::capture(settings) API function call to return. More...
class	CaptureTime
	Capture Time is the duration from the start of the capture to when all of the data transfer and processing has completed. After this time the 3D point cloud and/or 2D color image is ready and available on the GPU memory, and can be copied to the system memory (RAM). More...
class	ReprocessingTime
	Reprocessing re-runs the entire processing pipeline (including filters, color balance etc.) on a previously acquired frame. Reprocessing is available in Zivid Studio for captures with Diagnostics Mode enabled. The ReprocessingTime field is only set if this frame was reprocessed after it was initially captured, otherwise it will be unset. More...
class	ThrottlingTime
	Throttling Time is the duration that the capture was paused due to thermal or other constraints on the camera's components while it was capturing this frame. This duration is part of the overall Acquisition Time. If the camera throttled during a capture, it will result in a longer Acquisition Time. More...

Public Types
using	Descendants

Public Member Functions
	Metrics ()
	Default constructor.
template<typename... Args>
	Metrics (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
Metrics	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const AcquisitionTime &	acquisitionTime () const
	Get AcquisitionTime.
AcquisitionTime &	acquisitionTime ()
	Get AcquisitionTime.
Metrics &	set (const AcquisitionTime &value)
	Set AcquisitionTime.
const CaptureTime &	captureTime () const
	Get CaptureTime.
CaptureTime &	captureTime ()
	Get CaptureTime.
Metrics &	set (const CaptureTime &value)
	Set CaptureTime.
const ReprocessingTime &	reprocessingTime () const
	Get ReprocessingTime.
ReprocessingTime &	reprocessingTime ()
	Get ReprocessingTime.
Metrics &	set (const ReprocessingTime &value)
	Set ReprocessingTime.
const ThrottlingTime &	throttlingTime () const
	Get ThrottlingTime.
ThrottlingTime &	throttlingTime ()
	Get ThrottlingTime.
Metrics &	set (const ThrottlingTime &value)
	Set ThrottlingTime.
template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::AcquisitionTime >::value, int >::type = 0>
const FrameInfo::Metrics::AcquisitionTime &	get () const
template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::CaptureTime >::value, int >::type = 0>
const FrameInfo::Metrics::CaptureTime &	get () const
template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::ReprocessingTime >::value, int >::type = 0>
const FrameInfo::Metrics::ReprocessingTime &	get () const
template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::ThrottlingTime >::value, int >::type = 0>
const FrameInfo::Metrics::ThrottlingTime &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::Metrics::AcquisitionTime &	get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const FrameInfo::Metrics::CaptureTime &	get () const
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const FrameInfo::Metrics::ReprocessingTime &	get () const
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const FrameInfo::Metrics::ThrottlingTime &	get () const
template<typename F>
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter.
template<typename F>
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const Metrics &other) const
	Equality operator.
bool	operator!= (const Metrics &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "Metrics" }
	The full path for this value.
static constexpr const char *	name { "Metrics" }
	The name of this value.
static constexpr const char *	description { R"description(Metrics related to this capture.)description" }
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Metrics >
std::ostream &	operator<< (std::ostream &stream, const Metrics &value)
	Operator to send the value as string to a stream.

Detailed Description

Metrics related to this capture.

Member Typedef Documentation

◆ Descendants

using Zivid::FrameInfo::Metrics::Descendants

Initial value:

 std::tuple<
                FrameInfo::Metrics::AcquisitionTime,
                FrameInfo::Metrics::CaptureTime,
                FrameInfo::Metrics::ReprocessingTime,
                FrameInfo::Metrics::ThrottlingTime>

Constructor & Destructor Documentation

◆ Metrics() [1/2]

Zivid::FrameInfo::Metrics::Metrics ( )

Default constructor.

◆ Metrics() [2/2]

template<typename... Args>

Zivid::FrameInfo::Metrics::Metrics ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Metrics then invoking set(args).

The provided arguments must be descendants of Metrics. These types can be provided:

Member Function Documentation

◆ acquisitionTime() [1/2]

AcquisitionTime & Zivid::FrameInfo::Metrics::acquisitionTime ( )

inline

Get AcquisitionTime.

◆ acquisitionTime() [2/2]

const AcquisitionTime & Zivid::FrameInfo::Metrics::acquisitionTime ( ) const

inline

Get AcquisitionTime.

◆ captureTime() [1/2]

CaptureTime & Zivid::FrameInfo::Metrics::captureTime ( )

inline

Get CaptureTime.

◆ captureTime() [2/2]

const CaptureTime & Zivid::FrameInfo::Metrics::captureTime ( ) const

inline

Get CaptureTime.

◆ copyWith()

template<typename... Args>

Metrics Zivid::FrameInfo::Metrics::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Metrics object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Metrics. These types can be provided:

◆ forEach() [1/2]

template<typename F>

void Zivid::FrameInfo::Metrics::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F>

void Zivid::FrameInfo::Metrics::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/8]

template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::AcquisitionTime >::value, int >::type = 0>

const FrameInfo::Metrics::AcquisitionTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [2/8]

template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::CaptureTime >::value, int >::type = 0>

const FrameInfo::Metrics::CaptureTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [3/8]

template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::ReprocessingTime >::value, int >::type = 0>

const FrameInfo::Metrics::ReprocessingTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [4/8]

template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Metrics::ThrottlingTime >::value, int >::type = 0>

const FrameInfo::Metrics::ThrottlingTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [5/8]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const FrameInfo::Metrics::AcquisitionTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [6/8]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const FrameInfo::Metrics::CaptureTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [7/8]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>

const FrameInfo::Metrics::ReprocessingTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ get() [8/8]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>

const FrameInfo::Metrics::ThrottlingTime & Zivid::FrameInfo::Metrics::get ( ) const

inline

◆ operator!=()

bool Zivid::FrameInfo::Metrics::operator!= ( const Metrics & other ) const

Inequality operator.

◆ operator==()

bool Zivid::FrameInfo::Metrics::operator== ( const Metrics & other ) const

Equality operator.

◆ reprocessingTime() [1/2]

ReprocessingTime & Zivid::FrameInfo::Metrics::reprocessingTime ( )

inline

Get ReprocessingTime.

◆ reprocessingTime() [2/2]

const ReprocessingTime & Zivid::FrameInfo::Metrics::reprocessingTime ( ) const

inline

Get ReprocessingTime.

◆ set() [1/5]

template<typename... Args>

void Zivid::FrameInfo::Metrics::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Metrics. These types can be provided:

◆ set() [2/5]

Metrics & Zivid::FrameInfo::Metrics::set ( const AcquisitionTime & value )

inline

Set AcquisitionTime.

◆ set() [3/5]

Metrics & Zivid::FrameInfo::Metrics::set ( const CaptureTime & value )

inline

Set CaptureTime.

◆ set() [4/5]

Metrics & Zivid::FrameInfo::Metrics::set ( const ReprocessingTime & value )

inline

Set ReprocessingTime.

◆ set() [5/5]

Metrics & Zivid::FrameInfo::Metrics::set ( const ThrottlingTime & value )

inline

Set ThrottlingTime.

◆ throttlingTime() [1/2]

ThrottlingTime & Zivid::FrameInfo::Metrics::throttlingTime ( )

inline

Get ThrottlingTime.

◆ throttlingTime() [2/2]

const ThrottlingTime & Zivid::FrameInfo::Metrics::throttlingTime ( ) const

inline

Get ThrottlingTime.

◆ toString()

std::string Zivid::FrameInfo::Metrics::toString ( ) const

Get the value as string.

◆ DataModel::Detail::Befriend< Metrics >

friend struct DataModel::Detail::Befriend< Metrics >

friend

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const Metrics &	value )

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::FrameInfo::Metrics::description { R"description(Metrics related to this capture.)description" }

staticconstexpr

The description for this value.

◆ name

const char* Zivid::FrameInfo::Metrics::name { "Metrics" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::FrameInfo::Metrics::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::FrameInfo::Metrics::path { "Metrics" }

staticconstexpr

The full path for this value.

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

Zivid/FrameInfo.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Metrics() [1/2]

◆ Metrics() [2/2]

Member Function Documentation

◆ acquisitionTime() [1/2]

◆ acquisitionTime() [2/2]

◆ captureTime() [1/2]

◆ captureTime() [2/2]

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/8]

◆ get() [2/8]

◆ get() [3/8]

◆ get() [4/8]

◆ get() [5/8]

◆ get() [6/8]

◆ get() [7/8]

◆ get() [8/8]

◆ operator!=()

◆ operator==()

◆ reprocessingTime() [1/2]

◆ reprocessingTime() [2/2]

◆ set() [1/5]

◆ set() [2/5]

◆ set() [3/5]

◆ set() [4/5]

◆ set() [5/5]

◆ throttlingTime() [1/2]

◆ throttlingTime() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Metrics >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path