Zivid C++ API 2.11.1+de9b5dae-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Filters Class Reference

Filters. More...

#include <Zivid/Settings.h>

Classes

class  Cluster
 Removes floating points and isolated clusters from the point cloud. More...
 
class  Experimental
 Experimental filters. These may be renamed, moved or deleted in the future. More...
 
class  Noise
 Contains filters that can be used to clean up a noisy point cloud. More...
 
class  Outlier
 Contains a filter that removes points with large Euclidean distance to neighboring points. More...
 
class  Reflection
 Contains a filter that removes points likely introduced by reflections (useful for shiny materials) More...
 
class  Smoothing
 Smoothing filters. More...
 

Public Types

using Descendants = std::tuple< Settings::Processing::Filters::Cluster, Settings::Processing::Filters::Cluster::Removal, Settings::Processing::Filters::Cluster::Removal::Enabled, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance, Settings::Processing::Filters::Cluster::Removal::MinArea, Settings::Processing::Filters::Experimental, Settings::Processing::Filters::Experimental::ContrastDistortion, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold, Settings::Processing::Filters::Experimental::HoleFilling, Settings::Processing::Filters::Experimental::HoleFilling::Enabled, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize, Settings::Processing::Filters::Experimental::HoleFilling::Strictness, Settings::Processing::Filters::Noise, 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, Settings::Processing::Filters::Outlier, Settings::Processing::Filters::Outlier::Removal, Settings::Processing::Filters::Outlier::Removal::Enabled, Settings::Processing::Filters::Outlier::Removal::Threshold, Settings::Processing::Filters::Reflection, Settings::Processing::Filters::Reflection::Removal, Settings::Processing::Filters::Reflection::Removal::Enabled, Settings::Processing::Filters::Reflection::Removal::Experimental, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode, Settings::Processing::Filters::Smoothing, Settings::Processing::Filters::Smoothing::Gaussian, Settings::Processing::Filters::Smoothing::Gaussian::Enabled, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >
 

Public Member Functions

 Filters ()
 Default constructor.
 
