mitkNumericTwoCompartmentExchangeModel.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 mitkNumericTwoCompartmentExchangeModel_h
#define mitkNumericTwoCompartmentExchangeModel_h
 
#include "mitkAIFBasedModelBase.h"
#include "MitkPharmacokineticsExports.h"
 
 
namespace mitk
{
  class MITKPHARMACOKINETICS_EXPORT NumericTwoCompartmentExchangeModel : public AIFBasedModelBase
  {
 
  public:
    typedef NumericTwoCompartmentExchangeModel Self;
    typedef AIFBasedModelBase Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;
 
 
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    itkTypeMacro(NumericTwoCompartmentExchangeModel, ModelBase);
 
    typedef std::vector<double> state_type;
 
 
    static const std::string MODEL_DISPLAY_NAME;
 
    static const std::string NAME_PARAMETER_F;
    static const std::string NAME_PARAMETER_PS;
    static const std::string NAME_PARAMETER_ve;
    static const std::string NAME_PARAMETER_vp;
    static const std::string NAME_STATIC_PARAMETER_ODEINTStepSize;
 
    static const std::string UNIT_PARAMETER_F;
    static const std::string UNIT_PARAMETER_PS;
    static const std::string UNIT_PARAMETER_ve;
    static const std::string UNIT_PARAMETER_vp;
 
    static const unsigned int POSITION_PARAMETER_F;
    static const unsigned int POSITION_PARAMETER_PS;
    static const unsigned int POSITION_PARAMETER_ve;
    static const unsigned int POSITION_PARAMETER_vp;
 
    static const unsigned int NUMBER_OF_PARAMETERS;
 
    std::string GetModelDisplayName() const override;
 
    std::string GetModelType() const override;
 
    itkGetConstReferenceMacro(ODEINTStepSize, double);
    itkSetMacro(ODEINTStepSize, double);
 
 
    ParameterNamesType GetParameterNames() const override;
    ParametersSizeType  GetNumberOfParameters() const override;
 
    ParamterUnitMapType GetParameterUnits() const override;
 
    ParameterNamesType GetStaticParameterNames() const override;
    ParametersSizeType GetNumberOfStaticParameters() const override;
 
 
  protected:
    NumericTwoCompartmentExchangeModel();
    ~NumericTwoCompartmentExchangeModel() override;
 
    itk::LightObject::Pointer InternalClone() const override;
 
    ModelResultType ComputeModelfunction(const ParametersType& parameters) const override;
 
    void SetStaticParameter(const ParameterNameType& name, const StaticParameterValuesType& values) override;
    StaticParameterValuesType GetStaticParameterValue(const ParameterNameType& name) const override;
 
    void PrintSelf(std::ostream& os, ::itk::Indent indent) const override;
 
  private:
 
 
 
    //No copy constructor allowed
    NumericTwoCompartmentExchangeModel(const Self& source);
    void operator=(const Self&);  //purposely not implemented
 
    double m_ODEINTStepSize;
 
 
 
  };
}
 
#endif