Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode Class Reference

The reflection filter has two modes: Local and Global. Local mode preserves more 3D data on thinner objects, generally removes more reflection artifacts and processes faster than the Global filter. The Global filter is generally better at removing outlier points in the point cloud. It is advised to use the Outlier filter together with the Local Reflection filter. More...

#include <Zivid/Settings.h>

Public Types

enum class  ValueType { global , local }
 The type of the underlying value More...
 

Public Member Functions

 Mode ()=default
 Default constructor More...
 
constexpr Mode (ValueType value)
 Constructor More...
 
ValueType value () const
 Get the value More...
 
bool hasValue () const
 Check if the value is set More...
 
void reset ()
 Reset the node to unset state More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const Mode &other) const
 Comparison operator More...
 
bool operator!= (const Mode &other) const
 Comparison operator More...
 

Static Public Member Functions

static std::set< ValueTypevalidValues ()
 All valid values of Mode More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path
 The full path for this value More...
 
static constexpr const char * name { "Mode" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 
static const Mode global
 global More...
 
static const Mode local
 local More...
 

Friends

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

Detailed Description

The reflection filter has two modes: Local and Global. Local mode preserves more 3D data on thinner objects, generally removes more reflection artifacts and processes faster than the Global filter. The Global filter is generally better at removing outlier points in the point cloud. It is advised to use the Outlier filter together with the Local Reflection filter.

Global mode was introduced in SDK 1.0 and Local mode was introduced in SDK 2.7.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value

Enumerator
global 
local 

Constructor & Destructor Documentation

◆ Mode() [1/2]

Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::Mode ( )
default

Default constructor

◆ Mode() [2/2]

constexpr Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::Mode ( ValueType  value)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ hasValue()

bool Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::hasValue ( ) const

Check if the value is set

◆ operator!=()

bool Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::operator!= ( const Mode other) const
inline

Comparison operator

◆ operator==()

bool Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::operator== ( const Mode other) const
inline

Comparison operator

◆ reset()

void Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::reset ( )

Reset the node to unset state

◆ toString()

std::string Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::toString ( ) const

Get the value as string

◆ validValues()

static std::set< ValueType > Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::validValues ( )
inlinestatic

All valid values of Mode

◆ value()

ValueType Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::value ( ) const

Get the value

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

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Mode >

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

◆ operator<< [1/2]

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

Operator to serialize the value to a stream

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream &  stream,
const Mode::ValueType value 
)
friend

Operator to serialize ValueType to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::description
staticconstexpr
Initial value:
{
R"description(The reflection filter has two modes: Local and Global. Local mode preserves more 3D data
on thinner objects, generally removes more reflection artifacts and processes faster than
the Global filter. The Global filter is generally better at removing outlier points in
the point cloud. It is advised to use the Outlier filter together with the Local
Reflection filter.
Global mode was introduced in SDK 1.0 and Local mode was introduced in SDK 2.7.
)description"
}

The description for this value

◆ global

const Mode Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::global
static

global

◆ local

const Mode Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::local
static

local

◆ name

constexpr const char* Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::name { "Mode" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode::path
staticconstexpr
Initial value:
{
"Processing/Filters/Reflection/Removal/Experimental/Mode"
}

The full path for this value


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