A set of parameters that configures an alignment operation.
More...
#include <cvb/foundation/curve.hpp>
A set of parameters that configures an alignment operation.
◆ AlignmentConfiguration()
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. |
◆ 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()
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()
Sets the pre-align mode.
- Parameters
-
- 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.