mitkDescriptivePharmacokineticBrixModel.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 mitkDescriptivePharmacokineticBrixModel_h
#define mitkDescriptivePharmacokineticBrixModel_h
 
#include <iostream>
 
#include "mitkModelBase.h"
#include "MitkPharmacokineticsExports.h"
 
namespace mitk
{
 
  class MITKPHARMACOKINETICS_EXPORT DescriptivePharmacokineticBrixModel : public ModelBase
  {
 
  public:
    typedef DescriptivePharmacokineticBrixModel Self;
    typedef ModelBase Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;
 
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    itkTypeMacro(DescriptivePharmacokineticBrixModel, ModelBase);
 
    static const std::string MODEL_DISPLAY_NAME;
 
    static const std::string NAME_PARAMETER_A;
    static const std::string NAME_PARAMETER_kep;
    static const std::string NAME_PARAMETER_kel;
    static const std::string NAME_PARAMETER_BAT;
 
    static const std::string NAME_STATIC_PARAMETER_tau;
    static const std::string NAME_STATIC_PARAMETER_s0;
 
    static const std::string UNIT_PARAMETER_A;
    static const std::string UNIT_PARAMETER_kep;
    static const std::string UNIT_PARAMETER_kel;
    static const std::string UNIT_PARAMETER_BAT;
 
    static const std::string UNIT_STATIC_PARAMETER_tau;
    static const std::string UNIT_STATIC_PARAMETER_s0;
 
    static const unsigned int POSITION_PARAMETER_A;
    static const unsigned int POSITION_PARAMETER_kep;
    static const unsigned int POSITION_PARAMETER_kel;
    static const unsigned int POSITION_PARAMETER_BAT;
 
    static const unsigned int NUMBER_OF_PARAMETERS;
 
    static const unsigned int NUMBER_OF_STATIC_PARAMETERS;
 
    static const std::string MODEL_TYPE;
 
    static const std::string X_AXIS_NAME;
 
    static const std::string X_AXIS_UNIT;
 
    static const std::string Y_AXIS_NAME;
 
    static const std::string Y_AXIS_UNIT;
 
    itkSetMacro(Tau, double);
    itkGetConstReferenceMacro(Tau, double);
 
    itkSetMacro(S0, double);
    itkGetConstReferenceMacro(S0, double);
 
    std::string GetModelDisplayName() const override;
 
    std::string GetModelType() const override;
 
    std::string GetXAxisName() const override;
 
    std::string GetXAxisUnit() const override;
 
    std::string GetYAxisName() const override;
 
    std::string GetYAxisUnit() const override;
 
    ParameterNamesType GetParameterNames() const override;
 
    ParametersSizeType  GetNumberOfParameters() const override;
 
    ParamterUnitMapType GetParameterUnits() const override;
 
 
    ParameterNamesType GetStaticParameterNames() const override;
    ParametersSizeType GetNumberOfStaticParameters() const override;
    ParamterUnitMapType GetStaticParameterUnits() const override;
 
  protected:
    DescriptivePharmacokineticBrixModel();
    ~DescriptivePharmacokineticBrixModel() 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:
    double m_Tau;
 
    double m_S0;
 
    //No copy constructor allowed
    DescriptivePharmacokineticBrixModel(const Self& source);
    void operator=(const Self&);  //purposely not implemented
 
 
  };
}
 
 
#endif