Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance Class Reference

Maximum normalized distance between neighboring points that are still classified as belonging to the same cluster. The default value is optimal for most scenes. On messy scenes turning this setting down helps removing more bad points. More...

#include <Zivid/Settings.h>

Public Types
using	ValueType = double
	The type of the underlying value.

Public Member Functions
	MaxNeighborDistance ()=default
	Default constructor.
constexpr	MaxNeighborDistance (double value)
	Constructor.
double	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const MaxNeighborDistance &other) const
	Comparison operator.
bool	operator!= (const MaxNeighborDistance &other) const
	Comparison operator.
bool	operator< (const MaxNeighborDistance &other) const
	Comparison operator.
bool	operator> (const MaxNeighborDistance &other) const
	Comparison operator.
bool	operator<= (const MaxNeighborDistance &other) const
	Comparison operator.
bool	operator>= (const MaxNeighborDistance &other) const
	Comparison operator.

Static Public Member Functions
static constexpr Range< double >	validRange ()
	The range of valid values for MaxNeighborDistance.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path
	The full path for this value.
static constexpr const char *	name { "MaxNeighborDistance" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< MaxNeighborDistance >
std::ostream &	operator<< (std::ostream &stream, const MaxNeighborDistance &value)
	Operator to serialize the value to a stream.

Detailed Description

Maximum normalized distance between neighboring points that are still classified as belonging to the same cluster. The default value is optimal for most scenes. On messy scenes turning this setting down helps removing more bad points.

Member Typedef Documentation

ValueType

using Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::ValueType = double

The type of the underlying value.

Constructor & Destructor Documentation

MaxNeighborDistance() [1/2]

Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::MaxNeighborDistance ( )

default

Default constructor.

MaxNeighborDistance() [2/2]

constexpr Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::MaxNeighborDistance ( double value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::hasValue

(

)

const

Check if the value is set.

operator!=()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::operator!= ( const MaxNeighborDistance & other ) const

inline

Comparison operator.

operator<()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::operator< ( const MaxNeighborDistance & other ) const

inline

Comparison operator.

operator<=()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::operator<= ( const MaxNeighborDistance & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::operator== ( const MaxNeighborDistance & other ) const

inline

Comparison operator.

operator>()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::operator> ( const MaxNeighborDistance & other ) const

inline

Comparison operator.

operator>=()

bool Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::operator>= ( const MaxNeighborDistance & other ) const

inline

Comparison operator.

reset()

void Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::toString

(

)

const

Get the value as string.

validRange()

static constexpr Range< double > Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::validRange ( )

inlinestaticconstexpr

The range of valid values for MaxNeighborDistance.

value()

double Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< MaxNeighborDistance >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

constexpr const char* Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::description

staticconstexpr

Initial value:

{
                                R"description(Maximum normalized distance between neighboring points that are still classified as
belonging to the same cluster. The default value is optimal for most scenes. On messy
scenes turning this setting down helps removing more bad points.
)description"
                            }

The description for this value.

name

constexpr const char* Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::name { "MaxNeighborDistance" }

staticconstexpr

The name of this value.

nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

constexpr const char* Zivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance::path

staticconstexpr

Initial value:

{
                                "Processing/Filters/Cluster/Removal/MaxNeighborDistance"
                            }

The full path for this value.

---

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

• Zivid/Settings.h