Base class for (dynamic) models. A model can be used to calculate its signal given the discrete time grid of the signal and the parameters of the model.
A model has 3 types of parameters:
.
More...
#include <mitkModelBase.h>
Protected Member Functions | |
| virtual ModelResultType | ComputeModelfunction (const ParametersType ¶meters) const =0 |
| virtual bool | ValidateModel (std::string &error) const |
| virtual DerivedParameterMapType | ComputeDerivedParameters (const ParametersType ¶meters) const |
| virtual void | SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values)=0 |
| virtual StaticParameterValuesType | GetStaticParameterValue (const ParameterNameType &name) const =0 |
| ModelBase () | |
| ~ModelBase () override | |
| void | PrintSelf (std::ostream &os, ::itk::Indent indent) const override |
 Protected Member Functions inherited from mitk::ModelTraitsInterface | |
| ModelTraitsInterface () | |
| virtual | ~ModelTraitsInterface () |
Protected Attributes | |
| TimeGridType | m_TimeGrid |
Detailed Description
Base class for (dynamic) models. A model can be used to calculate its signal given the discrete time grid of the signal and the parameters of the model.
A model has 3 types of parameters:
.
- parameters
- static parameters
- derived parameters
"Parameters" and "static parameters" are used to compute the signal of the model. "Parameters" are the ones that will be changed for/by model fitting. "Static parameters" are used to configure the model for fitting but are itself not part of the fitting scope (compare itk::Transform parameters and static parameters). "Derived parameters" are model specific parameters computed from "Parameters" e.g. (DerivedParam1 = Param1/Param2). It may be implemented if e.g. for practical usage not the fitted parameters are needed but derivation of them.
- Remarks
- : If you implement your own model calls regard const correctness and do not change or undermine the constness of this base class. It is important because in case of fitting models are used in a multi threaded environment and must be thread safe. Thus the getter and computation functions are implemented as const and thread safe methods.
Definition at line 47 of file mitkModelBase.h.
Member Typedef Documentation
◆ ConstPointer
| typedef itk::SmartPointer< const Self > mitk::ModelBase::ConstPointer |
Definition at line 53 of file mitkModelBase.h.
◆ DerivedParameterMapType
| typedef std::map<ParameterNameType, DerivedParameterValueType> mitk::ModelBase::DerivedParameterMapType |
Definition at line 75 of file mitkModelBase.h.
◆ DerivedParameterNamesType
Definition at line 67 of file mitkModelBase.h.
◆ DerivedParametersSizeType
Definition at line 68 of file mitkModelBase.h.
◆ DerivedParameterValueType
| typedef double mitk::ModelBase::DerivedParameterValueType |
Definition at line 74 of file mitkModelBase.h.
◆ ModelResultType
Definition at line 55 of file mitkModelBase.h.
◆ ParameterNamesType
Definition at line 64 of file mitkModelBase.h.
◆ ParameterNameType
Definition at line 63 of file mitkModelBase.h.
◆ ParametersSizeType
Definition at line 65 of file mitkModelBase.h.
◆ ParametersType
Definition at line 59 of file mitkModelBase.h.
◆ ParameterValueType
Definition at line 58 of file mitkModelBase.h.
◆ Pointer
| typedef itk::SmartPointer< Self > mitk::ModelBase::Pointer |
Definition at line 52 of file mitkModelBase.h.
◆ Self
| typedef ModelBase mitk::ModelBase::Self |
Definition at line 50 of file mitkModelBase.h.
◆ StaticParameterMapType
| typedef std::map<ParameterNameType, StaticParameterValuesType> mitk::ModelBase::StaticParameterMapType |
Definition at line 72 of file mitkModelBase.h.
◆ StaticParameterValuesType
| typedef std::vector<StaticParameterValueType> mitk::ModelBase::StaticParameterValuesType |
Definition at line 71 of file mitkModelBase.h.
◆ StaticParameterValueType
| typedef double mitk::ModelBase::StaticParameterValueType |
Definition at line 70 of file mitkModelBase.h.
◆ Superclass
| typedef itk::Object mitk::ModelBase::Superclass |
Definition at line 51 of file mitkModelBase.h.
◆ TimeGridType
| typedef itk::Array<double> mitk::ModelBase::TimeGridType |
Type defining the time grid used be models.
- Remarks
- the model time grid has a resolution in sec and not like the time geometry which uses ms.
Definition at line 62 of file mitkModelBase.h.
Constructor & Destructor Documentation
◆ ModelBase()
|
protected |
◆ ~ModelBase()
|
overrideprotected |
Member Function Documentation
◆ ComputeDerivedParameters()
|
protectedvirtual |
Helper function called by GetDerivedParameters(). Implement in derived classes to realize the concrete computation of derived parameters.
- Remarks
- Default implementation has no derived parameters
Reimplemented in mitk::ThreeStepLinearModel, mitk::LinearModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TestModel, mitk::TwoStepLinearModel, and mitk::ExponentialDecayModel.
◆ ComputeModelfunction()
|
protectedpure virtual |
Implemented in mitk::ThreeStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::DescriptivePharmacokineticBrixModel, mitk::ExpDecayOffsetModel, mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::GenericParamModel, mitk::TestModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TwoStepLinearModel.
◆ GetClassID()
|
overridevirtual |
Default implementation the class name of the concrete instance as ID.
Implements mitk::ModelTraitsInterface.
◆ GetClassName()
|
virtual |
Reimplemented in mitk::GenericParamModel, mitk::TwoCompartmentExchangeModel, mitk::ExpDecayOffsetModel, mitk::ExponentialDecayModel, mitk::ExponentialSaturationModel, mitk::AIFBasedModelBase, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TestModel, mitk::LinearModel, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::ExtendedOneTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoTissueCompartmentModel, and mitk::OneTissueCompartmentModel.
◆ GetDerivedParameterNames()
|
overridevirtual |
Returns the names of derived parameters that can/will be computed by the model given specific model parameters.
- Remarks
- Default implementation has no derived parameters
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, and mitk::TestModel.
◆ GetDerivedParameters()
| DerivedParameterMapType mitk::ModelBase::GetDerivedParameters | ( | const ParametersType & | parameters | ) | const |
Generic interface method that computes all derived parameters implemented for the given models. To changed the derived parameter computation. ComputeDerivedParameters must be (re)implemented.
- Precondition
- parameters must have the right size.
- Parameters
-
parameters The parameters of the model for which the derived parameters should be computed. It calls GetStaticParameter for every name defined in GetStaticParameterNames().
- Remarks
- Default implementation has no derived parameters
◆ GetDerivedParameterScales()
|
overridevirtual |
Default implementation returns a scale of 1.0 for every defined derived parameter.
Implements mitk::ModelTraitsInterface.
◆ GetDerivedParameterUnits()
|
overridevirtual |
Default implementation returns no unit string ("") for every defined derived parameter.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExtendedToftsModel, and mitk::StandardToftsModel.
◆ GetFunctionString()
|
overridevirtual |
Default implementation returns an empty functions string.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, and mitk::TestModel.
◆ GetModelDisplayName()
|
overridevirtual |
Default implementation returns GetClassID as display name.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TestModel.
◆ GetModelType()
|
overridevirtual |
Default implementation returns "Unkown" as model type.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TestModel.
◆ GetNumberOfDerivedParameters()
|
overridevirtual |
Returns the number of derived parameters that can/will be computed by the model given specific model parameters.
- Remarks
- Default implementation has no derived parameters
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, and mitk::TestModel.
◆ GetNumberOfStaticParameters()
|
pure virtual |
Returns the number of static parameters that will be used when using the model to compute the signal (but are not defined via GetSignal()).
Implemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::AIFBasedModelBase, mitk::ExpDecayOffsetModel, mitk::GenericParamModel, and mitk::TestModel.
◆ GetParameterScales()
|
overridevirtual |
Default implementation returns a scale of 1.0 for every defined parameter.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::TestModel.
◆ GetParameterUnits()
|
overridevirtual |
Default implementation returns no unit string ("") for every defined parameter.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TestModel.
◆ GetSignal()
| ModelResultType mitk::ModelBase::GetSignal | ( | const ParametersType & | parameters | ) | const |
◆ GetStaticParameterNames()
|
pure virtual |
Returns the names of static parameters that will be used when using the model to compute the signal (but are not defined via GetSignal()).
Implemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::AIFBasedModelBase, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::GenericParamModel, and mitk::TestModel.
◆ GetStaticParameters()
| StaticParameterMapType mitk::ModelBase::GetStaticParameters | ( | ) | const |
Generic interface method that can be used to retrieve the static parameters of the model; e.g. in order to serialize the model settings. It calls GetStaticParameter for every name defined in GetStaticParameterNames().
◆ GetStaticParameterUnits()
|
virtual |
Default implementation returns no unit string ("") for every defined parameter.
Reimplemented in mitk::DescriptivePharmacokineticBrixModel, and mitk::AIFBasedModelBase.
◆ GetStaticParameterValue()
|
protectedpure virtual |
Helper function called by GetStaticParameters(). Implement in derived classes to realize the concrete retrieval of static parameters.
Implemented in mitk::ThreeStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::DescriptivePharmacokineticBrixModel, mitk::ExpDecayOffsetModel, mitk::AIFBasedModelBase, mitk::GenericParamModel, mitk::TestModel, and mitk::TwoStepLinearModel.
◆ GetTimeGrid()
|
virtual |
Gets the time grid of the model. It indicates the time points correlated with the signal the model should produce.
- Remarks
- The resolution of the time grid is in seconds. (Not in ms like the mitk::TimeGeometry)
◆ GetXAxisName()
|
overridevirtual |
Default implementation returns an empty string.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.
◆ GetXAxisUnit()
|
overridevirtual |
Default implementation returns an empty string.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.
◆ GetXName()
|
overridevirtual |
Default implementation returns an empty string.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, and mitk::TestModel.
◆ GetYAxisName()
|
overridevirtual |
Default implementation returns an empty string.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.
◆ GetYAxisUnit()
|
overridevirtual |
Default implementation returns an empty string.
Implements mitk::ModelTraitsInterface.
Reimplemented in mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.
◆ PrintSelf()
|
overrideprotected |
◆ SetStaticParameter()
|
protectedpure virtual |
Helper function called by SetStaticParameters(). Implement in derived classes to realize the concrete setting of static parameters.
Implemented in mitk::ThreeStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::DescriptivePharmacokineticBrixModel, mitk::ExpDecayOffsetModel, mitk::AIFBasedModelBase, mitk::GenericParamModel, mitk::TestModel, and mitk::TwoStepLinearModel.
◆ SetStaticParameters()
| void mitk::ModelBase::SetStaticParameters | ( | const StaticParameterMapType & | parameters, |
| bool | allParameters = true |
||
| ) |
Generic interface method that can be used to set the static parameters of the model before it is used. It checks the validity of the passed map and uses SetStaticParameter to set the values.
- Parameters
-
parameters The map with the static parameters and their values. allParameters If true an exception will be thrown if the keys of passed parameters do not equal the return of GetStaticParameterNames. Thus if true, one must set all static parameters of the model.
- Precondition
- Parameters must only contain keys that exist in GetStaticParameterNames()
- If allParameters == true, parameters must define all keys of GetStaticParameterNames()
◆ SetTimeGrid()
|
virtual |
Sets the time grid of the model. It indicates the time points correlated with the signal the model should produce.
- Remarks
- The resolution of the time grid is in seconds. (Not in ms like the mitk::TimeGeometry)
◆ ValidateModel()
|
protectedvirtual |
Member is called by GetSignal() before ComputeModelfunction(). It indicates if model is in a valid state and ready to compute the signal. The default implementation checks nothing and always returns true. Reimplement to realize special behavior for derived classes.
- Parameters
-
[out] error Set internally to indicate the error reason if method returns false. Is used by GetSignal() for the exception comment.
- Returns
- Returns true if the model is valid and can compute a signal. Otherwise it returns false.
Reimplemented in mitk::AIFBasedModelBase.
Member Data Documentation
◆ m_TimeGrid
|
protected |
Definition at line 203 of file mitkModelBase.h.
The documentation for this class was generated from the following file:
