Zivid C++ API 2.13.1+18e79e79-1
|
This setting controls how the color image is computed. More...
#include <Zivid/Settings.h>
Public Types | |
enum class | ValueType { automatic , useFirstAcquisition , toneMapping } |
The type of the underlying value. More... | |
Public Member Functions | |
Mode ()=default | |
Default constructor. | |
constexpr | Mode (ValueType value) |
Constructor. | |
ValueType | 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 Mode &other) const |
Comparison operator. | |
bool | operator!= (const Mode &other) const |
Comparison operator. | |
Static Public Member Functions | |
static std::set< ValueType > | validValues () |
All valid values of Mode. | |
Static Public Attributes | |
static constexpr DataModel::NodeType | nodeType = DataModel::NodeType::leafValue |
The type of this node. | |
static constexpr const char * | path { "Processing/Color/Experimental/Mode" } |
The full path for this value. | |
static constexpr const char * | name { "Mode" } |
The name of this value. | |
static constexpr const char * | description |
The description for this value. | |
static const Mode | automatic |
automatic | |
static const Mode | useFirstAcquisition |
useFirstAcquisition | |
static const Mode | toneMapping |
toneMapping | |
Friends | |
struct | DataModel::Detail::Befriend< Mode > |
std::ostream & | operator<< (std::ostream &stream, const Mode::ValueType &value) |
Operator to serialize ValueType to a stream. | |
std::ostream & | operator<< (std::ostream &stream, const Mode &value) |
Operator to serialize the value to a stream. | |
This setting controls how the color image is computed.
automatic
is the default option. automatic
is identical to useFirstAcquisition
for single-acquisition captures and multi-acquisition captures when all the acquisitions have identical (duplicated) acquisition settings. automatic
is identical to toneMapping
for multi-acquisition HDR captures with differing acquisition settings.
useFirstAcquisition
uses the color data acquired from the first acquisition provided. If the capture consists of more than one acquisition, then the remaining acquisitions are not used for the color image. No tone mapping is performed. This option provides the most control of the color image, and the color values will be consistent over repeated captures with the same settings.
toneMapping
uses all the acquisitions to create one merged and normalized color image. For HDR captures the dynamic range of the captured images is usually higher than the 8-bit color image range. toneMapping
will map the HDR color data to the 8-bit color output range by applying a scaling factor. toneMapping
can also be used for single-acquisition captures to normalize the captured color image to the full 8-bit output. Note that when using toneMapping
mode the color values can be inconsistent over repeated captures if you move, add or remove objects in the scene. For the most control over the colors, select the useFirstAcquisition
mode.
|
strong |
|
default |
Default constructor.
|
inlineexplicitconstexpr |
Constructor.
bool Zivid::Settings::Processing::Color::Experimental::Mode::hasValue | ( | ) | const |
Check if the value is set.
|
inline |
Comparison operator.
|
inline |
Comparison operator.
void Zivid::Settings::Processing::Color::Experimental::Mode::reset | ( | ) |
Reset the node to unset state.
std::string Zivid::Settings::Processing::Color::Experimental::Mode::toString | ( | ) | const |
Get the value as string.
|
inlinestatic |
All valid values of Mode.
ValueType Zivid::Settings::Processing::Color::Experimental::Mode::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.
|
friend |
Operator to serialize ValueType to a stream.
|
static |
automatic
|
staticconstexpr |
The description for this value.
|
staticconstexpr |
The name of this value.
|
staticconstexpr |
The type of this node.
|
staticconstexpr |
The full path for this value.
|
static |
toneMapping
|
static |
useFirstAcquisition