Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
mitkExpDecayOffsetModel.h
Go to the documentation of this file.
1 /*============================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center (DKFZ)
6 All rights reserved.
7 
8 Use of this source code is governed by a 3-clause BSD license that can be
9 found in the LICENSE file.
10 
11 ============================================================================*/
12 
13 #ifndef mitkExpDecayOffsetModel_h
14 #define mitkExpDecayOffsetModel_h
15 
16 #include "mitkModelBase.h"
17 
18 #include "MitkModelFitExports.h"
19 
20 namespace mitk
21 {
22 
28  {
29 
30  public:
35 
38 
40  itkFactorylessNewMacro(Self);
41  itkCloneMacro(Self);
42 
45 
46  static const std::string NAME_PARAMETER_y0;
47  static const std::string NAME_PARAMETER_k;
48  static const std::string NAME_PARAMETER_y_bl;
49 
50  static const unsigned int NUMBER_OF_PARAMETERS;
51 
52  static const std::string UNIT_PARAMETER_y0;
53  static const std::string UNIT_PARAMETER_k;
54  static const std::string UNIT_PARAMETER_y_bl;
55 
56  static const unsigned int POSITION_PARAMETER_y0;
57  static const unsigned int POSITION_PARAMETER_k;
58  static const unsigned int POSITION_PARAMETER_y_bl;
59 
60  static const unsigned int NUMBER_OF_STATIC_PARAMETERS;
61 
62  static const std::string MODEL_DISPLAY_NAME;
63 
64  static const std::string MODEL_TYPE;
65 
66  static const std::string FUNCTION_STRING;
67 
68  static const std::string X_NAME;
69 
70  static const std::string X_AXIS_NAME;
71 
72  static const std::string X_AXIS_UNIT;
73 
74  static const std::string Y_AXIS_NAME;
75 
76  static const std::string Y_AXIS_UNIT;
77 
78  ParameterNamesType GetParameterNames() const override;
79 
80  ParametersSizeType GetNumberOfParameters() const override;
81 
82  ParamterUnitMapType GetParameterUnits() const override;
83 
84  ParameterNamesType GetStaticParameterNames() const override;
85 
86  ParametersSizeType GetNumberOfStaticParameters() const override;
87 
88  std::string GetModelDisplayName() const override;
89 
90  std::string GetModelType() const override;
91 
92  FunctionStringType GetFunctionString() const override;
93 
94  std::string GetXName() const override;
95 
96  std::string GetXAxisName() const override;
97 
98  std::string GetXAxisUnit() const override;
99 
100  std::string GetYAxisName() const override;
101 
102  std::string GetYAxisUnit() const override;
103 
104  protected:
106  ~ExpDecayOffsetModel() override {};
107 
112  itk::LightObject::Pointer InternalClone() const override;
113 
114  ModelResultType ComputeModelfunction(const ParametersType& parameters) const override;
115 
116  void SetStaticParameter(const ParameterNameType& name,
117  const StaticParameterValuesType& values) override;
118  StaticParameterValuesType GetStaticParameterValue(const ParameterNameType& name) const override;
119 
120  private:
121 
122  //No copy constructor allowed
123  ExpDecayOffsetModel(const Self& source);
124  void operator=(const Self&); //purposely not implemented
125 
126  };
127 }
128 
129 #endif
mitk::ModelTraitsInterface::ParamterUnitMapType
std::map< ParameterNameType, std::string > ParamterUnitMapType
Definition: mitkModelTraitsInterface.h:40
mitk::ExpDecayOffsetModel::FUNCTION_STRING
static const std::string FUNCTION_STRING
Definition: mitkExpDecayOffsetModel.h:66
mitk::ExpDecayOffsetModel::X_NAME
static const std::string X_NAME
Definition: mitkExpDecayOffsetModel.h:68
mitk::ExpDecayOffsetModel::Superclass
mitk::ModelBase Superclass
Definition: mitkExpDecayOffsetModel.h:32
mitk::ModelBase::ParameterNamesType
ModelTraitsInterface::ParameterNamesType ParameterNamesType
Definition: mitkModelBase.h:64
mitk::ExpDecayOffsetModel::UNIT_PARAMETER_k
static const std::string UNIT_PARAMETER_k
Definition: mitkExpDecayOffsetModel.h:53
mitk::ExpDecayOffsetModel
Implementation of a general exponential decay model with offset, following the function: y(x) = y-int...
Definition: mitkExpDecayOffsetModel.h:27
mitk::ExpDecayOffsetModel::ParametersSizeType
Superclass::ParametersSizeType ParametersSizeType
Definition: mitkExpDecayOffsetModel.h:37
mitk::ExpDecayOffsetModel::UNIT_PARAMETER_y_bl
static const std::string UNIT_PARAMETER_y_bl
Definition: mitkExpDecayOffsetModel.h:54
mitk::ExpDecayOffsetModel::NUMBER_OF_STATIC_PARAMETERS
static const unsigned int NUMBER_OF_STATIC_PARAMETERS
Definition: mitkExpDecayOffsetModel.h:60
mitk::ExpDecayOffsetModel::Pointer
itk::SmartPointer< Self > Pointer
Definition: mitkExpDecayOffsetModel.h:33
mitk::ExpDecayOffsetModel::NUMBER_OF_PARAMETERS
static const unsigned int NUMBER_OF_PARAMETERS
Definition: mitkExpDecayOffsetModel.h:50
MitkModelFitExports.h
mitk::ExpDecayOffsetModel::UNIT_PARAMETER_y0
static const std::string UNIT_PARAMETER_y0
Definition: mitkExpDecayOffsetModel.h:52
mitk::ModelBase::ParameterNameType
ModelTraitsInterface::ParameterNameType ParameterNameType
Definition: mitkModelBase.h:63
itk::SmartPointer< Self >
mitk::ExpDecayOffsetModel::X_AXIS_UNIT
static const std::string X_AXIS_UNIT
Definition: mitkExpDecayOffsetModel.h:72
mitk::ExpDecayOffsetModel::POSITION_PARAMETER_y_bl
static const unsigned int POSITION_PARAMETER_y_bl
Definition: mitkExpDecayOffsetModel.h:58
mitk::ExpDecayOffsetModel::MODEL_DISPLAY_NAME
static const std::string MODEL_DISPLAY_NAME
Definition: mitkExpDecayOffsetModel.h:62
mitk::ExpDecayOffsetModel::POSITION_PARAMETER_y0
static const unsigned int POSITION_PARAMETER_y0
Definition: mitkExpDecayOffsetModel.h:56
mitk::ExpDecayOffsetModel::POSITION_PARAMETER_k
static const unsigned int POSITION_PARAMETER_k
Definition: mitkExpDecayOffsetModel.h:57
mitk::ExpDecayOffsetModel::Y_AXIS_UNIT
static const std::string Y_AXIS_UNIT
Definition: mitkExpDecayOffsetModel.h:76
MITKMODELFIT_EXPORT
#define MITKMODELFIT_EXPORT
Definition: MitkModelFitExports.h:15
mitkModelBase.h
mitk
Find image slices visible on a given plane.
Definition: RenderingTests.dox:1
mitk::ExpDecayOffsetModel::ExpDecayOffsetModel
ExpDecayOffsetModel()
Definition: mitkExpDecayOffsetModel.h:105
mitk::ExpDecayOffsetModel::ParameterNameType
Superclass::ParameterNameType ParameterNameType
Definition: mitkExpDecayOffsetModel.h:36
mitk::ExpDecayOffsetModel::NAME_PARAMETER_y_bl
static const std::string NAME_PARAMETER_y_bl
Definition: mitkExpDecayOffsetModel.h:48
mitk::ExpDecayOffsetModel::MODEL_TYPE
static const std::string MODEL_TYPE
Definition: mitkExpDecayOffsetModel.h:64
mitk::ExpDecayOffsetModel::~ExpDecayOffsetModel
~ExpDecayOffsetModel() override
Definition: mitkExpDecayOffsetModel.h:106
mitk::ExpDecayOffsetModel::NAME_PARAMETER_y0
static const std::string NAME_PARAMETER_y0
Definition: mitkExpDecayOffsetModel.h:44
mitk::ExpDecayOffsetModel::NAME_PARAMETER_k
static const std::string NAME_PARAMETER_k
Definition: mitkExpDecayOffsetModel.h:47
mitk::ExpDecayOffsetModel::X_AXIS_NAME
static const std::string X_AXIS_NAME
Definition: mitkExpDecayOffsetModel.h:70
mitk::ModelTraitsInterface::FunctionStringType
std::string FunctionStringType
Definition: mitkModelTraitsInterface.h:44
mitk::ExpDecayOffsetModel::Self
ExpDecayOffsetModel Self
Definition: mitkExpDecayOffsetModel.h:31
mitk::ExpDecayOffsetModel::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: mitkExpDecayOffsetModel.h:34
mitk::ModelBase::ParametersSizeType
ModelTraitsInterface::ParametersSizeType ParametersSizeType
Definition: mitkModelBase.h:65
mitk::ExpDecayOffsetModel::Y_AXIS_NAME
static const std::string Y_AXIS_NAME
Definition: mitkExpDecayOffsetModel.h:74
mitk::ModelBase
Base class for (dynamic) models. A model can be used to calculate its signal given the discrete time ...
Definition: mitkModelBase.h:47