Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
mitk::LevenbergMarquardtModelFitFunctor Class Reference

Model fit functor that uses the Levenberg-Marquardt optimization algorithm. More...

#include <mitkLevenbergMarquardtModelFitFunctor.h>

Inheritance diagram for mitk::LevenbergMarquardtModelFitFunctor:
Inheritance graph
[legend]
Collaboration diagram for mitk::LevenbergMarquardtModelFitFunctor:
Collaboration graph
[legend]

Public Types

typedef LevenbergMarquardtModelFitFunctor Self
 
typedef ModelFitFunctorBase Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::InputPixelArrayType InputPixelArrayType
 
typedef Superclass::OutputPixelArrayType OutputPixelArrayType
 
- Public Types inherited from mitk::ModelFitFunctorBase
typedef ModelFitFunctorBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef ScalarType ParameterImagePixelType
 
typedef std::vector< ParameterImagePixelType > InputPixelArrayType
 
typedef std::vector< ParameterImagePixelType > OutputPixelArrayType
 
typedef ModelBase::ParameterNamesType ParameterNamesType
 

Public Member Functions

virtual const char * GetClassName () const
 
virtual void SetEpsilon (double _arg)
 
virtual void SetGradientTolerance (double _arg)
 
virtual void SetValueTolerance (double _arg)
 
virtual void SetDerivativeStepLength (double _arg)
 
virtual void SetIterations (unsigned int _arg)
 
virtual void SetScales (::itk::LevenbergMarquardtOptimizer::ScalesType _arg)
 
virtual double GetEpsilon ()
 
virtual double GetGradientTolerance ()
 
virtual double GetValueTolerance ()
 
virtual double GetDerivativeStepLength ()
 
virtual unsigned int GetIterations ()
 
virtual ::itk::LevenbergMarquardtOptimizer::ScalesType GetScales ()
 
virtual void SetConstraintChecker (const ConstraintCheckerBase *_arg)
 
virtual const ConstraintCheckerBase * GetConstraintChecker ()
 
virtual void SetActivateFailureThreshold (bool _arg)
 
virtual bool GetActivateFailureThreshold () const
 
ParameterNamesType GetCriterionNames () const override
 Returns names of the criteria used to fit the model. More...
 
- Public Member Functions inherited from mitk::ModelFitFunctorBase
OutputPixelArrayType Compute (const InputPixelArrayType &value, const ModelBase *model, const ModelBase::ParametersType &initialParameters) const
 Performs model fitting and returns the results. More...
 
unsigned int GetNumberOfOutputs (const ModelBase *model) const
 Returns the number of outputs the fit functor will produce. More...
 
ParameterNamesType GetEvaluationParameterNames () const
 Returns names of all evaluation parameters defined by the user. More...
 
void ResetEvaluationParameters ()
 Removes all registered evaluation parameters. More...
 
void RegisterEvaluationParameter (const std::string &parameterName, SVModelFitCostFunction *evaluationCostFunction)
 Registers an evaluation parameter with its cost function. More...
 
const SVModelFitCostFunction * GetEvaluationParameterCostFunction (const std::string &parameterName) const
 Returns the cost function associated with the given evaluation parameter. More...
 
ParameterNamesType GetDebugParameterNames () const
 Returns names of the debug parameters generated by the functor. More...
 
virtual void DebugParameterMapsOn ()
 
virtual void DebugParameterMapsOff ()
 
virtual void SetDebugParameterMaps (bool _arg)
 
virtual bool GetDebugParameterMaps () const
 

Static Public Member Functions

static Pointer New ()
 

Protected Types

typedef Superclass::ParametersType ParametersType
 
typedef Superclass::SignalType SignalType
 
- Protected Types inherited from mitk::ModelFitFunctorBase
typedef ModelBase::ParametersType ParametersType
 
typedef ModelFitCostFunctionInterface::SignalType SignalType
 
typedef std::map< std::string, ParameterImagePixelType > DebugParameterMapType
 

Protected Member Functions

 LevenbergMarquardtModelFitFunctor ()
 
 ~LevenbergMarquardtModelFitFunctor () override
 
