Collection of filters More...

#include <Zivid/Settings.h>

Classes
class	Contrast
	Discard points with contrast values below a threshold More...

class	Gaussian
	Gaussian smoothing of the point cloud More...

class	Outlier
	Discard point if Euclidean distance to neighboring points is above a threshold More...

class	Reflection
	Discard points likely introduced by reflections (useful for shiny materials) More...

class	Saturated
	Discard points that are saturated More...

Public Member Functions
	Filters ()=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 >::value, int >::type = 0>
const Settings::Filters::Contrast &	get () const

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<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian >::value, int >::type = 0>
const Settings::Filters::Gaussian &	get () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	Filters (const Contrast &contrast, const Gaussian &gaussian, const Outlier &outlier, const Reflection &reflection, const Saturated &saturated)
	Constructor More...

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

const Contrast &	contrast () const
	Get Contrast More...

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

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

Filters &	set (const Gaussian &value)
	Set Gaussian More...

const Gaussian &	gaussian () const
	Get Gaussian More...

Filters &	set (const Gaussian::Enabled &value)
	Set Gaussian::Enabled More...

Filters &	set (const Gaussian::Sigma &value)
	Set Gaussian::Sigma More...

Filters &	set (const Outlier &value)
	Set Outlier More...

const Outlier &	outlier () const
	Get Outlier More...

Filters &	set (const Outlier::Enabled &value)
	Set Outlier::Enabled More...

Filters &	set (const Outlier::Threshold &value)
	Set Outlier::Threshold More...

Filters &	set (const Reflection &value)
	Set Reflection More...

const Reflection &	reflection () const
	Get Reflection More...

Filters &	set (const Reflection::Enabled &value)
	Set Reflection::Enabled More...

Filters &	set (const Saturated &value)
	Set Saturated More...

const Saturated &	saturated () const
	Get Saturated More...

Filters &	set (const Saturated::Enabled &value)
	Set Saturated::Enabled 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 Filters &other) const
	Equality operator More...

bool	operator!= (const Filters &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" }
	The full path for this value More...

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

static constexpr const char *	description { R"description(Collection of filters)description" }
	The description for this value More...

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

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

Detailed Description

Collection of filters

Constructor & Destructor Documentation

◆ Filters() [1/2]

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

default

Default constructor

◆ Filters() [2/2]

Zivid::Settings::Filters::Filters	(	const Contrast &	contrast,
		const Gaussian &	gaussian,
		const Outlier &	outlier,
		const Reflection &	reflection,
		const Saturated &	saturated
	)

explicit

Constructor

Member Function Documentation

◆ contrast()

const Contrast& Zivid::Settings::Filters::contrast ( ) const

inline

Get Contrast

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::Filters::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::forEach ( const F & f ) const

inline

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

◆ gaussian()

const Gaussian& Zivid::Settings::Filters::gaussian ( ) const

inline

Get Gaussian

◆ get() [1/18]

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

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

inline

◆ get() [2/18]

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::get ( ) const

inline

◆ get() [3/18]

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::get ( ) const

inline

◆ get() [4/18]

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

const Settings::Filters::Gaussian& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [5/18]

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

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

inline

◆ get() [6/18]

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

const Settings::Filters::Gaussian::Sigma& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [7/18]

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

const Settings::Filters::Outlier& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [8/18]

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

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

inline

◆ get() [9/18]

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

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

inline

◆ get() [10/18]

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

const Settings::Filters::Reflection& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [11/18]

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

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

inline

◆ get() [12/18]

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

const Settings::Filters::Saturated& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [13/18]

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

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

inline

◆ get() [14/18]

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

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

inline

◆ get() [15/18]

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

const Settings::Filters::Gaussian& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [16/18]

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

const Settings::Filters::Outlier& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [17/18]

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

const Settings::Filters::Reflection& Zivid::Settings::Filters::get ( ) const

inline

◆ get() [18/18]

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

const Settings::Filters::Saturated& Zivid::Settings::Filters::get ( ) const

inline

◆ getString()

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

Get a value as string by specifying the path

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ outlier()

const Outlier& Zivid::Settings::Filters::outlier ( ) const

inline

Get Outlier

◆ reflection()

const Reflection& Zivid::Settings::Filters::reflection ( ) const

inline

Get Reflection

◆ saturated()

const Saturated& Zivid::Settings::Filters::saturated ( ) const

inline

Get Saturated

◆ set() [1/14]

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

inline

Set Contrast

◆ set() [2/14]

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

inline

Set Contrast::Enabled

◆ set() [3/14]

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

inline

Set Contrast::Threshold

◆ set() [4/14]

Filters& Zivid::Settings::Filters::set ( const Gaussian & value )

inline

Set Gaussian

◆ set() [5/14]

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

inline

Set Gaussian::Enabled

◆ set() [6/14]

Filters& Zivid::Settings::Filters::set ( const Gaussian::Sigma & value )

inline

Set Gaussian::Sigma

◆ set() [7/14]

Filters& Zivid::Settings::Filters::set ( const Outlier & value )

inline

Set Outlier

◆ set() [8/14]

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

inline

Set Outlier::Enabled

◆ set() [9/14]

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

inline

Set Outlier::Threshold

◆ set() [10/14]

Filters& Zivid::Settings::Filters::set ( const Reflection & value )

inline

Set Reflection

◆ set() [11/14]

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

inline

Set Reflection::Enabled

◆ set() [12/14]

Filters& Zivid::Settings::Filters::set ( const Saturated & value )

inline

Set Saturated

◆ set() [13/14]

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

inline

Set Saturated::Enabled

◆ set() [14/14]

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

Set a value from string by specifying the path

◆ setFromString()

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

Set from the given string

◆ toString()

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

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

void Zivid::Settings::Filters::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::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 Filters &	value
	)

friend

Operator to send the value as string to a stream

◆ operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Filters::description { R"description(Collection of filters)description" }

staticconstexpr

The description for this value

◆ isContainer

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

staticconstexpr

Whether this node contains child values

◆ name

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

staticconstexpr

The name of this value

◆ path

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

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

◆ Filters() [1/2]

◆ Filters() [2/2]

Member Function Documentation

◆ contrast()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ gaussian()

◆ get() [1/18]

◆ get() [2/18]

◆ get() [3/18]

◆ get() [4/18]

◆ get() [5/18]

◆ get() [6/18]

◆ get() [7/18]

◆ get() [8/18]

◆ get() [9/18]

◆ get() [10/18]

◆ get() [11/18]

◆ get() [12/18]

◆ get() [13/18]

◆ get() [14/18]

◆ get() [15/18]

◆ get() [16/18]

◆ get() [17/18]

◆ get() [18/18]

◆ getString()

◆ operator!=()

◆ operator==()

◆ outlier()

◆ reflection()

◆ saturated()

◆ set() [1/14]

◆ set() [2/14]

◆ set() [3/14]

◆ set() [4/14]

◆ set() [5/14]

◆ set() [6/14]

◆ set() [7/14]

◆ set() [8/14]

◆ set() [9/14]

◆ set() [10/14]

◆ set() [11/14]

◆ set() [12/14]

◆ set() [13/14]

◆ set() [14/14]

◆ setFromString()

◆ toString()

◆ traverseValues() [1/2]

◆ traverseValues() [2/2]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ description

◆ isContainer

◆ name

◆ path