Zivid C++ API 2.12.0+6afd4961-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Filters::Hole::Repair Class Reference

Fills in point cloud holes by interpolating remaining surrounding points. More...

#include <Zivid/Settings.h>

Classes

class  Enabled
 Enable or disable hole repair. 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
 

Public Member Functions

 Repair ()
 Default constructor.
 
template<typename... Args>
 Repair (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Repair copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const EnabledisEnabled () const
 Get Enabled.
 
EnabledisEnabled ()
 Get Enabled.
 
Repairset (const Enabled &value)
 Set Enabled.
 
const HoleSizeholeSize () const
 Get HoleSize.
 
HoleSizeholeSize ()
 Get HoleSize.
 
Repairset (const HoleSize &value)
 Set HoleSize.
 
const Strictnessstrictness () const
 Get Strictness.
 
Strictnessstrictness ()
 Get Strictness.
 
Repairset (const Strictness &value)
 Set Strictness.
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::HoleSize >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::HoleSizeget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Strictnessget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Enabledget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::HoleSizeget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::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.
 
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 Repair &other) const
 Equality operator.
 
bool operator!= (const Repair &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/Hole/Repair" }
 The full path for this value.
 
static constexpr const charname { "Repair" }
 The name of this value.
 
static constexpr const chardescription
 The description for this value.
 

Friends

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

Detailed Description

Fills in point cloud holes by interpolating remaining surrounding points.

Member Typedef Documentation

◆ Descendants

Initial value:
std::tuple<
Settings::Processing::Filters::Hole::Repair::Enabled,
Settings::Processing::Filters::Hole::Repair::HoleSize,
Settings::Processing::Filters::Hole::Repair::Strictness>

Constructor & Destructor Documentation

◆ Repair() [1/2]

Zivid::Settings::Processing::Filters::Hole::Repair::Repair ( )

Default constructor.

◆ Repair() [2/2]

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

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

Member Function Documentation

◆ copyWith()

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

◆ forEach() [1/2]

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

◆ get() [2/6]

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

◆ get() [3/6]

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

◆ get() [4/6]

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

◆ get() [5/6]

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

◆ get() [6/6]

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

◆ holeSize() [1/2]

HoleSize & Zivid::Settings::Processing::Filters::Hole::Repair::holeSize ( )
inline

Get HoleSize.

◆ holeSize() [2/2]

const HoleSize & Zivid::Settings::Processing::Filters::Hole::Repair::holeSize ( ) const
inline

Get HoleSize.

◆ isEnabled() [1/2]

Enabled & Zivid::Settings::Processing::Filters::Hole::Repair::isEnabled ( )
inline

Get Enabled.

◆ isEnabled() [2/2]

const Enabled & Zivid::Settings::Processing::Filters::Hole::Repair::isEnabled ( ) const
inline

Get Enabled.

◆ operator!=()

Inequality operator.

◆ operator==()

Equality operator.

◆ set() [1/4]

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

◆ set() [2/4]

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

Set Enabled.

◆ set() [3/4]

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

Set HoleSize.

◆ set() [4/4]

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

Set Strictness.

◆ strictness() [1/2]

Strictness & Zivid::Settings::Processing::Filters::Hole::Repair::strictness ( )
inline

Get Strictness.

◆ strictness() [2/2]

const Strictness & Zivid::Settings::Processing::Filters::Hole::Repair::strictness ( ) const
inline

Get Strictness.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Repair >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Hole::Repair::description
staticconstexpr
Initial value:
{
R"description(Fills in point cloud holes by interpolating remaining surrounding points.
)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.


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