template<typename... Args>
 Filters (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Filters copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const Clustercluster () const
 Get Cluster.
 
Clustercluster ()
 Get Cluster.
 
Filtersset (const Cluster &value)
 Set Cluster.
 
Filtersset (const Cluster::Removal &value)
 Set Cluster::Removal.
 
Filtersset (const Cluster::Removal::Enabled &value)
 Set Cluster::Removal::Enabled.
 
Filtersset (const Cluster::Removal::MaxNeighborDistance &value)
 Set Cluster::Removal::MaxNeighborDistance.
 
Filtersset (const Cluster::Removal::MinArea &value)
 Set Cluster::Removal::MinArea.
 
const Experimentalexperimental () const
 Get Experimental.
 
Experimentalexperimental ()
 Get Experimental.
 
Filtersset (const Experimental &value)
 Set Experimental.
 
Filtersset (const Experimental::ContrastDistortion &value)
 Set Experimental::ContrastDistortion.
 
Filtersset (const Experimental::ContrastDistortion::Correction &value)
 Set Experimental::ContrastDistortion::Correction.
 
Filtersset (const Experimental::ContrastDistortion::Correction::Enabled &value)
 Set Experimental::ContrastDistortion::Correction::Enabled.
 
Filtersset (const Experimental::ContrastDistortion::Correction::Strength &value)
 Set Experimental::ContrastDistortion::Correction::Strength.
 
Filtersset (const Experimental::ContrastDistortion::Removal &value)
 Set Experimental::ContrastDistortion::Removal.
 
Filtersset (const Experimental::ContrastDistortion::Removal::Enabled &value)
 Set Experimental::ContrastDistortion::Removal::Enabled.
 
Filtersset (const Experimental::ContrastDistortion::Removal::Threshold &value)
 Set Experimental::ContrastDistortion::Removal::Threshold.
 
Filtersset (const Experimental::HoleFilling &value)
 Set Experimental::HoleFilling.
 
Filtersset (const Experimental::HoleFilling::Enabled &value)
 Set Experimental::HoleFilling::Enabled.
 
Filtersset (const Experimental::HoleFilling::HoleSize &value)
 Set Experimental::HoleFilling::HoleSize.
 
Filtersset (const Experimental::HoleFilling::Strictness &value)
 Set Experimental::HoleFilling::Strictness.
 
const Noisenoise () const
 Get Noise.
 
Noisenoise ()
 Get Noise.
 
Filtersset (const Noise &value)
 Set Noise.
 
Filtersset (const Noise::Removal &value)
 Set Noise::Removal.
 
Filtersset (const Noise::Removal::Enabled &value)
 Set Noise::Removal::Enabled.
 
Filtersset (const Noise::Removal::Threshold &value)
 Set Noise::Removal::Threshold.
 
Filtersset (const Noise::Repair &value)
 Set Noise::Repair.
 
Filtersset (const Noise::Repair::Enabled &value)
 Set Noise::Repair::Enabled.
 
Filtersset (const Noise::Suppression &value)
 Set Noise::Suppression.
 
Filtersset (const Noise::Suppression::Enabled &value)
 Set Noise::Suppression::Enabled.
 
const Outlieroutlier () const
 Get Outlier.
 
Outlieroutlier ()
 Get Outlier.
 
Filtersset (const Outlier &value)
 Set Outlier.
 
Filtersset (const Outlier::Removal &value)
 Set Outlier::Removal.
 
Filtersset (const Outlier::Removal::Enabled &value)
 Set Outlier::Removal::Enabled.
 
Filtersset (const Outlier::Removal::Threshold &value)
 Set Outlier::Removal::Threshold.
 
const Reflectionreflection () const
 Get Reflection.
 
Reflectionreflection ()
 Get Reflection.
 
Filtersset (const Reflection &value)
 Set Reflection.
 
Filtersset (const Reflection::Removal &value)
 Set Reflection::Removal.
 
Filtersset (const Reflection::Removal::Enabled &value)
 Set Reflection::Removal::Enabled.
 
Filtersset (const Reflection::Removal::Experimental &value)
 Set Reflection::Removal::Experimental.
 
Filtersset (const Reflection::Removal::Experimental::Mode &value)
 Set Reflection::Removal::Experimental::Mode.
 
const Smoothingsmoothing () const
 Get Smoothing.
 
Smoothingsmoothing ()
 Get Smoothing.
 
Filtersset (const Smoothing &value)
 Set Smoothing.
 
Filtersset (const Smoothing::Gaussian &value)
 Set Smoothing::Gaussian.
 
Filtersset (const Smoothing::Gaussian::Enabled &value)
 Set Smoothing::Gaussian::Enabled.
 
Filtersset (const Smoothing::Gaussian::Sigma &value)
 Set Smoothing::Gaussian::Sigma.
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster >::value, int >::type = 0>
const Settings::Processing::Filters::Clusterget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistanceget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Cluster::Removal::MinArea >::value, int >::type = 0>
const Settings::Processing::Filters::Cluster::Removal::MinAreaget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Experimentalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortionget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correctionget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strengthget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Thresholdget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFillingget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::HoleSizeget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::HoleFilling::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Strictnessget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise >::value, int >::type = 0>
const Settings::Processing::Filters::Noiseget () const
 
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::Removalget () 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::Enabledget () 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::Thresholdget () 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::Repairget () 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::Enabledget () 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::Suppressionget () 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::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier >::value, int >::type = 0>
const Settings::Processing::Filters::Outlierget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Thresholdget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection >::value, int >::type = 0>
const Settings::Processing::Filters::Reflectionget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimentalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental::Modeget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothingget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussianget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Sigmaget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Clusterget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Processing::Filters::Experimentalget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Processing::Filters::Noiseget () const
 
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::Processing::Filters::Outlierget () const
 
template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const Settings::Processing::Filters::Reflectionget () const
 
template<size_t i, typename std::enable_if< i==5, int >::type = 0>
const Settings::Processing::Filters::Smoothingget () 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 Filters &other) const
 Equality operator.
 
