ImFusion C++ SDK 4.5.0
ImFusion::DeformableIcp::AdvancedProperties Struct Reference
Inheritance diagram for ImFusion::DeformableIcp::AdvancedProperties:

Public Attributes

Parameter< std::optional< double > > p_relaxationLogLambda = {"relaxationLogLambda", std::nullopt, this}
 If set, the regularization parameter will be increased again after reaching p_stoppingLogLambda until its logarithm is larger than or equal to this value.
Parameter< double > p_stoppingRelRmse = {"stoppingRelRmse", 0., this}
 If the relative RMSE in % is less than or equal to this value, iterations are stopped.
Parameter< double > p_stoppingRelRmseDiff = {"stoppingRelRmseDiff", 0.001, this}
 If the difference of relative RMSE in % between successive iterations is less than or equal to this value, pre-alignment iterations are stopped.
Parameter< int > p_maxIter = {"maxIter", 200, this}
 Maximum number of ICP iterations.
Parameter< double > p_conjGradTolerance = {"conjGradTolerance", 1e-3, this}
 The tolerance threshold for stopping the conjugate gradient iterations used to solve the linear system (upper bound of relative residual error).
Parameter< int > p_conjGradMaxIterations = {"conjGradMaxIterations", 4, this}
 Conjugate gradient (CG) with a complete Cholesky preconditioner is used to solve the linear system.
Public Attributes inherited from ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Public Member Functions inherited from ImFusion::Configurable
virtual void configure (const Properties *p)
 Configure this object instance by de-serializing the given Properties.
virtual void configuration (Properties *p) const
 Serialize the current object configuration into the given Properties object.
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 Configurable (const Configurable &rhs)
 Configurable (Configurable &&rhs) noexcept
Configurable & operator= (const Configurable &)
Configurable & operator= (Configurable &&) noexcept
Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Data Documentation

◆ p_relaxationLogLambda

Parameter<std::optional<double> > ImFusion::DeformableIcp::AdvancedProperties::p_relaxationLogLambda = {"relaxationLogLambda", std::nullopt, this}

If set, the regularization parameter will be increased again after reaching p_stoppingLogLambda until its logarithm is larger than or equal to this value.

The regularization parameter will be increased by dividing it by p_lambdaReductionFactor each iteration.

◆ p_stoppingRelRmse

Parameter<double> ImFusion::DeformableIcp::AdvancedProperties::p_stoppingRelRmse = {"stoppingRelRmse", 0., this}

If the relative RMSE in % is less than or equal to this value, iterations are stopped.

The relative RMSE is the absolute RMSE divided by the RMS distance of fixed points from their centroid.

◆ p_stoppingRelRmseDiff

Parameter<double> ImFusion::DeformableIcp::AdvancedProperties::p_stoppingRelRmseDiff = {"stoppingRelRmseDiff", 0.001, this}

If the difference of relative RMSE in % between successive iterations is less than or equal to this value, pre-alignment iterations are stopped.

This criterion is not used for the deformable registration.

◆ p_conjGradTolerance

Parameter<double> ImFusion::DeformableIcp::AdvancedProperties::p_conjGradTolerance = {"conjGradTolerance", 1e-3, this}

The tolerance threshold for stopping the conjugate gradient iterations used to solve the linear system (upper bound of relative residual error).

If set to 0, the system is solved directly using a Cholesky factorization.

◆ p_conjGradMaxIterations

Parameter<int> ImFusion::DeformableIcp::AdvancedProperties::p_conjGradMaxIterations = {"conjGradMaxIterations", 4, this}

Conjugate gradient (CG) with a complete Cholesky preconditioner is used to solve the linear system.

The Cholesky factorization is reused across ICP iterations and is only recomputed if the number of CG iterations needed during the previous ICP iteration is greater than or equal to this value. If set to 0, the system is solved directly using the Cholesky factorization.


The documentation for this struct was generated from the following file:
  • ImFusion/Reg/DeformableIcp.h
Search Tab / S to search, Esc to close