Zivid C++ API  1.5.0+63f281e2-26
Defining the Future of 3D Machine Vision
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings Class Reference

Settings for a Zivid camera More...

#include <Zivid/Settings.h>

Classes

class  Bidirectional
 Enable or disable the use of bi-directional patterns (requires twice as many patterns as well as increased exposure time) More...
 
class  BlueBalance
 White balance of blue channel in the camera More...
 
class  Brightness
 Brightness controls the light output from the projector. More...
 
class  ExposureTime
 Exposure time for each single image in the measurement. Affects frame rate. More...
 
class  Filters
 Collection of filters More...
 
class  Gain
 Analog gain in the camera More...
 
class  Iris
 Iris (aperture) setting for the camera More...
 
class  RedBalance
 White balance of red channel in the camera More...
 
struct  Version
 
struct  Version< 3 >
 

Public Member Functions

 ~Settings ()
 Destructor More...
 
 Settings (const Settings &other)
 Copy constructor More...
 
Settingsoperator= (const Settings &other)
 Assignment operator More...
 
 Settings (Settings &&other) noexcept
 Move constructor More...
 
Settingsoperator= (Settings &&other) noexcept
 Move assignment operator More...
 
 Settings ()=default
 Default constructor More...
 
void set (const std::string &fullPath, const std::string &value)
 Set a value from string by specifying the path More...
 
std::string getString (const std::string &fullPath) const
 Get a value as string by specifying the path More...
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Bidirectional >::value, int >::type = 0>
const Settings::Bidirectionalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::BlueBalance >::value, int >::type = 0>
const Settings::BlueBalanceget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Brightness >::value, int >::type = 0>
const Settings::Brightnessget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::ExposureTime >::value, int >::type = 0>
const Settings::ExposureTimeget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters >::value, int >::type = 0>
const Settings::Filtersget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast >::value, int >::type = 0>
const Settings::Filters::Contrastget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast::Enabled >::value, int >::type = 0>
const Settings::Filters::Contrast::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast::Threshold >::value, int >::type = 0>
const Settings::Filters::Contrast::Thresholdget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian >::value, int >::type = 0>
const Settings::Filters::Gaussianget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Filters::Gaussian::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Filters::Gaussian::Sigmaget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Outlier >::value, int >::type = 0>
const Settings::Filters::Outlierget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Outlier::Enabled >::value, int >::type = 0>
const Settings::Filters::Outlier::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Outlier::Threshold >::value, int >::type = 0>
const Settings::Filters::Outlier::Thresholdget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Reflection >::value, int >::type = 0>
const Settings::Filters::Reflectionget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Reflection::Enabled >::value, int >::type = 0>
const Settings::Filters::Reflection::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Saturated >::value, int >::type = 0>
const Settings::Filters::Saturatedget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Saturated::Enabled >::value, int >::type = 0>
const Settings::Filters::Saturated::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Gain >::value, int >::type = 0>
const Settings::Gainget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Iris >::value, int >::type = 0>
const Settings::Irisget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::RedBalance >::value, int >::type = 0>
const Settings::RedBalanceget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Bidirectionalget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::BlueBalanceget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Brightnessget () const
 
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::ExposureTimeget () const
 
template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const Settings::Filtersget () const
 
template<size_t i, typename std::enable_if< i==5, int >::type = 0>
const Settings::Gainget () const
 
template<size_t i, typename std::enable_if< i==6, int >::type = 0>
const Settings::Irisget () const
 
template<size_t i, typename std::enable_if< i==7, int >::type = 0>
const Settings::RedBalanceget () const
 
 Settings (const Bidirectional &bidirectional, const BlueBalance &blueBalance, const Brightness &brightness, const ExposureTime &exposureTime, const Filters &filters, const Gain &gain, const Iris &iris, const RedBalance &redBalance)
 Constructor More...
 
Settingsset (const Bidirectional &value)
 Set Bidirectional More...
 
const Bidirectionalbidirectional () const
 Get Bidirectional More...
 
Settingsset (const BlueBalance &value)
 Set BlueBalance More...
 
const BlueBalanceblueBalance () const
 Get BlueBalance More...
 
Settingsset (const Brightness &value)
 Set Brightness More...
 
const Brightnessbrightness () const
 Get Brightness More...
 
Settingsset (const ExposureTime &value)
 Set ExposureTime More...
 
const ExposureTimeexposureTime () const
 Get ExposureTime More...
 
Settingsset (const Filters &value)
 Set Filters More...
 
