![]() |
Zivid C++ API 2.11.1+de9b5dae-1
|
Brightness controls the light output from the projector. More...
#include <Zivid/Settings.h>
Public Types | |
using | ValueType = double |
The type of the underlying value. | |
Public Member Functions | |
Brightness ()=default | |
Default constructor. | |
constexpr | Brightness (double value) |
Constructor. | |
double | 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 Brightness &other) const |
Comparison operator. | |
bool | operator!= (const Brightness &other) const |
Comparison operator. | |
bool | operator< (const Brightness &other) const |
Comparison operator. | |
bool | operator> (const Brightness &other) const |
Comparison operator. | |
bool | operator<= (const Brightness &other) const |
Comparison operator. | |
bool | operator>= (const Brightness &other) const |
Comparison operator. | |
Static Public Member Functions | |
static constexpr Range< double > | validRange () |
The range of valid values for Brightness. | |
Static Public Attributes | |
static constexpr DataModel::NodeType | nodeType = DataModel::NodeType::leafValue |
The type of this node. | |
static constexpr const char * | path { "Acquisition/Brightness" } |
The full path for this value. | |
static constexpr const char * | name { "Brightness" } |
The name of this value. | |
static constexpr const char * | description |
The description for this value. | |
Friends | |
struct | DataModel::Detail::Befriend< Brightness > |
std::ostream & | operator<< (std::ostream &stream, const Brightness &value) |
Operator to serialize the value to a stream. | |
Brightness controls the light output from the projector.
Brightness above 1.0 may be needed when the distance between the camera and the scene is large, or in case of high levels of ambient lighting.
When brightness is above 1.0 the duty cycle of the camera (the percentage of time the camera can capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculated over a 10 second period. This limitation is enforced automatically by the camera. Calling capture when the duty cycle limit has been reached will cause the camera to first wait (sleep) for a duration of time to cool down, before capture will start.
The type of the underlying value.
|
default |
Default constructor.
|
inlineexplicitconstexpr |
Constructor.
bool Zivid::Settings::Acquisition::Brightness::hasValue | ( | ) | const |
Check if the value is set.
|
inline |
Comparison operator.
|
inline |
Comparison operator.
|
inline |
Comparison operator.
|
inline |
Comparison operator.
|
inline |
Comparison operator.
|
inline |
Comparison operator.
void Zivid::Settings::Acquisition::Brightness::reset | ( | ) |
Reset the node to unset state.
std::string Zivid::Settings::Acquisition::Brightness::toString | ( | ) | const |
Get the value as string.
|
inlinestaticconstexpr |
The range of valid values for Brightness.
double Zivid::Settings::Acquisition::Brightness::value | ( | ) | const |
Get the value.
If this object does not contain a value (see hasValue) then this method throws an exception.
|
friend |
|
friend |
Operator to serialize the value to a stream.
The description for this value.
|
staticconstexpr |
The name of this value.
|
staticconstexpr |
The type of this node.
|
staticconstexpr |
The full path for this value.