Zivid::Settings::Filters Class Reference

Toggle on or off various filters More...

#include <Settings.h>

Classes
class	Contrast
	Discard points with low contrast values More...
class	Outlier
	Outlier filter based on connected components More...
class	Reflection
	Detect and remove points likely to arise from reflections (useful for shiny materials) More...
class	Saturated
	Discard pixels that are saturated in the image More...

Public Member Functions
	Filters (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...
Filters &	set (const Contrast &value)
	Set Contrast More...
const Contrast &	contrast () const
	Get Contrast More...
Filters &	set (const Contrast::Threshold &value)
	Set Contrast::Threshold 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 Saturated &value)
	Set Saturated More...
const Saturated &	saturated () const
	Get Saturated More...
Filters &	set (const Saturated::Enabled &value)
	Set Saturated::Enabled 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...
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 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...

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

Toggle on or off various filters

Constructor & Destructor Documentation

Filters()

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

explicit

Construct object by loading from file

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 ) 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::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::getString

(

const std::string &

fullPath

)

const

Get a value as string by specifying the path

load()

void Zivid::Settings::Filters::load

(

const std::string &

fileName

)

Load from the given file

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

save()

void Zivid::Settings::Filters::save

(

const std::string &

fileName

)

const

Save to the given file

set() [1/10]

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

Set a value from string by specifying the path

set() [2/10]

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

inline

Set Contrast

set() [3/10]

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

inline

Set Contrast::Threshold

set() [4/10]

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

inline

Set Outlier

set() [5/10]

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

inline

Set Outlier::Enabled

set() [6/10]

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

inline

Set Outlier::Threshold

set() [7/10]

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

inline

Set Saturated

set() [8/10]

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

inline

Set Saturated::Enabled

set() [9/10]

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

inline

Set Reflection

set() [10/10]

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

inline

Set Reflection::Enabled

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

isContainer

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

static

Whether this node contains child values

name

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

static

The name of this value

path

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

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