Zivid
1.0.0+3593.8aa835e3
Zivid API
|
Settings for a Zivid camera More...
#include <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 in the light output from the projector More... | |
class | ExposureTime |
Exposure time for each single image in the measurement. More... | |
class | Filters |
Toggle on or off various filters More... | |
class | Iris |
Iris (aperture) setting for the camera More... | |
class | RedBalance |
White balance of red channel in the camera More... | |
Public Member Functions | |
Settings () | |
Constructor More... | |
~Settings () | |
Destructor More... | |
Settings (const Settings &other) | |
Copy constructor More... | |
Settings & | operator= (const Settings &other) |
Assignment operator More... | |
Settings (Settings &&other) noexcept | |
Move constructor More... | |
Settings & | operator= (Settings &&other) noexcept |
Move assignment operator More... | |
Settings (const std::string &fileName) | |
Construct object by loading from file 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... | |
Settings & | set (const BlueBalance &value) |
Set BlueBalance More... | |
const BlueBalance & | blueBalance () const |
Get BlueBalance More... | |
Settings & | set (const RedBalance &value) |
Set RedBalance More... | |
const RedBalance & | redBalance () const |
Get RedBalance More... | |
Settings & | set (const ExposureTime &value) |
Set ExposureTime More... | |
const ExposureTime & | exposureTime () const |
Get ExposureTime More... | |
Settings & | set (const Iris &value) |
Set Iris More... | |
const Iris & | iris () const |
Get Iris More... | |
Settings & | set (const Brightness &value) |
Set Brightness More... | |
const Brightness & | brightness () const |
Get Brightness More... | |
Settings & | set (const Bidirectional &value) |
Set Bidirectional More... | |
const Bidirectional & | bidirectional () const |
Get Bidirectional More... | |
Settings & | set (const Filters &value) |
Set Filters More... | |
const Filters & | filters () const |
Get Filters More... | |
Settings & | set (const Filters::Contrast &value) |
Set Filters::Contrast More... | |
Settings & | set (const Filters::Contrast::Threshold &value) |
Set Filters::Contrast::Threshold More... | |
Settings & | set (const Filters::Outlier &value) |
Set Filters::Outlier More... | |
Settings & | set (const Filters::Outlier::Enabled &value) |
Set Filters::Outlier::Enabled More... | |
Settings & | set (const Filters::Outlier::Threshold &value) |
Set Filters::Outlier::Threshold More... | |
Settings & | set (const Filters::Saturated &value) |
Set Filters::Saturated More... | |
Settings & | set (const Filters::Saturated::Enabled &value) |
Set Filters::Saturated::Enabled More... | |
Settings & | set (const Filters::Reflection &value) |
Set Filters::Reflection More... | |
Settings & | set (const Filters::Reflection::Enabled &value) |
Set Filters::Reflection::Enabled 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 | save (const std::string &fileName) const |
Save to the given file More... | |
void | setFromString (const std::string &value) |
Set from the given string More... | |
void | load (const std::string &fileName) |
Load from the given file More... | |
bool | operator== (const Settings &other) const |
Equality operator More... | |
bool | operator!= (const Settings &other) const |
Inequality operator More... | |
Static Public Attributes | |
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... | |
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... | |
Settings for a Zivid camera
Zivid::Settings::Settings | ( | ) |
Constructor
Zivid::Settings::~Settings | ( | ) |
Destructor
Zivid::Settings::Settings | ( | const Settings & | other | ) |
Copy constructor
|
noexcept |
Move constructor
|
explicit |
Construct object by loading from file
|
inline |
Get Bidirectional
|
inline |
Get BlueBalance
|
inline |
Get Brightness
|
inline |
Get ExposureTime
|
inline |
Run the given function on each direct member with the value of the member as parameter
|
inline |
Run the given function on each direct member with the value of the member as parameter
std::string Zivid::Settings::getString | ( | const std::string & | fullPath | ) | const |
Get a value as string by specifying the path
void Zivid::Settings::load | ( | const std::string & | fileName | ) |
Load from the given file
bool Zivid::Settings::operator!= | ( | const Settings & | other | ) | const |
Inequality operator
bool Zivid::Settings::operator== | ( | const Settings & | other | ) | const |
Equality operator
|
inline |
Get RedBalance
void Zivid::Settings::save | ( | const std::string & | fileName | ) | const |
Save to the given file
void Zivid::Settings::set | ( | const std::string & | fullPath, |
const std::string & | value | ||
) |
Set a value from string by specifying the path
|
inline |
Set BlueBalance
|
inline |
Set RedBalance
|
inline |
Set ExposureTime
|
inline |
Set Brightness
|
inline |
Set Bidirectional
|
inline |
|
inline |
|
inline |
Set Filters::Outlier
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
void Zivid::Settings::setFromString | ( | const std::string & | value | ) |
Set from the given string
std::string Zivid::Settings::toString | ( | ) | const |
Get the value as string
|
inline |
Traverse the entire tree using the given function with the value of the member as parameter
|
inline |
Traverse all members using the given function with the value of the member as parameter
|
friend |
Operator to send the value as string to a stream
|
friend |
Operator to set the value from a stream
|
static |
Whether this node contains child values
|
static |
The name of this value
|
static |
The full path for this value