const Filtersfilters () const
 Get Filters More...
 
Settingsset (const Filters::Contrast &value)
 Set Filters::Contrast More...
 
Settingsset (const Filters::Contrast::Enabled &value)
 Set Filters::Contrast::Enabled More...
 
Settingsset (const Filters::Contrast::Threshold &value)
 Set Filters::Contrast::Threshold More...
 
Settingsset (const Filters::Gaussian &value)
 Set Filters::Gaussian More...
 
Settingsset (const Filters::Gaussian::Enabled &value)
 Set Filters::Gaussian::Enabled More...
 
Settingsset (const Filters::Gaussian::Sigma &value)
 Set Filters::Gaussian::Sigma More...
 
Settingsset (const Filters::Outlier &value)
 Set Filters::Outlier More...
 
Settingsset (const Filters::Outlier::Enabled &value)
 Set Filters::Outlier::Enabled More...
 
Settingsset (const Filters::Outlier::Threshold &value)
 Set Filters::Outlier::Threshold More...
 
Settingsset (const Filters::Reflection &value)
 Set Filters::Reflection More...
 
Settingsset (const Filters::Reflection::Enabled &value)
 Set Filters::Reflection::Enabled More...
 
Settingsset (const Filters::Saturated &value)
 Set Filters::Saturated More...
 
Settingsset (const Filters::Saturated::Enabled &value)
 Set Filters::Saturated::Enabled More...
 
Settingsset (const Gain &value)
 Set Gain More...
 
const Gaingain () const
 Get Gain More...
 
Settingsset (const Iris &value)
 Set Iris More...
 
const Irisiris () const
 Get Iris More...
 
Settingsset (const RedBalance &value)
 Set RedBalance More...
 
const RedBalanceredBalance () const
 Get RedBalance More...
 
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 More...
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter More...
 
template<typename F >
void traverseValues (const F &f) const
 Traverse the entire tree using the given function with the value of the member as parameter More...
 
template<typename F >
void traverseValues (const F &f)
 Traverse all members using the given function with the value of the member as parameter More...
 
std::string toString () const
 Get the value as string More...
 
void setFromString (const std::string &value)
 Set from the given string More...
 
bool operator== (const Settings &other) const
 Equality operator More...
 
bool operator!= (const Settings &other) const
 Inequality operator More...
 
 Settings (const std::string &fileName)
 Construct object by loading from file More...
 
void save (const std::string &fileName) const
 Save to the given file More...
 
void load (const std::string &fileName)
 Load from the given file More...
 

Static Public Attributes

static constexpr size_t version { 3 }
 
static constexpr bool isContainer { true }
 Whether this node contains child values More...
 
static constexpr const char * path { "" }
 The full path for this value More...
 
static constexpr const char * name { "Settings" }
 The name of this value More...
 
static constexpr const char * description { R"description(Settings for a Zivid camera)description" }
 The description for this value More...
 

Friends

std::ostream & operator<< (std::ostream &stream, const Settings &value)
 Operator to send the value as string to a stream More...
 
std::istream & operator>> (std::istream &stream, Settings &value)
 Operator to set the value from a stream More...
 

Detailed Description

Settings for a Zivid camera

Constructor & Destructor Documentation

◆ ~Settings()

Zivid::Settings::~Settings ( )

Destructor

◆ Settings() [1/5]

Zivid::Settings::Settings ( const Settings other)

Copy constructor

◆ Settings() [2/5]

Zivid::Settings::Settings ( Settings &&  other)
noexcept

Move constructor

◆ Settings() [3/5]

Zivid::Settings::Settings ( )
default

Default constructor

◆ Settings() [4/5]

Zivid::Settings::Settings ( const Bidirectional bidirectional,
const BlueBalance blueBalance,
const Brightness brightness,
const ExposureTime exposureTime,
const Filters filters,
const Gain gain,
const Iris iris,
const RedBalance redBalance 
)
explicit

Constructor

◆ Settings() [5/5]

Zivid::Settings::Settings ( const std::string &  fileName)
explicit

Construct object by loading from file

Member Function Documentation

◆ bidirectional()

const Bidirectional& Zivid::Settings::bidirectional ( ) const
inline

◆ blueBalance()

const BlueBalance& Zivid::Settings::blueBalance ( ) const
inline

◆ brightness()

const Brightness& Zivid::Settings::brightness ( ) const
inline

◆ exposureTime()

const ExposureTime& Zivid::Settings::exposureTime ( ) const
inline

◆ filters()

