Medical Imaging Interaction Toolkit  2024.06.99-60d9b802
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 
38  {
39 
40  public:
45 
48 
50  itkFactorylessNewMacro(Self);
51  itkCloneMacro(Self);
52 
54  itkTypeMacro(GenericParamModel, ModelBase);
55 
56  static const std::string NAME_STATIC_PARAMETER_number;
57 
58  std::string GetModelDisplayName() const override;
59 
60  std::string GetModelType() const override;
61 
62  FunctionStringType GetFunctionString() const override;
63  itkSetStringMacro(FunctionString);
64 
66  itkSetClampMacro(NumberOfParameters, ParametersSizeType, 1, 10);
67 
68  std::string GetXName() const override;
69 
70  ParameterNamesType GetParameterNames() const override;
71 
72  ParametersSizeType GetNumberOfParameters() const override;
73 
74  ParamterUnitMapType GetParameterUnits() const override;
75 
76  ParameterNamesType GetStaticParameterNames() const override;
77 
78  ParametersSizeType GetNumberOfStaticParameters() const override;
79 
80  protected:
82  ~GenericParamModel() override {};
83 
88  itk::LightObject::Pointer InternalClone() const override;
89 
90  ModelResultType ComputeModelfunction(const ParametersType& parameters) const override;
91 
92  void SetStaticParameter(const ParameterNameType& name,
93  const StaticParameterValuesType& values) override;
94  StaticParameterValuesType GetStaticParameterValue(const ParameterNameType& name) const override;
95 
96  private:
98  FunctionStringType m_FunctionString;
99 
101  ParametersSizeType m_NumberOfParameters;
102 
103  //No copy constructor allowed
104  GenericParamModel(const Self& source);
105  void operator=(const Self&); //purposely not implemented
106 
107  };
108 }
109 
110 #endif
mitk::ModelTraitsInterface::ParamterUnitMapType
std::map< ParameterNameType, std::string > ParamterUnitMapType
Definition: mitkModelTraitsInterface.h:40
mitk::GenericParamModel::NAME_STATIC_PARAMETER_number
static const std::string NAME_STATIC_PARAMETER_number
Definition: mitkGenericParamModel.h:54
mitk::GenericParamModel::ParameterNameType
Superclass::ParameterNameType ParameterNameType
Definition: mitkGenericParamModel.h:46
mitk::ModelBase::ParameterNamesType
ModelTraitsInterface::ParameterNamesType ParameterNamesType
Definition: mitkModelBase.h:64
mitk::GenericParamModel::ParametersSizeType
Superclass::ParametersSizeType ParametersSizeType
Definition: mitkGenericParamModel.h:47
MitkModelFitExports.h
mitk::ModelBase::ParameterNameType
ModelTraitsInterface::ParameterNameType ParameterNameType
Definition: mitkModelBase.h:63
itk::SmartPointer< Self >
mitk::GenericParamModel::Superclass
mitk::ModelBase Superclass
Definition: mitkGenericParamModel.h:42
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::GenericParamModel::~GenericParamModel
~GenericParamModel() override
Definition: mitkGenericParamModel.h:82
mitk::GenericParamModel::Pointer
itk::SmartPointer< Self > Pointer
Definition: mitkGenericParamModel.h:43
mitk::ModelTraitsInterface::FunctionStringType
std::string FunctionStringType
Definition: mitkModelTraitsInterface.h:44
mitk::GenericParamModel
Definition: mitkGenericParamModel.h:37
mitk::ModelBase::ParametersSizeType
ModelTraitsInterface::ParametersSizeType ParametersSizeType
Definition: mitkModelBase.h:65
mitk::GenericParamModel::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: mitkGenericParamModel.h:44
mitk::GenericParamModel::Self
GenericParamModel Self
Definition: mitkGenericParamModel.h:41
mitk::ModelBase
Base class for (dynamic) models. A model can be used to calculate its signal given the discrete time ...
Definition: mitkModelBase.h:47