mitkModelFitFunctorBase.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 mitkModelFitFunctorBase_h
#define mitkModelFitFunctorBase_h
 
#include <itkObject.h>
 
#include <mitkVector.h>
 
#include <mitkModelBase.h>
#include <mitkSVModelFitCostFunction.h>
 
#include <MitkModelFitExports.h>
 
#include <mutex>
 
namespace mitk
{
 
  class MITKMODELFIT_EXPORT ModelFitFunctorBase: public ::itk::Object
  {
  public:
    typedef ModelFitFunctorBase Self;
    typedef itk::Object Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;
 
    itkTypeMacro(ModelFitFunctorBase, itk::Object);
 
    typedef ScalarType ParameterImagePixelType;
    typedef std::vector<ParameterImagePixelType> InputPixelArrayType;
    typedef std::vector<ParameterImagePixelType> OutputPixelArrayType;
 
    OutputPixelArrayType Compute(const InputPixelArrayType& value, const ModelBase* model,
                                 const ModelBase::ParametersType& initialParameters) const;
 
    unsigned int GetNumberOfOutputs(const ModelBase* model) const;
 
    typedef ModelBase::ParameterNamesType ParameterNamesType;
 
    ParameterNamesType GetEvaluationParameterNames() const;
 
    void ResetEvaluationParameters();
 
    void RegisterEvaluationParameter(const std::string& parameterName,
                                     SVModelFitCostFunction* evaluationCostFunction);
 
    const SVModelFitCostFunction* GetEvaluationParameterCostFunction(const std::string& parameterName)
    const;
 
    virtual ParameterNamesType GetCriterionNames() const = 0 ;
 
    ParameterNamesType GetDebugParameterNames() const;
 
    itkBooleanMacro(DebugParameterMaps);
    itkSetMacro(DebugParameterMaps, bool);
    itkGetConstMacro(DebugParameterMaps, bool);
 
  protected:
 
    typedef ModelBase::ParametersType ParametersType;
    typedef ModelFitCostFunctionInterface::SignalType SignalType;
 
    ModelFitFunctorBase();
 
    ~ModelFitFunctorBase() override;
 
    virtual OutputPixelArrayType GetCriteria(const ModelBase* model, const ParametersType& parameters,
        const SignalType& sample) const = 0;
 
    OutputPixelArrayType GetDerivedParameters(const ModelBase* model,
        const ParametersType& parameters) const;
 
    OutputPixelArrayType GetEvaluationParameters(const ModelBase* model,
        const ParametersType& parameters, const SignalType& sample) const;
 
    typedef std::map<std::string, ParameterImagePixelType> DebugParameterMapType;
 
    virtual ParametersType DoModelFit(const SignalType& value, const ModelBase* model,
                                      const ModelBase::ParametersType& initialParameters,
                                      DebugParameterMapType& debugParameters) const = 0;
 
    virtual ParameterNamesType DefineDebugParameterNames()const = 0;
 
  private:
 
    typedef std::map<std::string, SVModelFitCostFunction::Pointer> CostFunctionMapType;
    CostFunctionMapType m_CostFunctionMap;
    bool m_DebugParameterMaps;
    mutable std::mutex m_Mutex;
  };
 
}
 
 
#endif