Zivid C++ API  2.4.0+a330c1a6-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled Class Reference

This setting controls when tone mapping of colors is performed. Tone mapping will normalize the captured color image to the full available output range by applying a gain factor to the colors. For single-captures this can be used do brighten dark images. For HDR captures this is required to map high-dynamic-range colors to the more limited dynamic range output. More...

#include <Zivid/Settings.h>

Public Types

enum class  ValueType { always , hdrOnly }
 The type of the underlying value More...
 

Public Member Functions

 Enabled ()=default
 Default constructor More...
 
constexpr Enabled (ValueType value)
 Constructor More...
 
ValueType value () const
 Get the value More...
 
bool hasValue () const
 Check if the value is set More...
 
void reset ()
 Reset the node to unset state More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const Enabled &other) const
 Comparison operator More...
 
bool operator!= (const Enabled &other) const
 Comparison operator More...
 

Static Public Member Functions

static std::set< ValueTypevalidValues ()
 All valid values of Enabled More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path { "Processing/Color/Experimental/ToneMapping/Enabled" }
 The full path for this value More...
 
static constexpr const char * name { "Enabled" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 
static const Enabled always
 always More...
 
static const Enabled hdrOnly
 hdrOnly More...
 

Friends

struct DataModel::Detail::Befriend< Enabled >
 
std::ostream & operator<< (std::ostream &stream, const Enabled::ValueType &value)
 Operator to serialize ValueType to a stream More...
 
std::ostream & operator<< (std::ostream &stream, const Enabled &value)
 Operator to serialize the value to a stream More...
 

Detailed Description

This setting controls when tone mapping of colors is performed. Tone mapping will normalize the captured color image to the full available output range by applying a gain factor to the colors. For single-captures this can be used do brighten dark images. For HDR captures this is required to map high-dynamic-range colors to the more limited dynamic range output.

This setting has two possible values. Always will perform tone-mapping for all captures. HdrOnly will perform tone mapping for HDR captures but not for single-captures. It is not possible to disable tone mapping for HDR captures.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value

Enumerator
always 
hdrOnly 

Constructor & Destructor Documentation

◆ Enabled() [1/2]

Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::Enabled ( )
default

Default constructor

◆ Enabled() [2/2]

constexpr Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::Enabled ( ValueType  value)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ hasValue()

bool Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::hasValue ( ) const

Check if the value is set

◆ operator!=()

bool Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::operator!= ( const Enabled other) const
inline

Comparison operator

◆ operator==()

bool Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::operator== ( const Enabled other) const
inline

Comparison operator

◆ reset()

void Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::reset ( )

Reset the node to unset state

◆ toString()

std::string Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::toString ( ) const

Get the value as string

◆ validValues()

static std::set<ValueType> Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::validValues ( )
inlinestatic

All valid values of Enabled

◆ value()

ValueType Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::value ( ) const

Get the value

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Enabled >

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

◆ operator<< [1/2]

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

Operator to serialize the value to a stream

◆ operator<< [2/2]

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

Operator to serialize ValueType to a stream

Member Data Documentation

◆ always

const Enabled Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::always
static

always

◆ description

constexpr const char* Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::description
staticconstexpr
Initial value:
{
R"description(This setting controls when tone mapping of colors is performed. Tone mapping will normalize
the captured color image to the full available output range by applying a gain factor to the
colors. For single-captures this can be used do brighten dark images. For HDR captures this
is required to map high-dynamic-range colors to the more limited dynamic range output.
This setting has two possible values. `Always` will perform tone-mapping for all captures.
`HdrOnly` will perform tone mapping for HDR captures but not for single-captures. It is not
possible to disable tone mapping for HDR captures.
)description"
}

The description for this value

◆ hdrOnly

const Enabled Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::hdrOnly
static

hdrOnly

◆ name

constexpr const char* Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::name { "Enabled" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings::Processing::Color::Experimental::ToneMapping::Enabled::path { "Processing/Color/Experimental/ToneMapping/Enabled" }
staticconstexpr

The full path for this value


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