AlignmentConfiguration Class Reference

A set of parameters that configures an alignment operation. More...

#include <cvb/foundation/curve.hpp>

Public Member Functions
	AlignmentConfiguration (size_t maxIterations, double tolerance, double minImprovement, double correspondence, PreAlignmentMode mode) noexcept
	Constructor for an alignment configuration.
size_t	MaxIterations () const noexcept
	Gets the maximum iterations of ICP.
void	SetMaxIterations (size_t maxIterations) noexcept
	Sets the maximum iterations of ICP.
double	Tolerance () const noexcept
	Gets the value for early stopping criteria.
void	SetTolerance (double tolerance) noexcept
	Sets the value for early stopping criteria.
double	MinImprovement () const noexcept
	Gets the value for early stopping criteria.
void	SetMinImprovement (double minImprovement) noexcept
	Sets the value for early stopping criteria.
double	Correspondence () const noexcept
	Gets the minimum value for correspondence of two points to be considered for alignment.
void	SetCorrespondence (double correspondence) noexcept
	Sets the minimum value for correspondence of two points to be considered for alignment.
PreAlignmentMode	Mode () const noexcept
	Gets the pre-align mode.
void	SetMode (PreAlignmentMode mode) noexcept
	Sets the pre-align mode.

Detailed Description

A set of parameters that configures an alignment operation.

Constructor & Destructor Documentation

AlignmentConfiguration()

AlignmentConfiguration ( size_t maxIterations, double tolerance, double minImprovement, double correspondence, PreAlignmentMode mode )

inlinenoexcept

Constructor for an alignment configuration.

Parameters

[in]	maxIterations	Maximum iterations of ICP.
[in]	tolerance	Value for early stopping criteria.
[in]	minImprovement	Value for early stopping criteria.
[in]	correspondence	Minimum value for correspondence of two points to be considered for alignment.
[in]	mode	Specifies if the pre-alignment needs to be executed.

Exceptions

Does	not throw any exception.

Member Function Documentation

Correspondence()

double Correspondence ( ) const

inlinenoexcept

Gets the minimum value for correspondence of two points to be considered for alignment.

Returns

The minimum value for correspondence of two points to be considered for alignment.

Exceptions

Does	not throw any exception.

MaxIterations()

size_t MaxIterations ( ) const

inlinenoexcept

Gets the maximum iterations of ICP.

Returns

The maximum iterations of ICP.

Exceptions

Does	not throw any exception.

MinImprovement()

double MinImprovement ( ) const

inlinenoexcept

Gets the value for early stopping criteria.

Returns

The value for early stopping criteria.

Exceptions

Does	not throw any exception.

If the norm of alignment changes less than this value, the alignment is considered converged.

Mode()

PreAlignmentMode Mode ( ) const

inlinenoexcept

Gets the pre-align mode.

Returns

Pre-align mode.

Exceptions

Does	not throw any exception.

SetCorrespondence()

void SetCorrespondence ( double correspondence )

inlinenoexcept

Sets the minimum value for correspondence of two points to be considered for alignment.

Parameters

[in]

correspondence

The minimum value for correspondence of two points to be considered for alignment.

Exceptions

Does	not throw any exception.

SetMaxIterations()

void SetMaxIterations ( size_t maxIterations )

inlinenoexcept

Sets the maximum iterations of ICP.

Parameters

[in]

maxIterations

The maximum iterations of ICP.

Exceptions

Does	not throw any exception.

SetMinImprovement()

void SetMinImprovement ( double minImprovement )

inlinenoexcept

Sets the value for early stopping criteria.

Parameters

[in]

minImprovement

The value for early stopping criteria.

Exceptions

Does	not throw any exception.

SetMode()

void SetMode ( PreAlignmentMode mode )

inlinenoexcept

Sets the pre-align mode.

Parameters

[in]

mode

Pre-align mode.

Exceptions

Does	not throw any exception.

SetTolerance()

void SetTolerance ( double tolerance )

inlinenoexcept

Sets the value for early stopping criteria.

Parameters

[in]

tolerance

The value for early stopping criteria.

Exceptions

Does	not throw any exception.

Tolerance()

double Tolerance ( ) const

inlinenoexcept

Gets the value for early stopping criteria.

Returns

The value for early stopping criteria.

Exceptions

Does	not throw any exception.

If the norm of alignment falls below this value, the alignment is considered successful.