Input parameters for controlling the local point cloud registration process. More...

#include <Zivid/Experimental/LocalPointCloudRegistrationParameters.h>

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

class	MaxCorrespondenceDistance
	The radius around each source point in which the algorithm will look for neighbors in the target point cloud. Should be larger than the typical distance between points in the point clouds. This parameter may have a significant performance impact. More...

class	MaxIterationCount
	End iteration when reaching this number, even if convergence criteria are not yet satisfied. More...

Public Types
using	Descendants

Public Member Functions
	LocalPointCloudRegistrationParameters ()
	Default constructor.

	LocalPointCloudRegistrationParameters (const std::string &fileName)
	Construct LocalPointCloudRegistrationParameters by loading from file.

std::string	serialize () const
	Serialize to a string.

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

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

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

const ConvergenceCriteria &	convergenceCriteria () const
	Get ConvergenceCriteria.

ConvergenceCriteria &	convergenceCriteria ()
	Get ConvergenceCriteria.

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

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

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

const MaxCorrespondenceDistance &	maxCorrespondenceDistance () const
	Get MaxCorrespondenceDistance.

MaxCorrespondenceDistance &	maxCorrespondenceDistance ()
	Get MaxCorrespondenceDistance.

LocalPointCloudRegistrationParameters &	set (const MaxCorrespondenceDistance &value)
	Set MaxCorrespondenceDistance.

const MaxIterationCount &	maxIterationCount () const
	Get MaxIterationCount.

MaxIterationCount &	maxIterationCount ()
	Get MaxIterationCount.

LocalPointCloudRegistrationParameters &	set (const MaxIterationCount &value)
	Set MaxIterationCount.

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

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<typename T , typename std::enable_if< std::is_same< T, LocalPointCloudRegistrationParameters::MaxCorrespondenceDistance >::value, int >::type = 0>
const LocalPointCloudRegistrationParameters::MaxCorrespondenceDistance &	get () const

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

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

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

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

bool	operator!= (const LocalPointCloudRegistrationParameters &other) const
	Inequality operator.

std::string	toString () const
	Get the value as string.

void	save (const std::string &fileName) const
	Save to the given file.

void	load (const std::string &fileName)
	Load from the given file.

Static Public Member Functions
static LocalPointCloudRegistrationParameters	fromSerialized (const std::string &value)
	Construct a new LocalPointCloudRegistrationParameters instance from a previously serialized string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.

static constexpr const char *	path { "" }
	The full path for this value.

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

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

static constexpr size_t	version { 1 }

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

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

Detailed Description

Input parameters for controlling the local point cloud registration process.

Member Typedef Documentation

◆ Descendants

using Zivid::Experimental::LocalPointCloudRegistrationParameters::Descendants

Initial value:

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

Constructor & Destructor Documentation

◆ LocalPointCloudRegistrationParameters() [1/3]

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

Default constructor.

◆ LocalPointCloudRegistrationParameters() [2/3]

Zivid::Experimental::LocalPointCloudRegistrationParameters::LocalPointCloudRegistrationParameters ( const std::string & fileName )

explicit

Construct LocalPointCloudRegistrationParameters by loading from file.

◆ LocalPointCloudRegistrationParameters() [3/3]

template<typename... Args>

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

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

Member Function Documentation

◆ convergenceCriteria() [1/2]

ConvergenceCriteria & Zivid::Experimental::LocalPointCloudRegistrationParameters::convergenceCriteria ( )

inline

Get ConvergenceCriteria.

◆ convergenceCriteria() [2/2]

const ConvergenceCriteria & Zivid::Experimental::LocalPointCloudRegistrationParameters::convergenceCriteria ( ) const

inline

Get ConvergenceCriteria.

◆ copyWith()

template<typename... Args>

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

◆ forEach() [1/2]

template<typename F >

void Zivid::Experimental::LocalPointCloudRegistrationParameters::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::forEach ( const F & f ) const

inline

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

◆ fromSerialized()

static LocalPointCloudRegistrationParameters Zivid::Experimental::LocalPointCloudRegistrationParameters::fromSerialized ( const std::string & value )

staticnodiscard

Construct a new LocalPointCloudRegistrationParameters instance from a previously serialized string.

◆ get() [1/8]

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

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

inline

◆ get() [2/8]

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

inline

◆ get() [3/8]

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

inline

◆ get() [4/8]

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

