Zivid::FrameInfo::Metrics::ReprocessingTime Class Reference

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

#include <Zivid/FrameInfo.h>

Public Types
using	ValueType = std::chrono::microseconds
	The type of the underlying value.

Public Member Functions
	ReprocessingTime ()=default
	Default constructor.
constexpr	ReprocessingTime (std::chrono::microseconds value)
	Constructor.
std::chrono::microseconds	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const ReprocessingTime &other) const
	Comparison operator.
bool	operator!= (const ReprocessingTime &other) const
	Comparison operator.
bool	operator< (const ReprocessingTime &other) const
	Comparison operator.
bool	operator> (const ReprocessingTime &other) const
	Comparison operator.
bool	operator<= (const ReprocessingTime &other) const
	Comparison operator.
bool	operator>= (const ReprocessingTime &other) const
	Comparison operator.

Static Public Member Functions
static constexpr Range< std::chrono::microseconds >	validRange ()
	The range of valid values for ReprocessingTime.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Metrics/ReprocessingTime" }
	The full path for this value.
static constexpr const char *	name { "ReprocessingTime" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< ReprocessingTime >
std::ostream &	operator<< (std::ostream &stream, const ReprocessingTime &value)
	Operator to serialize the value to a stream.

Detailed Description

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.

Reprocessing Time is the duration from the start of the reprocessing action and until all processing of the new frame has finished. 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).

Reprocessing Time depends on the processing settings that are enabled, which capture engine that was used, the pixel sampling setting and the number of acquisitions used. Reprocessing Time also depends on the compute power of the compute device.

Note that for a frame that has been re-processed, the Acquisition Time and Capture Time refers to the originally captured frame. Only Reprocessing Time is updated in a reprocessed frame.

Member Typedef Documentation

ValueType

using Zivid::FrameInfo::Metrics::ReprocessingTime::ValueType = std::chrono::microseconds

The type of the underlying value.

Constructor & Destructor Documentation

ReprocessingTime() [1/2]

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

default

Default constructor.

ReprocessingTime() [2/2]

Zivid::FrameInfo::Metrics::ReprocessingTime::ReprocessingTime ( std::chrono::microseconds value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::FrameInfo::Metrics::ReprocessingTime::hasValue

(

)

const

Check if the value is set.

operator!=()

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

inline

Comparison operator.

operator<()

bool Zivid::FrameInfo::Metrics::ReprocessingTime::operator< ( const ReprocessingTime & other ) const

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

bool Zivid::FrameInfo::Metrics::ReprocessingTime::operator> ( const ReprocessingTime & other ) const

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

reset()

void Zivid::FrameInfo::Metrics::ReprocessingTime::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::FrameInfo::Metrics::ReprocessingTime::toString

(

)

const

Get the value as string.

validRange()

static constexpr Range< std::chrono::microseconds > Zivid::FrameInfo::Metrics::ReprocessingTime::validRange ( )

inlinestaticconstexpr

The range of valid values for ReprocessingTime.

value()

std::chrono::microseconds Zivid::FrameInfo::Metrics::ReprocessingTime::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< ReprocessingTime >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::FrameInfo::Metrics::ReprocessingTime::description

staticconstexpr

Initial value:

{
                    R"description(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.
 
Reprocessing Time is the duration from the start of the reprocessing action and until all processing
of the new frame has finished. 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).
 
Reprocessing Time depends on the processing settings that are enabled, which capture engine that was
used, the pixel sampling setting and the number of acquisitions used. Reprocessing Time also depends on
the compute power of the compute device.
 
Note that for a frame that has been re-processed, the Acquisition Time and Capture Time refers to
the originally captured frame. Only Reprocessing Time is updated in a reprocessed frame.
)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::FrameInfo::Metrics::ReprocessingTime::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/FrameInfo.h