Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitkExponentialSaturationModel.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 __MITK_EXPONENTIAL_SATURATION_MODEL_H_
14 #define __MITK_EXPONENTIAL_SATURATION_MODEL_H_
15 
16 #include "mitkModelBase.h"
17 
18 #include "MitkModelFitExports.h"
19 
20 namespace mitk
21 {
22 
27  {
28 
29  public:
34 
37 
39  itkFactorylessNewMacro(Self);
40  itkCloneMacro(Self);
41 
44 
45  static const std::string NAME_PARAMETER_BAT;
46  static const std::string NAME_PARAMETER_y_bl;
47  static const std::string NAME_PARAMETER_y_fin;
48  static const std::string NAME_PARAMETER_k;
49 
50  static const unsigned int NUMBER_OF_PARAMETERS;
51 
52  static const std::string UNIT_PARAMETER_BAT;
53  static const std::string UNIT_PARAMETER_y_bl;
54  static const std::string UNIT_PARAMETER_y_fin;
55  static const std::string UNIT_PARAMETER_k;
56 
57  static const unsigned int POSITION_PARAMETER_BAT;
58  static const unsigned int POSITION_PARAMETER_y_bl;
59  static const unsigned int POSITION_PARAMETER_y_fin;
60  static const unsigned int POSITION_PARAMETER_k;
61 
62  static const unsigned int NUMBER_OF_STATIC_PARAMETERS;
63 
64  static const std::string MODEL_DISPLAY_NAME;
65 
66  static const std::string MODEL_TYPE;
67 
68  static const std::string FUNCTION_STRING;
69 
70  static const std::string X_NAME;
71 
72  static const std::string X_AXIS_NAME;
73 
74  static const std::string X_AXIS_UNIT;
75 
76  static const std::string Y_AXIS_NAME;
77 
78  static const std::string Y_AXIS_UNIT;
79 
80  ParameterNamesType GetParameterNames() const override;
81 
82  ParametersSizeType GetNumberOfParameters() const override;
83 
84  ParamterUnitMapType GetParameterUnits() const override;
85 
86  ParameterNamesType GetStaticParameterNames() const override;
87 
88  ParametersSizeType GetNumberOfStaticParameters() const override;
89 
90  std::string GetModelDisplayName() const override;
91 
92  std::string GetModelType() const override;
93 
94  FunctionStringType GetFunctionString() const override;
95 
96  std::string GetXName() const override;
97 
98  std::string GetXAxisName() const override;
99 
100  std::string GetXAxisUnit() const override;
101 
102  std::string GetYAxisName() const override;
103 
104  std::string GetYAxisUnit() const override;
105 
106 
107  protected:
110 
115  itk::LightObject::Pointer InternalClone() const override;
116 
117  ModelResultType ComputeModelfunction(const ParametersType& parameters) const override;
118 
119  void SetStaticParameter(const ParameterNameType& name,
120  const StaticParameterValuesType& values) override;
121  StaticParameterValuesType GetStaticParameterValue(const ParameterNameType& name) const override;
122 
123  private:
124 
125  //No copy constructor allowed
126  ExponentialSaturationModel(const Self& source);
127  void operator=(const Self&); //purposely not implemented
128 
129  };
130 }
131 
132 #endif
mitk::ModelTraitsInterface::ParamterUnitMapType
std::map< ParameterNameType, std::string > ParamterUnitMapType
Definition: mitkModelTraitsInterface.h:40
mitk::ModelBase::ParameterNamesType
ModelTraitsInterface::ParameterNamesType ParameterNamesType
Definition: mitkModelBase.h:64
mitk::ExponentialSaturationModel::UNIT_PARAMETER_y_fin
static const std::string UNIT_PARAMETER_y_fin
Definition: mitkExponentialSaturationModel.h:54
MitkModelFitExports.h
mitk::ExponentialSaturationModel::NAME_PARAMETER_BAT
static const std::string NAME_PARAMETER_BAT
Definition: mitkExponentialSaturationModel.h:43
mitk::ExponentialSaturationModel::POSITION_PARAMETER_BAT
static const unsigned int POSITION_PARAMETER_BAT
Definition: mitkExponentialSaturationModel.h:57
mitk::ModelBase::ParameterNameType
ModelTraitsInterface::ParameterNameType ParameterNameType
Definition: mitkModelBase.h:63
mitk::ExponentialSaturationModel::Y_AXIS_NAME
static const std::string Y_AXIS_NAME
Definition: mitkExponentialSaturationModel.h:76
mitk::ExponentialSaturationModel::X_AXIS_UNIT
static const std::string X_AXIS_UNIT
Definition: mitkExponentialSaturationModel.h:74
mitk::ExponentialSaturationModel::POSITION_PARAMETER_k
static const unsigned int POSITION_PARAMETER_k
Definition: mitkExponentialSaturationModel.h:60
itk::SmartPointer< Self >
mitk::ExponentialSaturationModel::ExponentialSaturationModel
ExponentialSaturationModel()
Definition: mitkExponentialSaturationModel.h:108
mitk::ExponentialSaturationModel::POSITION_PARAMETER_y_fin
static const unsigned int POSITION_PARAMETER_y_fin
Definition: mitkExponentialSaturationModel.h:59
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::ExponentialSaturationModel::ParametersSizeType
Superclass::ParametersSizeType ParametersSizeType
Definition: mitkExponentialSaturationModel.h:36
mitk::ExponentialSaturationModel::NUMBER_OF_STATIC_PARAMETERS
static const unsigned int NUMBER_OF_STATIC_PARAMETERS
Definition: mitkExponentialSaturationModel.h:62
mitk::ExponentialSaturationModel::~ExponentialSaturationModel
~ExponentialSaturationModel() override
Definition: mitkExponentialSaturationModel.h:109
mitk::ExponentialSaturationModel::NAME_PARAMETER_y_fin
static const std::string NAME_PARAMETER_y_fin
Definition: mitkExponentialSaturationModel.h:47
mitk::ExponentialSaturationModel::Y_AXIS_UNIT
static const std::string Y_AXIS_UNIT
Definition: mitkExponentialSaturationModel.h:78
mitk::ExponentialSaturationModel::UNIT_PARAMETER_k
static const std::string UNIT_PARAMETER_k
Definition: mitkExponentialSaturationModel.h:55
mitk::ExponentialSaturationModel::MODEL_DISPLAY_NAME
static const std::string MODEL_DISPLAY_NAME
Definition: mitkExponentialSaturationModel.h:64
mitk::ExponentialSaturationModel::NAME_PARAMETER_k
static const std::string NAME_PARAMETER_k
Definition: mitkExponentialSaturationModel.h:48
mitk::ExponentialSaturationModel::ParameterNameType
Superclass::ParameterNameType ParameterNameType
Definition: mitkExponentialSaturationModel.h:35
mitk::ModelTraitsInterface::FunctionStringType
std::string FunctionStringType
Definition: mitkModelTraitsInterface.h:44
mitk::ExponentialSaturationModel::POSITION_PARAMETER_y_bl
static const unsigned int POSITION_PARAMETER_y_bl
Definition: mitkExponentialSaturationModel.h:58
mitk::ExponentialSaturationModel::X_NAME
static const std::string X_NAME
Definition: mitkExponentialSaturationModel.h:70
mitk::ExponentialSaturationModel::X_AXIS_NAME
static const std::string X_AXIS_NAME
Definition: mitkExponentialSaturationModel.h:72
mitk::ExponentialSaturationModel::UNIT_PARAMETER_BAT
static const std::string UNIT_PARAMETER_BAT
Definition: mitkExponentialSaturationModel.h:52
mitk::ModelBase::ParametersSizeType
ModelTraitsInterface::ParametersSizeType ParametersSizeType
Definition: mitkModelBase.h:65
mitk::ExponentialSaturationModel::NUMBER_OF_PARAMETERS
static const unsigned int NUMBER_OF_PARAMETERS
Definition: mitkExponentialSaturationModel.h:50
mitk::ExponentialSaturationModel::MODEL_TYPE
static const std::string MODEL_TYPE
Definition: mitkExponentialSaturationModel.h:66
mitk::ExponentialSaturationModel::NAME_PARAMETER_y_bl
static const std::string NAME_PARAMETER_y_bl
Definition: mitkExponentialSaturationModel.h:46
mitk::ExponentialSaturationModel::Superclass
mitk::ModelBase Superclass
Definition: mitkExponentialSaturationModel.h:31
mitk::ExponentialSaturationModel::Self
ExponentialSaturationModel Self
Definition: mitkExponentialSaturationModel.h:30
mitk::ModelBase
Base class for (dynamic) models. A model can be used to calculate its signal given the discrete time ...
Definition: mitkModelBase.h:47
mitk::ExponentialSaturationModel
This generic model has the form: if x<onset: y(x) = baseline , else: y(x) = baseline + (y_final-basel...
Definition: mitkExponentialSaturationModel.h:26
mitk::ExponentialSaturationModel::UNIT_PARAMETER_y_bl
static const std::string UNIT_PARAMETER_y_bl
Definition: mitkExponentialSaturationModel.h:53
mitk::ExponentialSaturationModel::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: mitkExponentialSaturationModel.h:33
mitk::ExponentialSaturationModel::Pointer
itk::SmartPointer< Self > Pointer
Definition: mitkExponentialSaturationModel.h:32
mitk::ExponentialSaturationModel::FUNCTION_STRING
static const std::string FUNCTION_STRING
Definition: mitkExponentialSaturationModel.h:68