Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitkGenericParamModel.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 mitkGenericParamModel_h
14 #define mitkGenericParamModel_h
15 
16 #include <mitkModelBase.h>
17 
18 #include <MitkModelFitExports.h>
19 
20 namespace mitk
21 {
22 
43  {
44 
45  public:
50 
53 
55  itkFactorylessNewMacro(Self);
56  itkCloneMacro(Self);
57 
59  itkTypeMacro(GenericParamModel, ModelBase);
60 
61  static const std::string NAME_STATIC_PARAMETER_number;
62 
63  std::string GetModelDisplayName() const override;
64 
65  std::string GetModelType() const override;
66 
68  itkSetStringMacro(FunctionString);
69 
71  itkSetClampMacro(NumberOfParameters, ParametersSizeType, 1, 10);
72 
73  std::string GetXName() const override;
74 
76 
78 
80 
82 
84 
85  protected:
87  ~GenericParamModel() override {};
88 
90 
92 
93  ModelResultType ComputeModelfunction(const ParametersType& parameters) const override;
94 
96  const StaticParameterValuesType& values) override;
98 
99  private:
101  FunctionStringType m_FunctionString;
102 
104  ParametersSizeType m_NumberOfParameters;
105 
106  void operator=(const Self&); //purposely not implemented
107 
108  };
109 }
110 
111 #endif
#define MITKMODELFIT_EXPORT
Model that uses a user-specified formula string as its model function.
StaticParameterValuesType GetStaticParameterValue(const ParameterNameType &name) const override
Retrieves a single static parameter value by name.
ParameterNamesType GetStaticParameterNames() const override
Returns the names of static parameters used when computing the signal.
itk::SmartPointer< Self > Pointer
std::string GetXName() const override
Returns the name of the independent variable used by the model (e.g. "x").
std::string GetModelType() const override
Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic").
static const std::string NAME_STATIC_PARAMETER_number
void SetStaticParameter(const ParameterNameType &name, const StaticParameterValuesType &values) override
Sets a single static parameter by name.
std::string GetModelDisplayName() const override
Returns the human-readable display name of the model.
mitkCloneMacro(GenericParamModel)
ParametersSizeType GetNumberOfParameters() const override
Returns the number of parameters that must be defined when using the model to compute the signal (Get...
itk::SmartPointer< const Self > ConstPointer
GenericParamModel(const GenericParamModel &source)
Superclass::ParametersSizeType ParametersSizeType
ParamterUnitMapType GetParameterUnits() const override
Returns the unit strings for all model parameters.
FunctionStringType GetFunctionString() const override
Returns a parsable function string representing the model equation.
Superclass::ParameterNameType ParameterNameType
ParametersSizeType GetNumberOfStaticParameters() const override
Returns the number of static parameters.
ParameterNamesType GetParameterNames() const override
Returns the names of parameters that must be defined when using the model to compute the signal (GetS...
ModelResultType ComputeModelfunction(const ParametersType &parameters) const override
Computes the model function for the given parameters.
Base class for (dynamic) models.
Definition: mitkModelBase.h:56
ModelTraitsInterface::ParametersSizeType ParametersSizeType
Definition: mitkModelBase.h:73
ModelTraitsInterface::ParameterNamesType ParameterNamesType
Definition: mitkModelBase.h:72
std::vector< StaticParameterValueType > StaticParameterValuesType
Definition: mitkModelBase.h:79
ModelTraitsInterface::ParameterNameType ParameterNameType
Definition: mitkModelBase.h:71
ModelTraitsInterface::ModelResultType ModelResultType
Definition: mitkModelBase.h:63
ModelTraitsInterface::ParametersType ParametersType
Definition: mitkModelBase.h:67
std::string FunctionStringType
Type for the function string representation of the model.
std::map< ParameterNameType, std::string > ParamterUnitMapType
Map type associating parameter names to their unit strings.
Find image slices visible on a given plane.