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

Fills missing points considering a circular neighborhood. More...

#include <Zivid/Settings.h>

Classes

class  Enabled
 Enabled More...
 
class  HoleSize
 Relative diameter of holes to fill. Increasing this will fill more points, but require more computation time. The maximum allowed hole size scales with distance, so that we allow filling larger holes at greater distances, measured in mm. More...
 
class  Strictness
 Level of strictness when considering if a point should be filled. A higher level of strictness requires a missing point to be surrounded by valid points on more sides in order to be filled. Increasing this will fill fewer points, but it will be less likely to fill gaps that are not circular, for example between two edges. More...
 

Public Types

using Descendants = std::tuple< Settings::Processing::Filters::Experimental::HoleFilling::Enabled, Settings::Processing::Filters::Experimental::HoleFilling::HoleSize, Settings::Processing::Filters::Experimental::HoleFilling::Strictness >
 

Public Member Functions

 HoleFilling ()
 Default constructor More...
 
template<typename... Args>
 HoleFilling (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
template<typename... Args>
HoleFilling copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s) More...
 
const EnabledisEnabled () const
 Get Enabled More...
 
EnabledisEnabled ()
 Get Enabled More...
 
HoleFillingset (const Enabled &value)
 Set Enabled More...
 
const HoleSizeholeSize () const
 Get HoleSize More...
 
HoleSizeholeSize ()
 Get HoleSize More...
 
HoleFillingset (const HoleSize &value)
 Set HoleSize More...
 
const Strictnessstrictness () const
 Get Strictness More...
 
Strictnessstrictness ()
 Get Strictness More...
 
HoleFillingset (const Strictness &value)
 Set Strictness More...
 
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<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Enabledget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::HoleSizeget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Processing::Filters::Experimental::HoleFilling::Strictnessget () 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 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...
 
bool operator== (const HoleFilling &other) const
 Equality operator More...
 
bool operator!= (const HoleFilling &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node More...
 
static constexpr const char * path { "Processing/Filters/Experimental/HoleFilling" }
 The full path for this value More...
 
static constexpr const char * name { "HoleFilling" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 

Friends

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

Detailed Description

Fills missing points considering a circular neighborhood.

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ HoleFilling() [1/2]

Zivid::Settings::Processing::Filters::Experimental::HoleFilling::HoleFilling ( )

Default constructor

◆ HoleFilling() [2/2]

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

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

Member Function Documentation

◆ copyWith()

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

◆ forEach() [1/2]

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

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

◆ get() [1/6]

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

◆ get() [2/6]

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

◆ get() [3/6]

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

◆ get() [4/6]

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

◆ get() [5/6]

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

◆ get() [6/6]

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

◆ holeSize() [1/2]

HoleSize & Zivid::Settings::Processing::Filters::Experimental::HoleFilling::holeSize ( )
inline

Get HoleSize

◆ holeSize() [2/2]

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

Get HoleSize

◆ isEnabled() [1/2]

Enabled & Zivid::Settings::Processing::Filters::Experimental::HoleFilling::isEnabled ( )
inline

Get Enabled

◆ isEnabled() [2/2]

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

Get Enabled

◆ operator!=()

bool Zivid::Settings::Processing::Filters::Experimental::HoleFilling::operator!= ( const HoleFilling other) const

Inequality operator

◆ operator==()

bool Zivid::Settings::Processing::Filters::Experimental::HoleFilling::operator== ( const HoleFilling other) const

Equality operator

◆ set() [1/4]

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

◆ set() [2/4]

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

Set Enabled

◆ set() [3/4]

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

Set HoleSize

◆ set() [4/4]

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

◆ strictness() [1/2]

Strictness & Zivid::Settings::Processing::Filters::Experimental::HoleFilling::strictness ( )
inline

◆ strictness() [2/2]

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

◆ toString()

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

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< HoleFilling >

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

◆ operator<<

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

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::HoleFilling::description
staticconstexpr
Initial value:
{
R"description(Fills missing points considering a circular neighborhood.
)description"
}

The description for this value

◆ name

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

The name of this value

◆ nodeType

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

The type of this node

◆ path

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

The full path for this value


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