Contains a filter that removes points with low signal-to-noise ratio (SNR) More...

#include <Zivid/Settings.h>

Classes
class	Removal
	Discard points with signal-to-noise ratio (SNR) values below a threshold More...

Public Types
using	Descendants = std::tuple< Settings::Processing::Filters::Noise::Removal, Settings::Processing::Filters::Noise::Removal::Enabled, Settings::Processing::Filters::Noise::Removal::Threshold >

Public Member Functions
	Noise ()
	Default constructor More...

template<typename... Args>
	Noise (Args &&...args)
	Constructor taking variadic number of arguments More...

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments More...

template<typename... Args>
Noise	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s) More...

const Removal &	removal () const
	Get Removal More...

Removal &	removal ()
	Get Removal More...

Noise &	set (const Removal &value)
	Set Removal More...

Noise &	set (const Removal::Enabled &value)
	Set Removal::Enabled More...

Noise &	set (const Removal::Threshold &value)
	Set Removal::Threshold More...

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

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

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

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

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

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

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

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

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node More...

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

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

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

Friends
struct	DataModel::Detail::Befriend< Noise >

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

Detailed Description

Contains a filter that removes points with low signal-to-noise ratio (SNR)

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::Processing::Filters::Noise::Descendants = std::tuple<Settings::Processing::Filters::Noise::Removal, Settings::Processing::Filters::Noise::Removal::Enabled, Settings::Processing::Filters::Noise::Removal::Threshold>

Constructor & Destructor Documentation

◆ Noise() [1/2]

Zivid::Settings::Processing::Filters::Noise::Noise ( )

Default constructor

◆ Noise() [2/2]

template<typename... Args>

Zivid::Settings::Processing::Filters::Noise::Noise ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Noise then invoking set(args).

The provided arguments must be descendants of Noise. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>

Noise Zivid::Settings::Processing::Filters::Noise::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Noise object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Noise. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::Processing::Filters::Noise::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::Processing::Filters::Noise::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::Processing::Filters::Noise::Removal >::value, int >::type = 0>

const Settings::Processing::Filters::Noise::Removal& Zivid::Settings::Processing::Filters::Noise::get ( ) const

inline

◆ get() [2/4]

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

const Settings::Processing::Filters::Noise::Removal::Enabled& Zivid::Settings::Processing::Filters::Noise::get ( ) const

inline

◆ get() [3/4]

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

const Settings::Processing::Filters::Noise::Removal::Threshold& Zivid::Settings::Processing::Filters::Noise::get ( ) const

inline

◆ get() [4/4]

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

const Settings::Processing::Filters::Noise::Removal& Zivid::Settings::Processing::Filters::Noise::get ( ) const

inline

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ removal() [1/2]

Removal& Zivid::Settings::Processing::Filters::Noise::removal ( )

inline

Get Removal

◆ removal() [2/2]

const Removal& Zivid::Settings::Processing::Filters::Noise::removal ( ) const

inline

Get Removal

◆ set() [1/4]

template<typename... Args>

void Zivid::Settings::Processing::Filters::Noise::set ( Args &&... args )

inline

Set multiple arguments

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Noise. These types can be provided:

◆ set() [2/4]

Noise& Zivid::Settings::Processing::Filters::Noise::set ( const Removal & value )

inline

Set Removal

◆ set() [3/4]

Noise& Zivid::Settings::Processing::Filters::Noise::set ( const Removal::Enabled & value )

inline

Set Removal::Enabled

◆ set() [4/4]

Noise& Zivid::Settings::Processing::Filters::Noise::set ( const Removal::Threshold & value )

inline

Set Removal::Threshold

◆ toString()

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

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Noise >

friend struct DataModel::Detail::Befriend< Noise >

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Noise::description

staticconstexpr

Initial value:

{
                        R"description(Contains a filter that removes points with low signal-to-noise ratio (SNR))description"
                    }

The description for this value

◆ name

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

staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Noise::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node

◆ path

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

staticconstexpr

The full path for this value

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

Zivid/Settings.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Noise() [1/2]

◆ Noise() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ operator!=()

◆ operator==()

◆ removal() [1/2]

◆ removal() [2/2]

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ toString()

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Noise >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path