Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Filters::Gaussian Class Reference

Gaussian smoothing of the point cloud More...

#include <Zivid/Settings.h>

Classes

class  Enabled
 Enable or disable the smoothing filter More...
 
class  Sigma
 Higher values result in smoother point clouds (Standard deviation of the filter coefficients) More...
 

Public Member Functions

 Gaussian ()=default
 Default constructor 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...
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Filters::Gaussian::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Filters::Gaussian::Sigmaget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Filters::Gaussian::Enabledget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Filters::Gaussian::Sigmaget () const
 
 Gaussian (const Enabled &enabled, const Sigma &sigma)
 Constructor More...
 
Gaussianset (const Enabled &value)
 Set Enabled More...
 
const EnabledisEnabled () const
 Get Enabled More...
 
Gaussianset (const Sigma &value)
 Set Sigma More...
 
const Sigmasigma () const
 Get Sigma 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 setFromString (const std::string &value)
 Set from the given string More...
 
bool operator== (const Gaussian &other) const
 Equality operator More...
 
bool operator!= (const Gaussian &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/Gaussian" }
 The full path for this value More...
 
static constexpr const char * name { "Gaussian" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 

Friends

std::ostream & operator<< (std::ostream &stream, const Gaussian &value)
 Operator to send the value as string to a stream More...
 
std::istream & operator>> (std::istream &stream, Gaussian &value)
 Operator to set the value from a stream More...
 

Detailed Description

Gaussian smoothing of the point cloud

Constructor & Destructor Documentation

◆ Gaussian() [1/2]

Zivid::Settings::Filters::Gaussian::Gaussian ( )
default

Default constructor

◆ Gaussian() [2/2]

Zivid::Settings::Filters::Gaussian::Gaussian ( const Enabled enabled,
const Sigma sigma 
)
explicit

Constructor

Member Function Documentation

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::Filters::Gaussian::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::Filters::Gaussian::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::Filters::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Filters::Gaussian::Enabled& Zivid::Settings::Filters::Gaussian::get ( ) const
inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Filters::Gaussian::Sigma& Zivid::Settings::Filters::Gaussian::get ( ) const
inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Filters::Gaussian::Enabled& Zivid::Settings::Filters::Gaussian::get ( ) const
inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Filters::Gaussian::Sigma& Zivid::Settings::Filters::Gaussian::get ( ) const
inline

◆ getString()

std::string Zivid::Settings::Filters::Gaussian::getString ( const std::string &  fullPath) const

Get a value as string by specifying the path

◆ isEnabled()

const Enabled& Zivid::Settings::Filters::Gaussian::isEnabled ( ) const
inline

Get Enabled

◆ operator!=()

bool Zivid::Settings::Filters::Gaussian::operator!= ( const Gaussian other) const

Inequality operator

◆ operator==()

bool Zivid::Settings::Filters::Gaussian::operator== ( const Gaussian other) const

Equality operator

◆ set() [1/3]

Gaussian& Zivid::Settings::Filters::Gaussian::set ( const Enabled value)
inline

Set Enabled

◆ set() [2/3]

Gaussian& Zivid::Settings::Filters::Gaussian::set ( const Sigma value)
inline

Set Sigma

◆ set() [3/3]

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

Set a value from string by specifying the path

◆ setFromString()

void Zivid::Settings::Filters::Gaussian::setFromString ( const std::string &  value)

Set from the given string

◆ sigma()

const Sigma& Zivid::Settings::Filters::Gaussian::sigma ( ) const
inline

Get Sigma

◆ toString()

std::string Zivid::Settings::Filters::Gaussian::toString ( ) const

Get the value as string

◆ traverseValues() [1/2]

template<typename F >
void Zivid::Settings::Filters::Gaussian::traverseValues ( const F &  f)
inline

Traverse all members using the given function with the value of the member as parameter

◆ traverseValues() [2/2]

template<typename F >
void Zivid::Settings::Filters::Gaussian::traverseValues ( const F &  f) const
inline

Traverse the entire tree 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 Gaussian value 
)
friend

Operator to send the value as string to a stream

◆ operator>>

std::istream& operator>> ( std::istream &  stream,
Gaussian value 
)
friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Filters::Gaussian::description
staticconstexpr
Initial value:
{
R"description(Gaussian smoothing of the point cloud)description"
}

The description for this value

◆ isContainer

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

Whether this node contains child values

◆ name

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

The name of this value

◆ path

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

The full path for this value


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