Zivid::Settings::Processing::Color::Experimental::Mode Class Reference

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.

Detailed Description

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.

Member Enumeration Documentation

ValueType

enum class Zivid::Settings::Processing::Color::Experimental::Mode::ValueType

strong

The type of the underlying value.

Enumerator
automatic
useFirstAcquisition
toneMapping

Constructor & Destructor Documentation

Mode() [1/2]

Zivid::Settings::Processing::Color::Experimental::Mode::Mode ( )

default

Default constructor.

Mode() [2/2]

constexpr Zivid::Settings::Processing::Color::Experimental::Mode::Mode ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings::Processing::Color::Experimental::Mode::hasValue

(

)

const

Check if the value is set.

operator!=()

bool Zivid::Settings::Processing::Color::Experimental::Mode::operator!= ( const Mode & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Settings::Processing::Color::Experimental::Mode::operator== ( const Mode & other ) const

inline

Comparison operator.

reset()

void Zivid::Settings::Processing::Color::Experimental::Mode::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings::Processing::Color::Experimental::Mode::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::Settings::Processing::Color::Experimental::Mode::validValues ( )

inlinestatic

All valid values of Mode.

value()

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.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Mode >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

automatic

const Mode Zivid::Settings::Processing::Color::Experimental::Mode::automatic

static

automatic

description

constexpr const char* Zivid::Settings::Processing::Color::Experimental::Mode::description

staticconstexpr

Initial value:

{
                            R"description(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.
)description"
                        }

The description for this value.

name

constexpr const char* Zivid::Settings::Processing::Color::Experimental::Mode::name { "Mode" }

staticconstexpr

The name of this value.

nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Color::Experimental::Mode::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

constexpr const char* Zivid::Settings::Processing::Color::Experimental::Mode::path { "Processing/Color/Experimental/Mode" }

staticconstexpr

The full path for this value.

toneMapping

const Mode Zivid::Settings::Processing::Color::Experimental::Mode::toneMapping

static

toneMapping

useFirstAcquisition

const Mode Zivid::Settings::Processing::Color::Experimental::Mode::useFirstAcquisition

static

useFirstAcquisition

---

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

• Zivid/Settings.h