Zivid::Settings::Filters::Outlier Class Reference

Outlier filter based on connected components More...

#include <Settings.h>

Classes
class	Enabled
	Enable or disable the outlier filter More...
class	Threshold
	Mark point as an outlier if neighboring pixel has a 3D distance above given threshold More...

Public Member Functions
	Outlier (const std::string &fileName)
	Construct object by loading from file 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...
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	save (const std::string &fileName) const
	Save to the given file More...
void	setFromString (const std::string &value)
	Set from the given string More...
void	load (const std::string &fileName)
	Load from the given file 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...

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

Outlier filter based on connected components

Constructor & Destructor Documentation

Outlier()

Zivid::Settings::Filters::Outlier::Outlier ( const std::string &  fileName )

explicit

Construct object by loading from file

Member Function Documentation

forEach() [1/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

forEach() [2/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

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

load()

void Zivid::Settings::Filters::Outlier::load

(

const std::string &

fileName

)

Load from the given file

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

save()

void Zivid::Settings::Filters::Outlier::save

(

const std::string &

fileName

)

const

Save to the given file

set() [1/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() [2/3]

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

inline

Set Enabled

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 ) const

inline

Traverse the entire tree 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 )

inline

Traverse all members 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

isContainer

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

static

Whether this node contains child values

name

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

static

The name of this value

path

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

static

The full path for this value

---

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

• C:/vagrant/source/cpp/build/install/include/Zivid/Settings.h