Criteria for ending iteration early. Iteration will end when all criteria are satisfied. More...

#include <Zivid/Experimental/LocalPointCloudRegistrationParameters.h>

Classes
class	RMSEDiffThreshold
	Stop iteration when the absolute change in root mean square error (RMSE) from previous iteration is less than this threshold. RMSE is defined as the square root of the average squared distance between corresponding points in the source and target point clouds. More...

class	SourceCoverageDiffThreshold
	Stop iteration when the absolute change in coverage from previous iteration is less than this threshold. Coverage is defined as the fraction of points in the source point cloud that found a correspondence in the target point cloud. More...

Public Types
using	Descendants

Public Member Functions
	ConvergenceCriteria ()
	Default constructor.

template<typename... Args>
	ConvergenceCriteria (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
ConvergenceCriteria	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const RMSEDiffThreshold &	rmseDiffThreshold () const
	Get RMSEDiffThreshold.

RMSEDiffThreshold &	rmseDiffThreshold ()
	Get RMSEDiffThreshold.

ConvergenceCriteria &	set (const RMSEDiffThreshold &value)
	Set RMSEDiffThreshold.

const SourceCoverageDiffThreshold &	sourceCoverageDiffThreshold () const
	Get SourceCoverageDiffThreshold.

SourceCoverageDiffThreshold &	sourceCoverageDiffThreshold ()
	Get SourceCoverageDiffThreshold.

ConvergenceCriteria &	set (const SourceCoverageDiffThreshold &value)
	Set SourceCoverageDiffThreshold.

template<typename T , typename std::enable_if< std::is_same< T, LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold >::value, int >::type = 0>
const LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold &	get () const

template<typename T , typename std::enable_if< std::is_same< T, LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold >::value, int >::type = 0>
const LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold &	get () 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 ConvergenceCriteria &other) const
	Equality operator.

bool	operator!= (const ConvergenceCriteria &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 char *	path { "ConvergenceCriteria" }
	The full path for this value.

static constexpr const char *	name { "ConvergenceCriteria" }
	The name of this value.

static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< ConvergenceCriteria >

std::ostream &	operator<< (std::ostream &stream, const ConvergenceCriteria &value)
	Operator to send the value as string to a stream.

Detailed Description

Criteria for ending iteration early. Iteration will end when all criteria are satisfied.

Member Typedef Documentation

◆ Descendants

using Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::Descendants

Initial value:

 std::tuple<
                    LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold,
                    LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold>

Constructor & Destructor Documentation

◆ ConvergenceCriteria() [1/2]

Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::ConvergenceCriteria ( )

Default constructor.

◆ ConvergenceCriteria() [2/2]

template<typename... Args>

Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::ConvergenceCriteria ( 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 ConvergenceCriteria then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

ConvergenceCriteria Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::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 ConvergenceCriteria 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 ConvergenceCriteria. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::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::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::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, LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold >::value, int >::type = 0>

const LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::get ( ) const

inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold >::value, int >::type = 0>

const LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::get ( ) const

inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const LocalPointCloudRegistrationParameters::ConvergenceCriteria::RMSEDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::get ( ) const

inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const LocalPointCloudRegistrationParameters::ConvergenceCriteria::SourceCoverageDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::get ( ) const

inline

◆ operator!=()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::operator!= ( const ConvergenceCriteria & other ) const

Inequality operator.

◆ operator==()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::operator== ( const ConvergenceCriteria & other ) const

Equality operator.

◆ rmseDiffThreshold() [1/2]

RMSEDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::rmseDiffThreshold ( )

inline

Get RMSEDiffThreshold.

◆ rmseDiffThreshold() [2/2]

const RMSEDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::rmseDiffThreshold ( ) const

inline

Get RMSEDiffThreshold.

◆ set() [1/3]

template<typename... Args>

void Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::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 ConvergenceCriteria. These types can be provided:

◆ set() [2/3]

ConvergenceCriteria & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::set ( const RMSEDiffThreshold & value )

inline

Set RMSEDiffThreshold.

◆ set() [3/3]

ConvergenceCriteria & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::set ( const SourceCoverageDiffThreshold & value )

inline

Set SourceCoverageDiffThreshold.

◆ sourceCoverageDiffThreshold() [1/2]

SourceCoverageDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::sourceCoverageDiffThreshold ( )

inline

Get SourceCoverageDiffThreshold.

◆ sourceCoverageDiffThreshold() [2/2]

const SourceCoverageDiffThreshold & Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::sourceCoverageDiffThreshold ( ) const

inline

Get SourceCoverageDiffThreshold.

◆ toString()

std::string Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< ConvergenceCriteria >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::description

staticconstexpr

Initial value:

{
                    R"description(Criteria for ending iteration early. Iteration will end when all criteria are satisfied.
)description"
                }

The description for this value.

◆ name

const char* Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::name { "ConvergenceCriteria" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::Experimental::LocalPointCloudRegistrationParameters::ConvergenceCriteria::path { "ConvergenceCriteria" }

staticconstexpr

The full path for this value.

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

Zivid/Experimental/LocalPointCloudRegistrationParameters.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ ConvergenceCriteria() [1/2]

◆ ConvergenceCriteria() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ operator!=()

◆ operator==()

◆ rmseDiffThreshold() [1/2]

◆ rmseDiffThreshold() [2/2]

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ sourceCoverageDiffThreshold() [1/2]

◆ sourceCoverageDiffThreshold() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< ConvergenceCriteria >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path