Correction. More...

#include <Zivid/Settings.h>

Classes
class	Enabled
	Enabled. More...

class	Strength
	Higher values gives more correction. More...

Public Types
using	Descendants = std::tuple< Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >

Public Member Functions
	Correction ()
	Default constructor.

template<typename... Args>
	Correction (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
Correction	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const Enabled &	isEnabled () const
	Get Enabled.

Enabled &	isEnabled ()
	Get Enabled.

Correction &	set (const Enabled &value)
	Set Enabled.

const Strength &	strength () const
	Get Strength.

Strength &	strength ()
	Get Strength.

Correction &	set (const Strength &value)
	Set Strength.

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &	get () const

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.

template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.

bool	operator== (const Correction &other) const
	Equality operator.

bool	operator!= (const Correction &other) const
	Inequality operator.

std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.

static constexpr const char *	path
	The full path for this value.

static constexpr const char *	name { "Correction" }
	The name of this value.

static constexpr const char *	description { R"description(Correction)description" }
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Correction >

std::ostream &	operator<< (std::ostream &stream, const Correction &value)
	Operator to send the value as string to a stream.

Detailed Description

Correction.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Descendants = std::tuple< Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength>

Constructor & Destructor Documentation

◆ Correction() [1/2]

Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Correction ( )

Default constructor.

◆ Correction() [2/2]

template<typename... Args>

Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Correction ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Correction then invoking set(args).

The provided arguments must be descendants of Correction. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>

Correction Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Correction object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Correction. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F >

void Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/4]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::get ( ) const

inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::get ( ) const

inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::get ( ) const

inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::get ( ) const

inline

◆ isEnabled() [1/2]

Enabled & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::isEnabled ( )

inline

Get Enabled.

◆ isEnabled() [2/2]

const Enabled & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::isEnabled ( ) const

inline

Get Enabled.

◆ operator!=()

bool Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::operator!= ( const Correction & other ) const

Inequality operator.

◆ operator==()

bool Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::operator== ( const Correction & other ) const

Equality operator.

◆ set() [1/3]

template<typename... Args>

void Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Correction. These types can be provided:

◆ set() [2/3]

Correction & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::set ( const Enabled & value )

inline

Set Enabled.

◆ set() [3/3]

Correction & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::set ( const Strength & value )

inline

Set Strength.

◆ strength() [1/2]

Strength & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::strength ( )

inline

Get Strength.

◆ strength() [2/2]

const Strength & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::strength ( ) const

inline

Get Strength.

◆ toString()

std::string Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Correction >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::description { R"description(Correction)description" }

staticconstexpr

The description for this value.

◆ name

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::name { "Correction" }

staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::path

staticconstexpr

Initial value:

{
                                "Processing/Filters/Experimental/ContrastDistortion/Correction"
                            }

The full path for this value.

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

Zivid/Settings.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Correction() [1/2]

◆ Correction() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ isEnabled() [1/2]

◆ isEnabled() [2/2]

◆ operator!=()

◆ operator==()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ strength() [1/2]

◆ strength() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Correction >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path