const LocalPointCloudRegistrationParameters::MaxCorrespondenceDistance & Zivid::Experimental::LocalPointCloudRegistrationParameters::get ( ) const

inline

◆ get() [5/8]

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

const LocalPointCloudRegistrationParameters::MaxIterationCount & Zivid::Experimental::LocalPointCloudRegistrationParameters::get ( ) const

inline

◆ get() [6/8]

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

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

inline

◆ get() [7/8]

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

const LocalPointCloudRegistrationParameters::MaxCorrespondenceDistance & Zivid::Experimental::LocalPointCloudRegistrationParameters::get ( ) const

inline

◆ get() [8/8]

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

const LocalPointCloudRegistrationParameters::MaxIterationCount & Zivid::Experimental::LocalPointCloudRegistrationParameters::get ( ) const

inline

◆ load()

void Zivid::Experimental::LocalPointCloudRegistrationParameters::load ( const std::string & fileName )

Load from the given file.

◆ maxCorrespondenceDistance() [1/2]

MaxCorrespondenceDistance & Zivid::Experimental::LocalPointCloudRegistrationParameters::maxCorrespondenceDistance ( )

inline

Get MaxCorrespondenceDistance.

◆ maxCorrespondenceDistance() [2/2]

const MaxCorrespondenceDistance & Zivid::Experimental::LocalPointCloudRegistrationParameters::maxCorrespondenceDistance ( ) const

inline

Get MaxCorrespondenceDistance.

◆ maxIterationCount() [1/2]

MaxIterationCount & Zivid::Experimental::LocalPointCloudRegistrationParameters::maxIterationCount ( )

inline

Get MaxIterationCount.

◆ maxIterationCount() [2/2]

const MaxIterationCount & Zivid::Experimental::LocalPointCloudRegistrationParameters::maxIterationCount ( ) const

inline

Get MaxIterationCount.

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ save()

void Zivid::Experimental::LocalPointCloudRegistrationParameters::save ( const std::string & fileName ) const

Save to the given file.

◆ serialize()

std::string Zivid::Experimental::LocalPointCloudRegistrationParameters::serialize ( ) const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/6]

template<typename... Args>

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

◆ set() [2/6]

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

inline

Set ConvergenceCriteria.

◆ set() [3/6]

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

inline

Set ConvergenceCriteria::RMSEDiffThreshold.

◆ set() [4/6]

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

inline

Set ConvergenceCriteria::SourceCoverageDiffThreshold.

◆ set() [5/6]

LocalPointCloudRegistrationParameters & Zivid::Experimental::LocalPointCloudRegistrationParameters::set ( const MaxCorrespondenceDistance & value )

inline

Set MaxCorrespondenceDistance.

◆ set() [6/6]

LocalPointCloudRegistrationParameters & Zivid::Experimental::LocalPointCloudRegistrationParameters::set ( const MaxIterationCount & value )

inline

Set MaxIterationCount.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< LocalPointCloudRegistrationParameters >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

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

staticconstexpr

Initial value:

{
                R"description(Input parameters for controlling the local point cloud registration process.
)description"
            }

The description for this value.

◆ name

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

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

staticconstexpr

The full path for this value.

◆ version

size_t Zivid::Experimental::LocalPointCloudRegistrationParameters::version { 1 }

staticconstexpr

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

Zivid/Experimental/LocalPointCloudRegistrationParameters.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ LocalPointCloudRegistrationParameters() [1/3]

◆ LocalPointCloudRegistrationParameters() [2/3]

◆ LocalPointCloudRegistrationParameters() [3/3]

Member Function Documentation

◆ convergenceCriteria() [1/2]

◆ convergenceCriteria() [2/2]

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ fromSerialized()

◆ get() [1/8]

◆ get() [2/8]

◆ get() [3/8]

◆ get() [4/8]

◆ get() [5/8]

◆ get() [6/8]

◆ get() [7/8]

◆ get() [8/8]

◆ load()

◆ maxCorrespondenceDistance() [1/2]

◆ maxCorrespondenceDistance() [2/2]

◆ maxIterationCount() [1/2]

◆ maxIterationCount() [2/2]

◆ operator!=()

◆ operator==()

◆ save()

◆ serialize()

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ set() [4/6]

◆ set() [5/6]

◆ set() [6/6]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< LocalPointCloudRegistrationParameters >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version