bool operator!= (const Filters &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 charpath { "Processing/Filters" }
 The full path for this value.
 
static constexpr const charname { "Filters" }
 The name of this value.
 
static constexpr const chardescription { R"description(Filters)description" }
 The description for this value.
 

Friends

struct DataModel::Detail::Befriend< Filters >
 
std::ostream & operator<< (std::ostream &stream, const Filters &value)
 Operator to send the value as string to a stream.
 

Detailed Description

Filters.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::Processing::Filters::Descendants = std::tuple< Settings::Processing::Filters::Cluster, Settings::Processing::Filters::Cluster::Removal, Settings::Processing::Filters::Cluster::Removal::Enabled, Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance, Settings::Processing::Filters::Cluster::Removal::MinArea, Settings::Processing::Filters::Experimental, Settings::Processing::Filters::Experimental::ContrastDistortion, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold, Settings::Processing::Filters::Experimental::HoleFilling, Settings::Processing::Filters::Experimental::HoleFilling::Enabled, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize, Settings::Processing::Filters::Experimental::HoleFilling::Strictness, Settings::Processing::Filters::Noise, 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, Settings::Processing::Filters::Outlier, Settings::Processing::Filters::Outlier::Removal, Settings::Processing::Filters::Outlier::Removal::Enabled, Settings::Processing::Filters::Outlier::Removal::Threshold, Settings::Processing::Filters::Reflection, Settings::Processing::Filters::Reflection::Removal, Settings::Processing::Filters::Reflection::Removal::Enabled, Settings::Processing::Filters::Reflection::Removal::Experimental, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode, Settings::Processing::Filters::Smoothing, Settings::Processing::Filters::Smoothing::Gaussian, Settings::Processing::Filters::Smoothing::Gaussian::Enabled, Settings::Processing::Filters::Smoothing::Gaussian::Sigma>

Constructor & Destructor Documentation

◆ Filters() [1/2]

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

Default constructor.

◆ Filters() [2/2]

template<typename... Args>
Zivid::Settings::Processing::Filters::Filters ( 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 Filters then invoking set(args).

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

Member Function Documentation

◆ cluster() [1/2]

Cluster & Zivid::Settings::Processing::Filters::cluster ( )
inline

Get Cluster.

◆ cluster() [2/2]

const Cluster & Zivid::Settings::Processing::Filters::cluster ( ) const
inline

Get Cluster.

◆ copyWith()

template<typename... Args>
Filters Zivid::Settings::Processing::Filters::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 Filters 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 Filters. These types can be provided:

◆ experimental() [1/2]

Experimental & Zivid::Settings::Processing::Filters::experimental ( )
inline

◆ experimental() [2/2]

const Experimental & Zivid::Settings::Processing::Filters::experimental ( ) const
inline

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::Processing::Filters::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::forEach ( const F f) const
inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/44]

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

◆ get() [2/44]

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

◆ get() [3/44]

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

◆ get() [4/44]

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

◆ get() [5/44]

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

◆ get() [6/44]

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

◆ get() [7/44]

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

◆ get() [8/44]

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction & Zivid::Settings::Processing::Filters::get ( ) const
inline

◆ get() [9/44]

◆ get() [10/44]

◆ get() [11/44]

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

◆ get() [12/44]

◆ get() [13/44]

◆ get() [14/44]

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

◆ get() [15/44]

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

◆ get() [16/44]

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

◆ get() [17/44]

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

◆ get() [18/44]

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

◆ get() [19/44]

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::get ( ) const
inline

◆ get() [20/44]

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::get ( ) const
inline

◆ get() [21/44]

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::get ( ) const
inline

◆ get() [22/44]

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::get ( ) const
inline

◆ get() [23/44]

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::get ( ) const
inline

◆ get() [24/44]

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::get ( ) const
inline

◆ get() [25/44]

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::get ( ) const
inline

◆ get() [26/44]

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

◆ get() [27/44]

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

◆ get() [28/44]

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

◆ get() [29/44]

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

◆ get() [30/44]

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

◆ get() [31/44]

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

◆ get() [32/44]

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

◆ get() [33/44]

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

◆ get() [34/44]

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

◆ get() [35/44]

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

◆ get() [36/44]

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

◆ get() [37/44]

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

◆ get() [38/44]

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

◆ get() [39/44]

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

◆ get() [40/44]

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

◆ get() [41/44]

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

◆ get() [42/44]

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

◆ get() [43/44]

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

◆ get() [44/44]

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

◆ noise() [1/2]

Noise & Zivid::Settings::Processing::Filters::noise ( )
inline

Get Noise.

◆ noise() [2/2]

const Noise & Zivid::Settings::Processing::Filters::noise ( ) const
inline

Get Noise.

◆ operator!=()

Inequality operator.

◆ operator==()

Equality operator.

◆ outlier() [1/2]

Outlier & Zivid::Settings::Processing::Filters::outlier ( )
inline

Get Outlier.

◆ outlier() [2/2]

const Outlier & Zivid::Settings::Processing::Filters::outlier ( ) const
inline

Get Outlier.

◆ reflection() [1/2]

Reflection & Zivid::Settings::Processing::Filters::reflection ( )
inline

Get Reflection.

◆ reflection() [2/2]

const Reflection & Zivid::Settings::Processing::Filters::reflection ( ) const
inline

Get Reflection.

◆ set() [1/39]

template<typename... Args>
void Zivid::Settings::Processing::Filters::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 Filters. These types can be provided:

◆ set() [2/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Cluster value)
inline

Set Cluster.

◆ set() [3/39]

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

◆ set() [4/39]

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

◆ set() [5/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Cluster::Removal::MaxNeighborDistance value)
inline

◆ set() [6/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Cluster::Removal::MinArea value)
inline

◆ set() [7/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental value)
inline

◆ set() [8/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion value)
inline

◆ set() [9/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion::Correction value)
inline

◆ set() [10/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion::Correction::Enabled value)
inline

◆ set() [11/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion::Correction::Strength value)
inline

◆ set() [12/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion::Removal value)
inline

◆ set() [13/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion::Removal::Enabled value)
inline

◆ set() [14/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::ContrastDistortion::Removal::Threshold value)
inline

◆ set() [15/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::HoleFilling value)
inline

◆ set() [16/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::HoleFilling::Enabled value)
inline

◆ set() [17/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::HoleFilling::HoleSize value)
inline

◆ set() [18/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Experimental::HoleFilling::Strictness value)
inline

◆ set() [19/39]

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

Set Noise.

◆ set() [20/39]

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

◆ set() [21/39]

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

◆ set() [22/39]

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

◆ set() [23/39]

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

◆ set() [24/39]

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

◆ set() [25/39]

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

◆ set() [26/39]

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

◆ set() [27/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Outlier value)
inline

Set Outlier.

◆ set() [28/39]

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

◆ set() [29/39]

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

◆ set() [30/39]

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

◆ set() [31/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Reflection value)
inline

Set Reflection.

◆ set() [32/39]

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

◆ set() [33/39]

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

◆ set() [34/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Reflection::Removal::Experimental value)
inline

◆ set() [35/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Reflection::Removal::Experimental::Mode value)
inline

◆ set() [36/39]

Filters & Zivid::Settings::Processing::Filters::set ( const Smoothing value)
inline

Set Smoothing.

◆ set() [37/39]

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

◆ set() [38/39]

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

◆ set() [39/39]

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

◆ smoothing() [1/2]

Smoothing & Zivid::Settings::Processing::Filters::smoothing ( )
inline

Get Smoothing.

◆ smoothing() [2/2]

const Smoothing & Zivid::Settings::Processing::Filters::smoothing ( ) const
inline

Get Smoothing.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Filters >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::description { R"description(Filters)description" }
staticconstexpr

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.


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