mitkLevenbergMarquardtModelFitFunctor.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef LEVENBERGMARQUARDTMODELFITFUNCTOR_H
#define LEVENBERGMARQUARDTMODELFITFUNCTOR_H

#include <itkObject.h>
#include <itkLevenbergMarquardtOptimizer.h>

#include "mitkModelBase.h"
#include "mitkModelFitFunctorBase.h"
#include "mitkMVConstrainedCostFunctionDecorator.h"

#include "MitkModelFitExports.h"

namespace mitk
{

  class MITKMODELFIT_EXPORT LevenbergMarquardtModelFitFunctor : public ModelFitFunctorBase
  {
  public:
    typedef LevenbergMarquardtModelFitFunctor Self;
    typedef ModelFitFunctorBase Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;

    itkNewMacro(Self);
    itkTypeMacro(LevenbergMarquardtModelFitFunctor, ModelFitFunctorBase);

    typedef Superclass::InputPixelArrayType InputPixelArrayType;
    typedef Superclass::OutputPixelArrayType OutputPixelArrayType;

    itkSetMacro(Epsilon, double);
    itkSetMacro(GradientTolerance, double);
    itkSetMacro(ValueTolerance, double);
    itkSetMacro(DerivativeStepLength, double);
    itkSetMacro(Iterations, unsigned int);
    itkSetMacro(Scales, ::itk::LevenbergMarquardtOptimizer::ScalesType);

    itkGetMacro(Epsilon, double);
    itkGetMacro(GradientTolerance, double);
    itkGetMacro(ValueTolerance, double);
    itkGetMacro(DerivativeStepLength, double);
    itkGetMacro(Iterations, unsigned int);
    itkGetMacro(Scales, ::itk::LevenbergMarquardtOptimizer::ScalesType);

    itkSetConstObjectMacro(ConstraintChecker, ConstraintCheckerBase);
    itkGetConstObjectMacro(ConstraintChecker, ConstraintCheckerBase);
    itkSetMacro(ActivateFailureThreshold, bool);
    itkGetConstMacro(ActivateFailureThreshold, bool);

    ParameterNamesType GetCriterionNames() const override;

  protected:

    typedef Superclass::ParametersType ParametersType;
    typedef Superclass::SignalType SignalType;

    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;

  private:
    double m_Epsilon;
    double m_GradientTolerance;
    double m_ValueTolerance;
    unsigned int m_Iterations;
    double m_DerivativeStepLength;
    ::itk::LevenbergMarquardtOptimizer::ScalesType m_Scales;

    ConstraintCheckerBase::ConstPointer m_ConstraintChecker;
    bool m_ActivateFailureThreshold;
  };

}


#endif // MODEL_FIT_FUNCTOR_BASE_H