|
Medical Imaging Interaction Toolkit
2026.06.00
Medical Imaging Interaction Toolkit
|
Simple model of exponential decay: y(x) = y-intercept * exp(-x/lambda). More...
#include <mitkExponentialDecayModel.h>


Public Member Functions | |
| Pointer | Clone () const |
| virtual const char * | GetClassName () const |
| ParameterNamesType | GetParameterNames () const override |
| Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()). More... | |
| ParametersSizeType | GetNumberOfParameters () const override |
| Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()). More... | |
| ParamterUnitMapType | GetParameterUnits () const override |
| Returns the unit strings for all model parameters. More... | |
| ParameterNamesType | GetDerivedParameterNames () const override |
| Returns the names of derived parameters that can be computed by the model. More... | |
| ParametersSizeType | GetNumberOfDerivedParameters () const override |
| Returns the number of derived parameters that can be computed by the model. More... | |
| ParamterUnitMapType | GetDerivedParameterUnits () const override |
| Returns the unit strings for all derived parameters. More... | |
| ParameterNamesType | GetStaticParameterNames () const override |
| Returns the names of static parameters used when computing the signal. More... | |
| ParametersSizeType | GetNumberOfStaticParameters () const override |
| Returns the number of static parameters. More... | |
| std::string | GetModelDisplayName () const override |
| Returns the human-readable display name of the model. More... | |
| std::string | GetModelType () const override |
| Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic"). More... | |
| FunctionStringType | GetFunctionString () const override |
| Returns a parsable function string representing the model equation. More... | |
| std::string | GetXName () const override |
| Returns the name of the independent variable used by the model (e.g. "x"). More... | |
| std::string | GetXAxisName () const override |
| Returns the display name of the x-axis (e.g. "Time"). More... | |
| std::string | GetXAxisUnit () const override |
| Returns the unit of the x-axis (e.g. "s", "ms"). More... | |
| std::string | GetYAxisName () const override |
| Returns the display name of the y-axis (e.g. "Signal Intensity"). More... | |
| std::string | GetYAxisUnit () const override |
| Returns the unit of the y-axis. More... | |
| mitk::ModelBase::DerivedParameterMapType | ComputeDerivedParameters (const mitk::ModelBase::ParametersType ¶meters) const override |
| Computes derived parameters from the given model parameters. More... | |
Public Member Functions inherited from mitk::ModelBase | |
| ParamterScaleMapType | GetParameterScales () const override |
| Default implementation returns a scale of 1.0 for every defined parameter. More... | |
| ParamterUnitMapType | GetParameterUnits () const override |
| Default implementation returns no unit string ("") for every defined parameter. More... | |
| DerivedParamterScaleMapType | GetDerivedParameterScales () const override |
| Default implementation returns a scale of 1.0 for every defined derived parameter. More... | |
| DerivedParamterUnitMapType | GetDerivedParameterUnits () const override |
| Default implementation returns no unit string ("") for every defined derived parameter. More... | |
| std::string | GetModelDisplayName () const override |
| Default implementation returns GetClassID as display name. More... | |
| std::string | GetModelType () const override |
| Default implementation returns "Unknown" as model type. More... | |
| FunctionStringType | GetFunctionString () const override |
| Default implementation returns an empty function string. More... | |
| ModellClassIDType | GetClassID () const override |
| Default implementation returns the class name of the concrete instance as ID. More... | |
| std::string | GetXName () const override |
| Default implementation returns an empty string. More... | |
| std::string | GetXAxisName () const override |
| Default implementation returns an empty string. More... | |
| std::string | GetXAxisUnit () const override |
| Default implementation returns an empty string. More... | |
| std::string | GetYAxisName () const override |
| Default implementation returns an empty string. More... | |
| std::string | GetYAxisUnit () const override |
| Default implementation returns an empty string. More... | |
| virtual ParamterUnitMapType | GetStaticParameterUnits () const |
| Default implementation returns no unit string ("") for every defined static parameter. More... | |
| DerivedParameterNamesType | GetDerivedParameterNames () const override |
| Returns the names of derived parameters that can be computed by the model. More... | |
| DerivedParametersSizeType | GetNumberOfDerivedParameters () const override |
| Returns the number of derived parameters that can be computed by the model. More... | |
| void | SetStaticParameters (const StaticParameterMapType ¶meters, bool allParameters=true) |
| Sets the static parameters of the model before it is used. More... | |
| StaticParameterMapType | GetStaticParameters () const |
| Retrieves the static parameters of the model (e.g. for serialization). More... | |
| DerivedParameterMapType | GetDerivedParameters (const ParametersType ¶meters) const |
| Computes all derived parameters for the given model parameters. More... | |
| virtual void | SetTimeGrid (const TimeGridType &grid) |
| Sets the time grid of the model. More... | |
| virtual const TimeGridType & | GetTimeGrid () |
| Gets the time grid of the model. More... | |
| ModelResultType | GetSignal (const ParametersType ¶meters) const |
| Computes and returns the model signal for the given parameters. More... | |
Static Public Member Functions | |
| static Pointer | New () |
Static Public Attributes | |
| static const std::string | NAME_PARAMETER_y0 |
| Name string for the y-intercept parameter. More... | |
| static const std::string | NAME_PARAMETER_lambda |
| Name string for the decay constant parameter (lambda). More... | |
| static const unsigned int | NUMBER_OF_PARAMETERS |
| Total number of model parameters (2). More... | |
| static const std::string | UNIT_PARAMETER_y0 |
| Unit of the y-intercept parameter. More... | |
| static const std::string | UNIT_PARAMETER_lambda |
| Unit of the decay constant parameter. More... | |
| static const unsigned int | POSITION_PARAMETER_y0 |
| Index position of y-intercept in the parameter vector. More... | |
| static const unsigned int | POSITION_PARAMETER_lambda |
| Index position of lambda in the parameter vector. More... | |
| static const std::string | NAME_DERIVED_PARAMETER_k |
| Name string for the derived rate constant parameter (k = 1/lambda). More... | |
| static const unsigned int | NUMBER_OF_DERIVED_PARAMETERS |
| Total number of derived parameters (1). More... | |
| static const std::string | UNIT_DERIVED_PARAMETER_k |
| Unit of the derived rate constant parameter. More... | |
| static const unsigned int | NUMBER_OF_STATIC_PARAMETERS |
| Total number of static parameters (0). More... | |
| static const std::string | MODEL_DISPLAY_NAME |
| Display name of this model. More... | |
| static const std::string | MODEL_TYPE |
| Type category of this model. More... | |
| static const std::string | FUNCTION_STRING |
| Function string representation of the model equation. More... | |
| static const std::string | X_NAME |
| Name of the independent variable. More... | |
| static const std::string | X_AXIS_NAME |
| Display name for the x-axis. More... | |
| static const std::string | X_AXIS_UNIT |
| Unit for the x-axis. More... | |
| static const std::string | Y_AXIS_NAME |
| Display name for the y-axis. More... | |
| static const std::string | Y_AXIS_UNIT |
| Unit for the y-axis. More... | |
Protected Member Functions | |
| ExponentialDecayModel () | |
| ~ExponentialDecayModel () override | |
| ExponentialDecayModel (const ExponentialDecayModel &source) | |
| mitkCloneMacro (ExponentialDecayModel) | |
| ModelResultType | ComputeModelfunction (const ParametersType ¶meters) const override |
| Computes the model function for the given parameters. More... | |
| void | SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values) override |
| Sets a single static parameter by name. More... | |
| StaticParameterValuesType | GetStaticParameterValue (const ParameterNameType &name) const override |
| Retrieves a single static parameter value by name. More... | |
Protected Member Functions inherited from mitk::ModelBase | |
| virtual bool | ValidateModel (std::string &error) const |
| Validates whether the model is in a valid state to compute the signal. More... | |
| ModelBase () | |
| ~ModelBase () override | |
| ModelBase (const ModelBase &source) | |
| void | PrintSelf (std::ostream &os, ::itk::Indent indent) const override |
Protected Member Functions inherited from mitk::ModelTraitsInterface | |
| ModelTraitsInterface () | |
| virtual | ~ModelTraitsInterface () |
Additional Inherited Members | |
Protected Attributes inherited from mitk::ModelBase | |
| TimeGridType | m_TimeGrid |
Simple model of exponential decay: y(x) = y-intercept * exp(-x/lambda).
This model implements an exponential decay function where lambda is the decay constant. It has two parameters (y-intercept and lambda) and one derived parameter (rate constant k = 1/lambda).
Definition at line 33 of file mitkExponentialDecayModel.h.
| typedef itk::SmartPointer< const Self > mitk::ExponentialDecayModel::ConstPointer |
Definition at line 40 of file mitkExponentialDecayModel.h.
Definition at line 42 of file mitkExponentialDecayModel.h.
Definition at line 43 of file mitkExponentialDecayModel.h.
Definition at line 39 of file mitkExponentialDecayModel.h.
Definition at line 37 of file mitkExponentialDecayModel.h.
Definition at line 38 of file mitkExponentialDecayModel.h.
|
inlineprotected |
Definition at line 128 of file mitkExponentialDecayModel.h.
|
inlineoverrideprotected |
Definition at line 129 of file mitkExponentialDecayModel.h.
|
protected |
| Pointer mitk::ExponentialDecayModel::Clone | ( | ) | const |
|
overridevirtual |
Computes derived parameters from the given model parameters.
Helper function called by GetDerivedParameters(). Implement in derived classes to realize the concrete computation of derived parameters.
Reimplemented from mitk::ModelBase.
|
overrideprotectedvirtual |
Computes the model function for the given parameters.
Must be implemented by derived classes.
| parameters | The model parameters. |
Implements mitk::ModelBase.
|
virtual |
Run-time type information (and related methods).
Reimplemented from mitk::ModelBase.
|
overridevirtual |
Returns the names of derived parameters that can be computed by the model.
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the unit strings for all derived parameters.
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns a parsable function string representing the model equation.
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the human-readable display name of the model.
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic").
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the number of derived parameters that can be computed by the model.
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()).
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the number of static parameters.
Implements mitk::ModelBase.
|
overridevirtual |
Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()).
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the unit strings for all model parameters.
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the names of static parameters used when computing the signal.
Static parameters are not part of the fitting scope but configure the model.
Implements mitk::ModelBase.
|
overrideprotectedvirtual |
Retrieves a single static parameter value by name.
Helper function called by GetStaticParameters(). Must be implemented in derived classes.
Implements mitk::ModelBase.
|
overridevirtual |
Returns the display name of the x-axis (e.g. "Time").
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the unit of the x-axis (e.g. "s", "ms").
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the name of the independent variable used by the model (e.g. "x").
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the display name of the y-axis (e.g. "Signal Intensity").
Implements mitk::ModelTraitsInterface.
|
overridevirtual |
Returns the unit of the y-axis.
Implements mitk::ModelTraitsInterface.
|
protected |
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Sets a single static parameter by name.
Helper function called by SetStaticParameters(). Must be implemented in derived classes.
Implements mitk::ModelBase.
|
static |
Function string representation of the model equation.
Definition at line 90 of file mitkExponentialDecayModel.h.
|
static |
Display name of this model.
Definition at line 84 of file mitkExponentialDecayModel.h.
|
static |
Type category of this model.
Definition at line 87 of file mitkExponentialDecayModel.h.
|
static |
Name string for the derived rate constant parameter (k = 1/lambda).
Definition at line 72 of file mitkExponentialDecayModel.h.
|
static |
Name string for the decay constant parameter (lambda).
Definition at line 56 of file mitkExponentialDecayModel.h.
|
static |
Name string for the y-intercept parameter.
Definition at line 54 of file mitkExponentialDecayModel.h.
|
static |
Total number of derived parameters (1).
Definition at line 75 of file mitkExponentialDecayModel.h.
|
static |
Total number of model parameters (2).
Definition at line 59 of file mitkExponentialDecayModel.h.
|
static |
Total number of static parameters (0).
Definition at line 81 of file mitkExponentialDecayModel.h.
|
static |
Index position of lambda in the parameter vector.
Definition at line 69 of file mitkExponentialDecayModel.h.
|
static |
Index position of y-intercept in the parameter vector.
Definition at line 67 of file mitkExponentialDecayModel.h.
|
static |
Unit of the derived rate constant parameter.
Definition at line 78 of file mitkExponentialDecayModel.h.
|
static |
Unit of the decay constant parameter.
Definition at line 64 of file mitkExponentialDecayModel.h.
|
static |
Unit of the y-intercept parameter.
Definition at line 62 of file mitkExponentialDecayModel.h.
|
static |
Display name for the x-axis.
Definition at line 96 of file mitkExponentialDecayModel.h.
|
static |
Unit for the x-axis.
Definition at line 99 of file mitkExponentialDecayModel.h.
|
static |
Name of the independent variable.
Definition at line 93 of file mitkExponentialDecayModel.h.
|
static |
Display name for the y-axis.
Definition at line 102 of file mitkExponentialDecayModel.h.
|
static |
Unit for the y-axis.
Definition at line 105 of file mitkExponentialDecayModel.h.