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

#include <Zivid/Settings.h>

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

class	Threshold
	Discard point if Euclidean distance to neighboring points is above the given value More...

Public Member Functions
	Outlier ()=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::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<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Filters::Outlier::Enabled &	get () const

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

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

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

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

Outlier &	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 Outlier &other) const
	Equality operator More...

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

static constexpr const char *	name { "Outlier" }
	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 Outlier &value)
	Operator to send the value as string to a stream More...

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

Detailed Description

Discard point if Euclidean distance to neighboring points is above a threshold

Constructor & Destructor Documentation

◆ Outlier() [1/2]

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

default

Default constructor

◆ Outlier() [2/2]

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

explicit

Constructor

Member Function Documentation

◆ forEach() [1/2]

template<typename F >

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

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

inline

◆ get() [2/4]

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

inline

◆ get() [3/4]

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

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

inline

◆ get() [4/4]

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

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

inline

◆ getString()

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

Get a value as string by specifying the path

◆ isEnabled()

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

inline

Get Enabled

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ set() [1/3]

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

inline

Set Enabled

◆ set() [2/3]

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

Set a value from string by specifying the path

◆ set() [3/3]

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

inline

Set Threshold

◆ setFromString()

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

Set from the given string

◆ threshold()

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

inline

Get Threshold

◆ toString()

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

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

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

friend

Operator to send the value as string to a stream

◆ operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

◆ description

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

staticconstexpr

Initial value:

{
                    R"description(Discard point if Euclidean distance to neighboring points is above a threshold)description"
                }

The description for this value

◆ isContainer

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

staticconstexpr

Whether this node contains child values

◆ name

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

staticconstexpr

The name of this value

◆ path

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

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

◆ Outlier() [1/2]

◆ Outlier() [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