Medical Imaging Interaction Toolkit  2018.4.99-b585543d
Medical Imaging Interaction Toolkit
mitk::LevenbergMarquardtModelFitFunctor Class Reference

#include <mitkLevenbergMarquardtModelFitFunctor.h>

Inheritance diagram for mitk::LevenbergMarquardtModelFitFunctor:
Collaboration diagram for mitk::LevenbergMarquardtModelFitFunctor:

Public Types

typedef LevenbergMarquardtModelFitFunctor Self
 
typedef ModelFitFunctorBase Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::InputPixelArrayType InputPixelArrayType
 
typedef Superclass::OutputPixelArrayType OutputPixelArrayType
 
- Public Types inherited from mitk::ModelFitFunctorBase
typedef ModelFitFunctorBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef ScalarType ParameterImagePixelType
 
typedef std::vector< ParameterImagePixelTypeInputPixelArrayType
 
typedef std::vector< ParameterImagePixelTypeOutputPixelArrayType
 
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 ConstraintCheckerBaseGetConstraintChecker ()
 
virtual void SetActivateFailureThreshold (bool _arg)
 
virtual bool GetActivateFailureThreshold () const
 
ParameterNamesType GetCriterionNames () const override
 
- Public Member Functions inherited from mitk::ModelFitFunctorBase
OutputPixelArrayType Compute (const InputPixelArrayType &value, const ModelBase *model, const ModelBase::ParametersType &initialParameters) const
 
unsigned int GetNumberOfOutputs (const ModelBase *model) const
 
ParameterNamesType GetEvaluationParameterNames () const
 
void ResetEvaluationParameters ()
 
void RegisterEvaluationParameter (const std::string &parameterName, SVModelFitCostFunction *evaluationCostFunction)
 
const SVModelFitCostFunctionGetEvaluationParameterCostFunction (const std::string &parameterName) const
 
ParameterNamesType GetDebugParameterNames () const
 
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, ParameterImagePixelTypeDebugParameterMapType
 

Protected Member Functions

 LevenbergMarquardtModelFitFunctor ()
 
 ~LevenbergMarquardtModelFitFunctor () override
 
ParametersType DoModelFit (const SignalType &value, const ModelBase *model, const ModelBase::ParametersType &initialParameters, DebugParameterMapType &debugParameters) const override
 
OutputPixelArrayType GetCriteria (const ModelBase *model, const ParametersType &parameters, const SignalType &sample) const override
 
virtual MVModelFitCostFunction::Pointer GenerateCostFunction (const SignalType &value, const ModelBase *model) const
 
ParameterNamesType DefineDebugParameterNames () const override
 
- Protected Member Functions inherited from mitk::ModelFitFunctorBase
 ModelFitFunctorBase ()
 
 ~ModelFitFunctorBase () override
 
OutputPixelArrayType GetDerivedParameters (const ModelBase *model, const ParametersType &parameters) const
 
OutputPixelArrayType GetEvaluationParameters (const ModelBase *model, const ParametersType &parameters, const SignalType &sample) const
 

Detailed Description

Definition at line 28 of file mitkLevenbergMarquardtModelFitFunctor.h.

Member Typedef Documentation

◆ ConstPointer

◆ InputPixelArrayType

◆ OutputPixelArrayType

◆ ParametersType

◆ Pointer

◆ Self

◆ SignalType

◆ Superclass

Constructor & Destructor Documentation

◆ LevenbergMarquardtModelFitFunctor()

mitk::LevenbergMarquardtModelFitFunctor::LevenbergMarquardtModelFitFunctor ( )
protected

◆ ~LevenbergMarquardtModelFitFunctor()

mitk::LevenbergMarquardtModelFitFunctor::~LevenbergMarquardtModelFitFunctor ( )
overrideprotected

Member Function Documentation

◆ DefineDebugParameterNames()

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

Returns names of the depug parameters generated by the functor. Will be called by GetDebugParameterNames, if debug is activated.

Implements mitk::ModelFitFunctorBase.

Definition at line 84 of file mitkLevenbergMarquardtModelFitFunctor.cpp.

References DoModelFit().

◆ DoModelFit()

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

Internal Method called by Compute(). It does the real fit and returns the found parameters. Additionally it must return its debug parameter via debugParameters.

Postcondition
If m_DebugParameterMaps is true, it must return all debug parameters defined by GetDebugParameterNames() via debugParameters.
Parameters
valueSignal the Model should be fitted against
modelPointer to the model that should be fitted
initialParametersInitial modal parameters for the fit
[out]debugParametersMap containing all debug parameters for the done fit (must only valid if m_DebugParameterMap is true)

Implements mitk::ModelFitFunctorBase.

Definition at line 101 of file mitkLevenbergMarquardtModelFitFunctor.cpp.

References GenerateCostFunction(), mitk::ModelFitFunctorBase::GetDebugParameterMaps(), mitk::ModelTraitsInterface::GetNumberOfParameters(), mitk::MVConstrainedCostFunctionDecorator::GetPenaltyRatio(), MITK_DEBUG, and mitkThrow.

Referenced by DefineDebugParameterNames().

◆ GenerateCostFunction()

mitk::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

Definition at line 55 of file mitkLevenbergMarquardtModelFitFunctor.cpp.

References mitk::SquaredDifferencesFitCostFunction::New(), and mitk::MVConstrainedCostFunctionDecorator::New().

Referenced by DoModelFit().

◆ 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()

mitk::LevenbergMarquardtModelFitFunctor::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 thar dove the fit. must be implemented be concrete functor classes.

Implements mitk::ModelFitFunctorBase.

Definition at line 41 of file mitkLevenbergMarquardtModelFitFunctor.cpp.

References mitk::SumOfSquaredDifferencesFitCostFunction::New().

Referenced by GetCriterionNames().

◆ GetCriterionNames()

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

Returns names of the criterion used to fit the model.

Implements mitk::ModelFitFunctorBase.

Definition at line 32 of file mitkLevenbergMarquardtModelFitFunctor.cpp.

References GetCriteria().

Referenced by ~LevenbergMarquardtModelFitFunctor().

◆ 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()

◆ 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 files: