mitkModelBase.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 MODELBASE_H
#define MODELBASE_H

#include <iostream>

#include <itkArray.h>
#include <itkArray2D.h>
#include <itkObject.h>

#include "MitkModelFitExports.h"
#include "mitkModelTraitsInterface.h"

namespace mitk
{
  class MITKMODELFIT_EXPORT ModelBase : public itk::Object, public ModelTraitsInterface
  {
  public:
    typedef ModelBase Self;
    typedef itk::Object Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;

    itkTypeMacro(ModelBase, itk::Object);

    typedef ModelTraitsInterface::ModelResultType ModelResultType;
    typedef ModelTraitsInterface::ParameterValueType ParameterValueType;
    typedef ModelTraitsInterface::ParametersType ParametersType;
    typedef itk::Array<double> TimeGridType;
    typedef ModelTraitsInterface::ParameterNameType ParameterNameType;
    typedef ModelTraitsInterface::ParameterNamesType ParameterNamesType;
    typedef ModelTraitsInterface::ParametersSizeType ParametersSizeType;

    typedef ModelTraitsInterface::DerivedParameterNamesType DerivedParameterNamesType;
    typedef ModelTraitsInterface::DerivedParametersSizeType DerivedParametersSizeType;

    typedef double StaticParameterValueType;
    typedef std::vector<StaticParameterValueType> StaticParameterValuesType;
    typedef std::map<ParameterNameType, StaticParameterValuesType> StaticParameterMapType;

    typedef double DerivedParameterValueType;
    typedef std::map<ParameterNameType, DerivedParameterValueType> DerivedParameterMapType;

    ParamterScaleMapType GetParameterScales() const override;

    ParamterUnitMapType GetParameterUnits() const override;

    DerivedParamterScaleMapType GetDerivedParameterScales() const override;

    DerivedParamterUnitMapType GetDerivedParameterUnits() const override;

    std::string GetModelDisplayName() const override;

    std::string GetModelType() const override;

    FunctionStringType GetFunctionString() const override;

    ModellClassIDType GetClassID() const override;

    std::string GetXName() const override;

    std::string GetXAxisName() const override;

    std::string GetXAxisUnit() const override;

    std::string GetYAxisName() const override;

    std::string GetYAxisUnit() const override;

    virtual ParameterNamesType GetStaticParameterNames() const = 0;
    virtual ParametersSizeType GetNumberOfStaticParameters() const = 0;

    virtual ParamterUnitMapType GetStaticParameterUnits() const;


    DerivedParameterNamesType GetDerivedParameterNames() const override;
    DerivedParametersSizeType GetNumberOfDerivedParameters() const override;

    void SetStaticParameters(const StaticParameterMapType& parameters, bool allParameters = true);

    StaticParameterMapType GetStaticParameters() const;

    DerivedParameterMapType GetDerivedParameters(const ParametersType& parameters) const;

    virtual void SetTimeGrid(const TimeGridType& grid);
    itkGetConstReferenceMacro(TimeGrid, TimeGridType);

    ModelResultType GetSignal(const ParametersType& parameters) const;

  protected:

    virtual ModelResultType ComputeModelfunction(const ParametersType& parameters) const = 0;

    virtual bool ValidateModel(std::string& error) const;

    virtual DerivedParameterMapType ComputeDerivedParameters(const ParametersType& parameters) const;

    virtual void SetStaticParameter(const ParameterNameType& name,
                                    const StaticParameterValuesType& values) = 0;
    virtual StaticParameterValuesType GetStaticParameterValue(const ParameterNameType& name) const = 0;

    ModelBase();
    ~ModelBase() override;

    void PrintSelf(std::ostream& os, ::itk::Indent indent) const override;

    //timeGrid in seconds

    TimeGridType m_TimeGrid;

  private:

    //No copy constructor allowed
    ModelBase(const Self& source);
    void operator=(const Self&);  //purposely not implemented
  };
}

#endif // MODELBASE_H