mitkAIFBasedModelBase.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 mitkAIFBasedModelBase_h
#define mitkAIFBasedModelBase_h
 
 
#include "MitkPharmacokineticsExports.h"
#include "mitkModelBase.h"
#include "itkArray2D.h"
 
namespace mitk
{
 
  class MITKPHARMACOKINETICS_EXPORT AIFBasedModelBase : public mitk::ModelBase
  {
  public:
 
    typedef AIFBasedModelBase Self;
    typedef ModelBase Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;
 
 
    itkTypeMacro(AIFBasedModelBase, ModelBase);
 
 
    static const std::string NAME_STATIC_PARAMETER_AIF;
    static const std::string NAME_STATIC_PARAMETER_AIFTimeGrid;
 
    static const std::string UNIT_STATIC_PARAMETER_AIF;
    static const std::string UNIT_STATIC_PARAMETER_AIFTimeGrid;
 
    static const unsigned int NUMBER_OF_STATIC_PARAMETERS;
 
    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;
 
    typedef itk::Array<double> AterialInputFunctionType;
 
    itkGetConstReferenceMacro(AterialInputFunctionValues, AterialInputFunctionType);
    itkGetConstReferenceMacro(AterialInputFunctionTimeGrid, TimeGridType);
 
    itkSetMacro(AterialInputFunctionValues, AterialInputFunctionType);
    itkSetMacro(AterialInputFunctionTimeGrid, TimeGridType);
 
    std::string GetXAxisName() const override;
 
    std::string GetXAxisUnit() const override;
 
    std::string GetYAxisName() const override;
 
    std::string GetYAxisUnit() const override;
 
    const TimeGridType& GetCurrentAterialInputFunctionTimeGrid() const;
 
    const AterialInputFunctionType GetAterialInputFunction(TimeGridType currentTimeGrid) const;
 
    ParameterNamesType GetStaticParameterNames() const override;
    ParametersSizeType GetNumberOfStaticParameters() const override;
    ParamterUnitMapType GetStaticParameterUnits() const override;
 
 
  protected:
    AIFBasedModelBase();
    ~AIFBasedModelBase() override;
 
    bool ValidateModel(std::string& error) const override;
 
    void PrintSelf(std::ostream& os, ::itk::Indent indent) const override;
 
    void SetStaticParameter(const ParameterNameType& name,
                                    const StaticParameterValuesType& values) override;
 
    StaticParameterValuesType GetStaticParameterValue(const ParameterNameType& name) const
    override;
 
    TimeGridType m_AterialInputFunctionTimeGrid;
    AterialInputFunctionType m_AterialInputFunctionValues;
 
 
  private:
 
 
    //No copy constructor allowed
    AIFBasedModelBase(const Self& source);
    void operator=(const Self&);  //purposely not implemented
 
 
  };
}
#endif