Zivid C++ API 2.13.1+18e79e79-1
Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency Class Reference

Adapt suggested settings to the ambient light frequency. This can be used to avoid artifacts in the point cloud due to AC powered ambient light being mixed in with the camera's projector light. More...

#include <Zivid/CaptureAssistant/SuggestSettingsParameters.h>

Public Types

enum class  ValueType { none , hz50 , hz60 }
 The type of the underlying value. More...
 

Public Member Functions

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

Static Public Member Functions

static std::set< ValueTypevalidValues ()
 All valid values of AmbientLightFrequency.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "AmbientLightFrequency" }
 The full path for this value.
 
static constexpr const char * name { "AmbientLightFrequency" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 
static const AmbientLightFrequency none
 none
 
static const AmbientLightFrequency hz50
 hz50
 
static const AmbientLightFrequency hz60
 hz60
 

Friends

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

Detailed Description

Adapt suggested settings to the ambient light frequency. This can be used to avoid artifacts in the point cloud due to AC powered ambient light being mixed in with the camera's projector light.

Select your power grid frequency. 60 Hz is typically used in Japan, Americas, Taiwan, South Korea, and the Philippines. 50 Hz is the normal in rest of the world. If ambient light is unproblematic, turn off for optimal performance.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value.

Enumerator
none 
hz50 
hz60 

Constructor & Destructor Documentation

◆ AmbientLightFrequency() [1/2]

Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::AmbientLightFrequency ( )
default

Default constructor.

◆ AmbientLightFrequency() [2/2]

Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::AmbientLightFrequency ( ValueType value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::operator!= ( const AmbientLightFrequency & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::operator== ( const AmbientLightFrequency & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::toString ( ) const

Get the value as string.

◆ validValues()

static std::set< ValueType > Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::validValues ( )
inlinestatic

All valid values of AmbientLightFrequency.

◆ value()

ValueType Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< AmbientLightFrequency >

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

◆ operator<< [1/2]

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

Operator to serialize the value to a stream.

◆ operator<< [2/2]

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

Operator to serialize ValueType to a stream.

Member Data Documentation

◆ description

const char* Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::description
staticconstexpr
Initial value:
{
R"description(Adapt suggested settings to the ambient light frequency. This can be used to avoid artifacts in the point
cloud due to AC powered ambient light being mixed in with the camera's projector light.
Select your power grid frequency. 60 Hz is typically used in Japan, Americas, Taiwan, South Korea, and the
Philippines. 50 Hz is the normal in rest of the world. If ambient light is unproblematic, turn off for
optimal performance.
)description"
}

The description for this value.

◆ hz50

const AmbientLightFrequency Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::hz50
static

hz50

◆ hz60

const AmbientLightFrequency Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::hz60
static

hz60

◆ name

const char* Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::name { "AmbientLightFrequency" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ none

const AmbientLightFrequency Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::none
static

none

◆ path

const char* Zivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency::path { "AmbientLightFrequency" }
staticconstexpr

The full path for this value.


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