const Filters& Zivid::Settings::filters ( ) const
inline

Get Filters

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::forEach ( const F &  f) const
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::Settings::forEach ( const F &  f)
inline

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

◆ gain()

const Gain& Zivid::Settings::gain ( ) const
inline

Get Gain

◆ get() [1/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Bidirectional >::value, int >::type = 0>
const Settings::Bidirectional& Zivid::Settings::get ( ) const
inline

◆ get() [2/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::BlueBalance >::value, int >::type = 0>
const Settings::BlueBalance& Zivid::Settings::get ( ) const
inline

◆ get() [3/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Brightness >::value, int >::type = 0>
const Settings::Brightness& Zivid::Settings::get ( ) const
inline

◆ get() [4/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::ExposureTime >::value, int >::type = 0>
const Settings::ExposureTime& Zivid::Settings::get ( ) const
inline

◆ get() [5/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters >::value, int >::type = 0>
const Settings::Filters& Zivid::Settings::get ( ) const
inline

◆ get() [6/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast >::value, int >::type = 0>
const Settings::Filters::Contrast& Zivid::Settings::get ( ) const
inline

◆ get() [7/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast::Enabled >::value, int >::type = 0>
const Settings::Filters::Contrast::Enabled& Zivid::Settings::get ( ) const
inline

◆ get() [8/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast::Threshold >::value, int >::type = 0>
const Settings::Filters::Contrast::Threshold& Zivid::Settings::get ( ) const
inline

◆ get() [9/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian >::value, int >::type = 0>
const Settings::Filters::Gaussian& Zivid::Settings::get ( ) const
inline

◆ get() [10/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Filters::Gaussian::Enabled& Zivid::Settings::get ( ) const
inline

◆ get() [11/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Filters::Gaussian::Sigma& Zivid::Settings::get ( ) const
inline

◆ get() [12/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Outlier >::value, int >::type = 0>
const Settings::Filters::Outlier& Zivid::Settings::get ( ) const
inline

◆ get() [13/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Outlier::Enabled >::value, int >::type = 0>
const Settings::Filters::Outlier::Enabled& Zivid::Settings::get ( ) const
inline

◆ get() [14/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Outlier::Threshold >::value, int >::type = 0>
const Settings::Filters::Outlier::Threshold& Zivid::Settings::get ( ) const
inline

◆ get() [15/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Reflection >::value, int >::type = 0>
const Settings::Filters::Reflection& Zivid::Settings::get ( ) const
inline

◆ get() [16/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Reflection::Enabled >::value, int >::type = 0>
const Settings::Filters::Reflection::Enabled& Zivid::Settings::get ( ) const
inline

◆ get() [17/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Saturated >::value, int >::type = 0>
const Settings::Filters::Saturated& Zivid::Settings::get ( ) const
inline

◆ get() [18/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Saturated::Enabled >::value, int >::type = 0>
const Settings::Filters::Saturated::Enabled& Zivid::Settings::get ( ) const
inline

◆ get() [19/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Gain >::value, int >::type = 0>
const Settings::Gain& Zivid::Settings::get ( ) const
inline

◆ get() [20/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Iris >::value, int >::type = 0>
const Settings::Iris& Zivid::Settings::get ( ) const
inline

◆ get() [21/29]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RedBalance >::value, int >::type = 0>
const Settings::RedBalance& Zivid::Settings::get ( ) const
inline

◆ get() [22/29]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Bidirectional& Zivid::Settings::get ( ) const
inline

◆ get() [23/29]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::BlueBalance& Zivid::Settings::get ( ) const
inline

◆ get() [24/29]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Brightness& Zivid::Settings::get ( ) const
inline

◆ get() [25/29]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::ExposureTime& Zivid::Settings::get ( ) const
inline

◆ get() [26/29]

template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const Settings::Filters& Zivid::Settings::get ( ) const
inline

◆ get() [27/29]

template<size_t i, typename std::enable_if< i==5, int >::type = 0>
const Settings::Gain& Zivid::Settings::get ( ) const
inline

◆ get() [28/29]

template<size_t i, typename std::enable_if< i==6, int >::type = 0>
const Settings::Iris& Zivid::Settings::get ( ) const
inline

◆ get() [29/29]

template<size_t i, typename std::enable_if< i==7, int >::type = 0>
const Settings::RedBalance& Zivid::Settings::get ( ) const
inline

◆ getString()

std::string Zivid::Settings::getString ( const std::string &  fullPath) const

Get a value as string by specifying the path

◆ iris()

const Iris& Zivid::Settings::iris ( ) const
inline

Get Iris

◆ load()

void Zivid::Settings::load ( const std::string &  fileName)

Load from the given file

◆ operator!=()

bool Zivid::Settings::operator!= ( const Settings other) const

Inequality operator

◆ operator=() [1/2]

Settings& Zivid::Settings::operator= ( const Settings other)

Assignment operator

◆ operator=() [2/2]

Settings& Zivid::Settings::operator= ( Settings &&  other)
noexcept

Move assignment operator

◆ operator==()

bool Zivid::Settings::operator== ( const Settings other) const

Equality operator

◆ redBalance()

const RedBalance& Zivid::Settings::redBalance ( ) const
inline

◆ save()

void Zivid::Settings::save ( const std::string &  fileName) const

Save to the given file

◆ set() [1/22]

void Zivid::Settings::set ( const std::string &  fullPath,
const std::string &  value 
)

Set a value from string by specifying the path

◆ set() [2/22]

Settings& Zivid::Settings::set ( const Bidirectional value)
inline

◆ set() [3/22]

Settings& Zivid::Settings::set ( const BlueBalance value)
inline

◆ set() [4/22]

Settings& Zivid::Settings::set ( const Brightness value)
inline

◆ set() [5/22]

Settings& Zivid::Settings::set ( const ExposureTime value)
inline

◆ set() [6/22]

Settings& Zivid::Settings::set ( const Filters value)
inline

Set Filters

◆ set() [7/22]

Settings& Zivid::Settings::set ( const Filters::Contrast value)
inline

◆ set() [8/22]

Settings& Zivid::Settings::set ( const Filters::Contrast::Enabled value)
inline

◆ set() [9/22]

Settings& Zivid::Settings::set ( const Filters::Contrast::Threshold value)
inline

◆ set() [10/22]

Settings& Zivid::Settings::set ( const Filters::Gaussian value)
inline

◆ set() [11/22]

Settings& Zivid::Settings::set ( const Filters::Gaussian::Enabled value)
inline

◆ set() [12/22]

Settings& Zivid::Settings::set ( const Filters::Gaussian::Sigma value)
inline

◆ set() [13/22]

Settings& Zivid::Settings::set ( const Filters::Outlier value)
inline

◆ set() [14/22]

Settings& Zivid::Settings::set ( const Filters::Outlier::Enabled value)
inline

◆ set() [15/22]

Settings& Zivid::Settings::set ( const Filters::Outlier::Threshold value)
inline

◆ set() [16/22]

Settings& Zivid::Settings::set ( const Filters::Reflection value)
inline

◆ set() [17/22]

Settings& Zivid::Settings::set ( const Filters::Reflection::Enabled value)
inline

◆ set() [18/22]

Settings& Zivid::Settings::set ( const Filters::Saturated value)
inline

◆ set() [19/22]

Settings& Zivid::Settings::set ( const Filters::Saturated::Enabled value)
inline

◆ set() [20/22]

Settings& Zivid::Settings::set ( const Gain value)
inline

Set Gain

◆ set() [21/22]

Settings& Zivid::Settings::set ( const Iris value)
inline

Set Iris

◆ set() [22/22]

Settings& Zivid::Settings::set ( const RedBalance value)
inline

◆ setFromString()

void Zivid::Settings::setFromString ( const std::string &  value)

Set from the given string

◆ toString()

std::string Zivid::Settings::toString ( ) const

Get the value as string

◆ traverseValues() [1/2]

template<typename F >
void Zivid::Settings::traverseValues ( const F &  f) const
inline

Traverse the entire tree using the given function with the value of the member as parameter

◆ traverseValues() [2/2]

template<typename F >
void Zivid::Settings::traverseValues ( const F &  f)
inline

Traverse all members using the given function with the value of the member as parameter

Friends And Related Function Documentation

◆ operator<<

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

Operator to send the value as string to a stream

◆ operator>>

std::istream& operator>> ( std::istream &  stream,
Settings value 
)
friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::description { R"description(Settings for a Zivid camera)description" }
static

The description for this value

◆ isContainer

constexpr bool Zivid::Settings::isContainer { true }
static

Whether this node contains child values

◆ name

constexpr const char* Zivid::Settings::name { "Settings" }
static

The name of this value

◆ path

constexpr const char* Zivid::Settings::path { "" }
static

The full path for this value

◆ version

constexpr size_t Zivid::Settings::version { 3 }
static

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