ParametersType DoModelFit (const SignalType &value, const ModelBase *model, const ModelBase::ParametersType &initialParameters, DebugParameterMapType &debugParameters) const override
 Internal method that performs the actual model fitting. More...
 
OutputPixelArrayType GetCriteria (const ModelBase *model, const ParametersType &parameters, const SignalType &sample) const override
 Internal method called by Compute() to get the final criterion values that drove the fit. More...
 
virtual MVModelFitCostFunction::Pointer GenerateCostFunction (const SignalType &value, const ModelBase *model) const
 
ParameterNamesType DefineDebugParameterNames () const override
 Returns names of the debug parameters generated by the functor. More...
 
- Protected Member Functions inherited from mitk::ModelFitFunctorBase
 ModelFitFunctorBase ()
 
 ~ModelFitFunctorBase () override
 
OutputPixelArrayType GetDerivedParameters (const ModelBase *model, const ParametersType &parameters) const
 Internal method called by Compute() to get derived parameters with the final fit parameters. More...
 
OutputPixelArrayType GetEvaluationParameters (const ModelBase *model, const ParametersType &parameters, const SignalType &sample) const
 Internal method called by Compute() to get evaluation parameters from user-defined cost functions. More...
 

Detailed Description

Model fit functor that uses the Levenberg-Marquardt optimization algorithm.

This functor performs nonlinear least-squares fitting using the ITK LevenbergMarquardtOptimizer. It supports optional parameter constraints via a ConstraintCheckerBase and configurable optimizer parameters (epsilon, gradient tolerance, value tolerance, iteration count).

See also
ModelFitFunctorBase, DummyModelFitFunctor, MVConstrainedCostFunctionDecorator

Definition at line 39 of file mitkLevenbergMarquardtModelFitFunctor.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer< const Self > mitk::LevenbergMarquardtModelFitFunctor::ConstPointer

Definition at line 45 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ InputPixelArrayType

typedef Superclass::InputPixelArrayType mitk::LevenbergMarquardtModelFitFunctor::InputPixelArrayType

Definition at line 50 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ OutputPixelArrayType

typedef Superclass::OutputPixelArrayType mitk::LevenbergMarquardtModelFitFunctor::OutputPixelArrayType

Definition at line 51 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ ParametersType

typedef Superclass::ParametersType mitk::LevenbergMarquardtModelFitFunctor::ParametersType
protected

Definition at line 76 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ Pointer

typedef itk::SmartPointer< Self > mitk::LevenbergMarquardtModelFitFunctor::Pointer

Definition at line 44 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ Self

typedef LevenbergMarquardtModelFitFunctor mitk::LevenbergMarquardtModelFitFunctor::Self

Definition at line 42 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ SignalType

typedef Superclass::SignalType mitk::LevenbergMarquardtModelFitFunctor::SignalType
protected

Definition at line 77 of file mitkLevenbergMarquardtModelFitFunctor.h.

◆ Superclass

typedef ModelFitFunctorBase mitk::LevenbergMarquardtModelFitFunctor::Superclass

Definition at line 43 of file mitkLevenbergMarquardtModelFitFunctor.h.

Constructor & Destructor Documentation

◆ LevenbergMarquardtModelFitFunctor()

mitk::LevenbergMarquardtModelFitFunctor::LevenbergMarquardtModelFitFunctor ( )
protected

◆ ~LevenbergMarquardtModelFitFunctor()

mitk::LevenbergMarquardtModelFitFunctor::~LevenbergMarquardtModelFitFunctor ( )
overrideprotected

Member Function Documentation

◆ DefineDebugParameterNames()

ParameterNamesType mitk::LevenbergMarquardtModelFitFunctor::DefineDebugParameterNames ( ) const
overrideprotectedvirtual

Returns names of the debug parameters generated by the functor.

Will be called by GetDebugParameterNames() if debug is activated.

Implements mitk::ModelFitFunctorBase.

◆ DoModelFit()

ParametersType mitk::LevenbergMarquardtModelFitFunctor::DoModelFit ( const SignalType &  value,
const ModelBase *  model,
const ModelBase::ParametersType &  initialParameters,
DebugParameterMapType &  debugParameters 
) const
overrideprotectedvirtual

