Zivid::SceneConditions::AmbientLight::FlickerClassification Class Reference

A classification of the detected ambient light flicker, if any. The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it did not match the characteristics of a standard power grid. More...

#include <Zivid/SceneConditions.h>

Public Types
enum class	ValueType { noFlicker , unknownFlicker , grid50hz , grid60hz }
	The type of the underlying value. More...

Public Member Functions
	FlickerClassification ()=default
	Default constructor.
constexpr	FlickerClassification (ValueType value)
	Constructor.
ValueType	value () const
	Get the value.
std::string	toString () const
	Get the value as string.
bool	operator== (const FlickerClassification &other) const
	Comparison operator.
bool	operator!= (const FlickerClassification &other) const
	Comparison operator.

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of FlickerClassification.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "AmbientLight/FlickerClassification" }
	The full path for this value.
static constexpr const char *	name { "FlickerClassification" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static const FlickerClassification	noFlicker
	noFlicker
static const FlickerClassification	unknownFlicker
	unknownFlicker
static const FlickerClassification	grid50hz
	grid50hz
static const FlickerClassification	grid60hz
	grid60hz

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

Detailed Description

A classification of the detected ambient light flicker, if any. The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it did not match the characteristics of a standard power grid.

Member Enumeration Documentation

ValueType

enum class Zivid::SceneConditions::AmbientLight::FlickerClassification::ValueType

strong

The type of the underlying value.

Enumerator
noFlicker
unknownFlicker
grid50hz
grid60hz

Constructor & Destructor Documentation

FlickerClassification() [1/2]

Zivid::SceneConditions::AmbientLight::FlickerClassification::FlickerClassification ( )

default

Default constructor.

FlickerClassification() [2/2]

Zivid::SceneConditions::AmbientLight::FlickerClassification::FlickerClassification ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::SceneConditions::AmbientLight::FlickerClassification::operator!= ( const FlickerClassification & other ) const

inline

Comparison operator.

operator==()

bool Zivid::SceneConditions::AmbientLight::FlickerClassification::operator== ( const FlickerClassification & other ) const

inline

Comparison operator.

toString()

std::string Zivid::SceneConditions::AmbientLight::FlickerClassification::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::SceneConditions::AmbientLight::FlickerClassification::validValues ( )

inlinestatic

All valid values of FlickerClassification.

value()

ValueType Zivid::SceneConditions::AmbientLight::FlickerClassification::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< FlickerClassification >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

description

const char* Zivid::SceneConditions::AmbientLight::FlickerClassification::description

staticconstexpr

Initial value:

{
                    R"description(A classification of the detected ambient light flicker, if any.
The values `grid50hz` and `grid60hz` indicate that ambient
light matching a 50 Hz or 60 Hz power grid was detected in the
scene. In those cases it is recommended to use Ambient Light
Adaptation for better point cloud quality. The value
`unknownFlicker` indicates that some significant time-varying
ambient light was detected, but it did not match the
characteristics of a standard power grid.
)description"
                }

The description for this value.

grid50hz

const FlickerClassification Zivid::SceneConditions::AmbientLight::FlickerClassification::grid50hz

static

grid50hz

grid60hz

const FlickerClassification Zivid::SceneConditions::AmbientLight::FlickerClassification::grid60hz

static

grid60hz

name

const char* Zivid::SceneConditions::AmbientLight::FlickerClassification::name { "FlickerClassification" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::SceneConditions::AmbientLight::FlickerClassification::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

noFlicker

const FlickerClassification Zivid::SceneConditions::AmbientLight::FlickerClassification::noFlicker

static

noFlicker

path

const char* Zivid::SceneConditions::AmbientLight::FlickerClassification::path { "AmbientLight/FlickerClassification" }

staticconstexpr

The full path for this value.

unknownFlicker

const FlickerClassification Zivid::SceneConditions::AmbientLight::FlickerClassification::unknownFlicker

static

unknownFlicker

---

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

• Zivid/SceneConditions.h