Discard points with contrast values below a threshold More...

#include <Zivid/Settings.h>

Classes
class	Enabled
	Enable or disable the contrast filter More...

class	Threshold
	Discard points with contrast below the given value More...

Public Member Functions
	Contrast ()=default
	Default constructor More...

void	set (const std::string &fullPath, const std::string &value)
	Set a value from string by specifying the path More...

std::string	getString (const std::string &fullPath) const
	Get a value as string by specifying the path More...

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

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast::Threshold >::value, int >::type = 0>
const Settings::Filters::Contrast::Threshold &	get () const

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

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Filters::Contrast::Threshold &	get () const

	Contrast (const Enabled &enabled, const Threshold &threshold)
	Constructor More...

Contrast &	set (const Enabled &value)
	Set Enabled More...

const Enabled &	isEnabled () const
	Get Enabled More...

Contrast &	set (const Threshold &value)
	Set Threshold More...

const Threshold &	threshold () const
	Get Threshold More...

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 More...

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

template<typename F >
void	traverseValues (const F &f) const
	Traverse the entire tree using the given function with the value of the member as parameter More...

template<typename F >
void	traverseValues (const F &f)
	Traverse all members using the given function with the value of the member as parameter More...

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

void	setFromString (const std::string &value)
	Set from the given string More...

bool	operator== (const Contrast &other) const
	Equality operator More...

bool	operator!= (const Contrast &other) const
	Inequality operator More...

Static Public Attributes
static constexpr bool	isContainer { true }
	Whether this node contains child values More...

static constexpr const char *	path { "Filters/Contrast" }
	The full path for this value More...

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

static constexpr const char *	description
	The description for this value More...

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

std::istream &	operator>> (std::istream &stream, Contrast &value)
	Operator to set the value from a stream More...

Detailed Description

Discard points with contrast values below a threshold

Constructor & Destructor Documentation

◆ Contrast() [1/2]

Zivid::Settings::Filters::Contrast::Contrast ( )

default

Default constructor

◆ Contrast() [2/2]

Zivid::Settings::Filters::Contrast::Contrast	(	const Enabled &	enabled,
		const Threshold &	threshold
	)

explicit

Constructor

Member Function Documentation

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::Filters::Contrast::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::Filters::Contrast::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::Filters::Contrast::Enabled >::value, int >::type = 0>

const Settings::Filters::Contrast::Enabled& Zivid::Settings::Filters::Contrast::get ( ) const

inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Contrast::Threshold >::value, int >::type = 0>

const Settings::Filters::Contrast::Threshold& Zivid::Settings::Filters::Contrast::get ( ) const

inline

◆ get() [3/4]

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

const Settings::Filters::Contrast::Enabled& Zivid::Settings::Filters::Contrast::get ( ) const

inline

◆ get() [4/4]

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

const Settings::Filters::Contrast::Threshold& Zivid::Settings::Filters::Contrast::get ( ) const

inline

◆ getString()

std::string Zivid::Settings::Filters::Contrast::getString ( const std::string & fullPath ) const

Get a value as string by specifying the path

◆ isEnabled()

const Enabled& Zivid::Settings::Filters::Contrast::isEnabled ( ) const

inline

Get Enabled

◆ operator!=()

bool Zivid::Settings::Filters::Contrast::operator!= ( const Contrast & other ) const

Inequality operator

◆ operator==()

bool Zivid::Settings::Filters::Contrast::operator== ( const Contrast & other ) const

Equality operator

◆ set() [1/3]

Contrast& Zivid::Settings::Filters::Contrast::set ( const Enabled & value )

inline

Set Enabled

◆ set() [2/3]

void Zivid::Settings::Filters::Contrast::set	(	const std::string &	fullPath,
		const std::string &	value
	)

Set a value from string by specifying the path

◆ set() [3/3]

Contrast& Zivid::Settings::Filters::Contrast::set ( const Threshold & value )

inline

Set Threshold

◆ setFromString()

void Zivid::Settings::Filters::Contrast::setFromString ( const std::string & value )

Set from the given string

◆ threshold()

const Threshold& Zivid::Settings::Filters::Contrast::threshold ( ) const

inline

Get Threshold

◆ toString()

std::string Zivid::Settings::Filters::Contrast::toString ( ) const

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

void Zivid::Settings::Filters::Contrast::traverseValues ( const F & f )

inline

Traverse all members using the given function with the value of the member as parameter

◆ traverseValues() [2/2]

template<typename F >

void Zivid::Settings::Filters::Contrast::traverseValues ( const F & f ) const

inline

Traverse the entire tree using the given function with the value of the member as parameter

Friends And Related Function Documentation

◆ operator<<

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

friend

Operator to send the value as string to a stream

◆ operator>>

std::istream& operator>>	(	std::istream &	stream,
		Contrast &	value
	)

friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Filters::Contrast::description

staticconstexpr

Initial value:

{
                    R"description(Discard points with contrast values below a threshold)description"
                }

The description for this value

◆ isContainer

constexpr bool Zivid::Settings::Filters::Contrast::isContainer { true }

staticconstexpr

Whether this node contains child values

◆ name

constexpr const char* Zivid::Settings::Filters::Contrast::name { "Contrast" }

staticconstexpr

The name of this value

◆ path

constexpr const char* Zivid::Settings::Filters::Contrast::path { "Filters/Contrast" }

staticconstexpr

The full path for this value

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

Zivid/Settings.h

Classes

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Contrast() [1/2]

◆ Contrast() [2/2]

Member Function Documentation

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ getString()

◆ isEnabled()

◆ operator!=()

◆ operator==()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ setFromString()

◆ threshold()

◆ toString()

◆ traverseValues() [1/2]

◆ traverseValues() [2/2]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ description

◆ isContainer

◆ name

◆ path