Internal method that performs the actual model fitting.

Must be implemented by derived classes. Returns the found parameters and optionally populates the debug parameter map.

Parameters
valueSignal the model should be fitted against.
modelPointer to the model that should be fitted.
initialParametersInitial model parameters for the fit.
[out]debugParametersMap containing all debug parameters (only valid if m_DebugParameterMaps is true).
Returns
The optimized parameter values.
Postcondition
If m_DebugParameterMaps is true, all debug parameters defined by DefineDebugParameterNames() must be returned via debugParameters.

Implements mitk::ModelFitFunctorBase.

◆ GenerateCostFunction()

virtual MVModelFitCostFunction::Pointer mitk::LevenbergMarquardtModelFitFunctor::GenerateCostFunction ( const SignalType &  value,
const ModelBase *  model 
) const
protectedvirtual

Generator function that instantiates and parameterizes the cost function that should be used by the fit functor

◆ GetActivateFailureThreshold()

virtual bool mitk::LevenbergMarquardtModelFitFunctor::GetActivateFailureThreshold ( ) const
virtual

◆ GetClassName()

virtual const char* mitk::LevenbergMarquardtModelFitFunctor::GetClassName ( ) const
virtual

Reimplemented from mitk::ModelFitFunctorBase.

◆ GetConstraintChecker()

virtual const ConstraintCheckerBase* mitk::LevenbergMarquardtModelFitFunctor::GetConstraintChecker ( )
virtual

◆ GetCriteria()

OutputPixelArrayType mitk::LevenbergMarquardtModelFitFunctor::GetCriteria ( const ModelBase *  model,
const ParametersType &  parameters,
const SignalType &  sample 
) const
overrideprotectedvirtual

Internal method called by Compute() to get the final criterion values that drove the fit.

Must be implemented by concrete functor classes.

Implements mitk::ModelFitFunctorBase.

◆ GetCriterionNames()

ParameterNamesType mitk::LevenbergMarquardtModelFitFunctor::GetCriterionNames ( ) const
overridevirtual

Returns names of the criteria used to fit the model.

Implements mitk::ModelFitFunctorBase.

◆ GetDerivativeStepLength()

virtual double mitk::LevenbergMarquardtModelFitFunctor::GetDerivativeStepLength ( )
virtual

◆ GetEpsilon()

virtual double mitk::LevenbergMarquardtModelFitFunctor::GetEpsilon ( )
virtual

◆ GetGradientTolerance()

virtual double mitk::LevenbergMarquardtModelFitFunctor::GetGradientTolerance ( )
virtual

◆ GetIterations()

virtual unsigned int mitk::LevenbergMarquardtModelFitFunctor::GetIterations ( )
virtual

◆ GetScales()

virtual ::itk::LevenbergMarquardtOptimizer::ScalesType mitk::LevenbergMarquardtModelFitFunctor::GetScales ( )

◆ GetValueTolerance()

virtual double mitk::LevenbergMarquardtModelFitFunctor::GetValueTolerance ( )
virtual

◆ New()

static Pointer mitk::LevenbergMarquardtModelFitFunctor::New ( )
static

◆ SetActivateFailureThreshold()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetActivateFailureThreshold ( bool  _arg)
virtual

◆ SetConstraintChecker()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetConstraintChecker ( const ConstraintCheckerBase *  _arg)
virtual

◆ SetDerivativeStepLength()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetDerivativeStepLength ( double  _arg)
virtual

◆ SetEpsilon()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetEpsilon ( double  _arg)
virtual

◆ SetGradientTolerance()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetGradientTolerance ( double  _arg)
virtual

◆ SetIterations()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetIterations ( unsigned int  _arg)
virtual

◆ SetScales()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetScales ( ::itk::LevenbergMarquardtOptimizer::ScalesType  _arg)
virtual

◆ SetValueTolerance()

virtual void mitk::LevenbergMarquardtModelFitFunctor::SetValueTolerance ( double  _arg)
virtual
The documentation for this class was generated from the following file: