Contains filters that can be used to clean up a noisy point cloud. More...

#include <Zivid/Settings.h>

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

class	Repair
	Get better surface coverage by repairing regions of missing data due to noisy points. Consider disabling this filter if you require all points in your point cloud to be of high confidence. More...

class	Suppression
	Reduce noise and outliers in the point cloud. This filter can also be used to reduce ripple effects caused by interreflections. Consider disabling this filter if you need to distinguish very fine details and thus need to avoid any smoothing effects. More...

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

Public Member Functions
	Noise ()
	Default constructor.

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

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

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)

const Removal &	removal () const
	Get Removal.

Removal &	removal ()
	Get Removal.

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

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

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

const Repair &	repair () const
	Get Repair.

Repair &	repair ()
	Get Repair.

Noise &	set (const Repair &value)
	Set Repair.

Noise &	set (const Repair::Enabled &value)
	Set Repair::Enabled.

const Suppression &	suppression () const
	Get Suppression.

Suppression &	suppression ()
	Get Suppression.

Noise &	set (const Suppression &value)
	Set Suppression.

Noise &	set (const Suppression::Enabled &value)
	Set Suppression::Enabled.

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

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

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

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

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

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

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Processing::Filters::Noise::Suppression &	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.

template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.

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

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

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

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

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

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

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

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.

Detailed Description

Contains filters that can be used to clean up a noisy point cloud.

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, Settings::Processing::Filters::Noise::Repair, Settings::Processing::Filters::Noise::Repair::Enabled, Settings::Processing::Filters::Noise::Suppression, Settings::Processing::Filters::Noise::Suppression::Enabled>

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/10]

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/10]

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/10]

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/10]

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

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

inline

◆ get() [5/10]

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

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

inline

◆ get() [6/10]

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

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

inline

◆ get() [7/10]

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

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

inline

◆ get() [8/10]

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

◆ get() [9/10]

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

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

inline

◆ get() [10/10]

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

const Settings::Processing::Filters::Noise::Suppression & 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.

◆ repair() [1/2]

Repair & Zivid::Settings::Processing::Filters::Noise::repair ( )

inline

Get Repair.

◆ repair() [2/2]

const Repair & Zivid::Settings::Processing::Filters::Noise::repair ( ) const

inline

Get Repair.

◆ set() [1/8]

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/8]

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

inline

Set Removal.

◆ set() [3/8]

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

inline

Set Removal::Enabled.

◆ set() [4/8]

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

inline

Set Removal::Threshold.

◆ set() [5/8]

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

inline

Set Repair.

◆ set() [6/8]

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

inline

Set Repair::Enabled.

◆ set() [7/8]

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

inline

Set Suppression.

◆ set() [8/8]

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

inline

Set Suppression::Enabled.

◆ suppression() [1/2]

Suppression & Zivid::Settings::Processing::Filters::Noise::suppression ( )

inline

Get Suppression.

◆ suppression() [2/2]

const Suppression & Zivid::Settings::Processing::Filters::Noise::suppression ( ) const

inline

Get Suppression.

◆ toString()

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

Get the value as string.

Friends And Related Symbol 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 filters that can be used to clean up a noisy point cloud)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/10]

◆ get() [2/10]

◆ get() [3/10]

◆ get() [4/10]

◆ get() [5/10]

◆ get() [6/10]

◆ get() [7/10]

◆ get() [8/10]

◆ get() [9/10]

◆ get() [10/10]

◆ operator!=()

◆ operator==()

◆ removal() [1/2]

◆ removal() [2/2]

◆ repair() [1/2]

◆ repair() [2/2]

◆ set() [1/8]

◆ set() [2/8]

◆ set() [3/8]

◆ set() [4/8]

◆ set() [5/8]

◆ set() [6/8]

◆ set() [7/8]

◆ set() [8/8]

◆ suppression() [1/2]

◆ suppression() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Noise >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path