Abstract base class for model factories in the model fitting framework. More...
#include <mitkModelFactoryBase.h>
Public Member Functions | |
| mitkClassMacroItkParent (ModelFactoryBase, itk::Object) | |
| virtual ModelBasePointer | CreateModel () const =0 |
| Creates and returns a new instance of the model. More... | |
| ModelParameterizerBase::Pointer | CreateParameterizer (const modelFit::ModelFitInfo *fit) const |
| Creates a model parameterizer configured according to the given model fit info. More... | |
| virtual ConstraintCheckerBase::Pointer | CreateDefaultConstraints () const =0 |
| Creates default constraints for the model fitting process. More... | |
| virtual ParametersType | GetDefaultInitialParameterization () const =0 |
| Returns the default initial parameterization defined by the model developer. More... | |
 Public Member Functions inherited from mitk::ModelTraitsInterface | |
| virtual ParameterNamesType | GetParameterNames () const =0 |
| Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()). More... | |
| virtual ParametersSizeType | GetNumberOfParameters () const =0 |
| Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()). More... | |
| virtual ParamterScaleMapType | GetParameterScales () const =0 |
| Returns the scaling factors for all model parameters. More... | |
| virtual ParamterUnitMapType | GetParameterUnits () const =0 |
| Returns the unit strings for all model parameters. More... | |
| virtual DerivedParameterNamesType | GetDerivedParameterNames () const =0 |
| Returns the names of derived parameters that can be computed by the model. More... | |
| virtual DerivedParametersSizeType | GetNumberOfDerivedParameters () const =0 |
| Returns the number of derived parameters that can be computed by the model. More... | |
| virtual DerivedParamterScaleMapType | GetDerivedParameterScales () const =0 |
| Returns the scaling factors for all derived parameters. More... | |
| virtual DerivedParamterUnitMapType | GetDerivedParameterUnits () const =0 |
| Returns the unit strings for all derived parameters. More... | |
| virtual std::string | GetModelDisplayName () const =0 |
| Returns the human-readable display name of the model. More... | |
| virtual std::string | GetModelType () const =0 |
| Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic"). More... | |
| virtual FunctionStringType | GetFunctionString () const =0 |
| Returns a parsable function string representing the model equation. More... | |
| virtual ModellClassIDType | GetClassID () const =0 |
| Returns the unique class identifier for this model type. More... | |
| virtual std::string | GetXName () const =0 |
| Returns the name of the independent variable used by the model (e.g. "x"). More... | |
| virtual std::string | GetXAxisName () const =0 |
| Returns the display name of the x-axis (e.g. "Time"). More... | |
| virtual std::string | GetXAxisUnit () const =0 |
| Returns the unit of the x-axis (e.g. "s", "ms"). More... | |
| virtual std::string | GetYAxisName () const =0 |
| Returns the display name of the y-axis (e.g. "Signal Intensity"). More... | |
| virtual std::string | GetYAxisUnit () const =0 |
| Returns the unit of the y-axis. More... | |
Protected Member Functions | |
| virtual ModelParameterizerBase::Pointer | DoCreateParameterizer (const modelFit::ModelFitInfo *fit) const =0 |
| ModelFactoryBase () | |
| ~ModelFactoryBase () override | |
| Protected Member Functions inherited from mitk::ModelTraitsInterface | |
| ModelTraitsInterface () | |
| virtual | ~ModelTraitsInterface () |
Detailed Description
Abstract base class for model factories in the model fitting framework.
A model factory is responsible for creating model instances, parameterizers, and default constraints. It also exposes the model traits through the ModelTraitsInterface. Derive from this class and implement the abstract member functions to create a factory for a specific model type.
Definition at line 39 of file mitkModelFactoryBase.h.
Member Typedef Documentation
◆ DerivedParameterNamesType
| typedef ModelTraitsInterface::DerivedParameterNamesType mitk::ModelFactoryBase::DerivedParameterNamesType |
Definition at line 61 of file mitkModelFactoryBase.h.
◆ DerivedParametersSizeType
| typedef ModelTraitsInterface::DerivedParametersSizeType mitk::ModelFactoryBase::DerivedParametersSizeType |
Definition at line 62 of file mitkModelFactoryBase.h.
◆ DerivedParamterScaleMapType
| typedef ModelTraitsInterface::DerivedParamterScaleMapType mitk::ModelFactoryBase::DerivedParamterScaleMapType |
Definition at line 63 of file mitkModelFactoryBase.h.
◆ DerivedParamterUnitMapType
| typedef ModelTraitsInterface::DerivedParamterUnitMapType mitk::ModelFactoryBase::DerivedParamterUnitMapType |
Definition at line 64 of file mitkModelFactoryBase.h.
◆ FunctionStringType
Definition at line 58 of file mitkModelFactoryBase.h.
◆ ModelBasePointer
Definition at line 50 of file mitkModelFactoryBase.h.
◆ ModelBaseType
Definition at line 49 of file mitkModelFactoryBase.h.
◆ ModellClassIDType
Definition at line 59 of file mitkModelFactoryBase.h.
◆ ParameterNamesType
Definition at line 53 of file mitkModelFactoryBase.h.
◆ ParameterNameType
Definition at line 52 of file mitkModelFactoryBase.h.
◆ ParametersSizeType
Definition at line 54 of file mitkModelFactoryBase.h.
◆ ParamterScaleMapType
Definition at line 56 of file mitkModelFactoryBase.h.
◆ ParamterUnitMapType
Definition at line 57 of file mitkModelFactoryBase.h.
Constructor & Destructor Documentation
◆ ModelFactoryBase()
|
protected |
◆ ~ModelFactoryBase()
|
overrideprotected |
Member Function Documentation
◆ CreateDefaultConstraints()
|
pure virtual |
Creates default constraints for the model fitting process.
These constraints should/can be used for fitting if the user does not specify custom ones.
- Returns
- Pointer to the constraint checker for default constraints. May return a NULL pointer to indicate that the model has no constraints by default.
Implemented in mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >, mitk::TwoTissueCompartmentModelFactoryBase< TwoTissueCompartmentModelParameterizer >, mitk::TwoTissueCompartmentFDGModelFactory, mitk::TwoCompartmentExchangeModelFactoryBase< TModelParameterizer >, mitk::TwoCompartmentExchangeModelFactoryBase< TwoCompartmentExchangeModelParameterizer >, mitk::StandardToftsModelFactory, mitk::OneTissueCompartmentModelFactory, mitk::ExtendedToftsModelFactory, mitk::ExtendedOneTissueCompartmentModelFactory, mitk::ExponentialSaturationModelFactory, mitk::ExponentialDecayModelFactory, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.
◆ CreateModel()
|
pure virtual |
Creates and returns a new instance of the model.
- Returns
- Smart pointer to the newly created model instance.
Implemented in mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.
◆ CreateParameterizer()
| ModelParameterizerBase::Pointer mitk::ModelFactoryBase::CreateParameterizer | ( | const modelFit::ModelFitInfo * | fit | ) | const |
Creates a model parameterizer configured according to the given model fit info.
- Parameters
-
[in] fit Pointer to the model fit info describing the fit configuration.
- Returns
- Smart pointer to the configured parameterizer.
- Precondition
- fit must point to a valid instance.
◆ DoCreateParameterizer()
|
protectedpure virtual |
Implemented in mitk::DescriptivePharmacokineticBrixModelFactory, mitk::ConcreteAIFBasedModelFactory< TModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< ExtendedToftsModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< TwoTissueCompartmentFDGModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< ExtendedOneTissueCompartmentModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< StandardToftsModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< OneTissueCompartmentModelParameterizer >, mitk::TwoStepLinearModelFactory, mitk::ThreeStepLinearModelFactory, mitk::TestModelFactory, mitk::LinearModelFactory, mitk::GenericParamModelFactory, mitk::ExponentialSaturationModelFactory, mitk::ExponentialDecayModelFactory, and mitk::ExpDecayOffsetModelFactory.
◆ GetDefaultInitialParameterization()
|
pure virtual |
Returns the default initial parameterization defined by the model developer.
- Returns
- The default initial parameter values for fitting.
Implemented in mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >, mitk::TwoTissueCompartmentModelFactoryBase< TwoTissueCompartmentModelParameterizer >, mitk::TwoTissueCompartmentFDGModelFactory, mitk::TwoCompartmentExchangeModelFactoryBase< TModelParameterizer >, mitk::TwoCompartmentExchangeModelFactoryBase< TwoCompartmentExchangeModelParameterizer >, mitk::StandardToftsModelFactory, mitk::OneTissueCompartmentModelFactory, mitk::ExtendedToftsModelFactory, mitk::ExtendedOneTissueCompartmentModelFactory, mitk::DescriptivePharmacokineticBrixModelFactory, mitk::TwoStepLinearModelFactory, mitk::ThreeStepLinearModelFactory, mitk::TestModelFactory, mitk::LinearModelFactory, mitk::GenericParamModelFactory, mitk::ExponentialSaturationModelFactory, mitk::ExponentialDecayModelFactory, and mitk::ExpDecayOffsetModelFactory.
◆ mitkClassMacroItkParent()
| mitk::ModelFactoryBase::mitkClassMacroItkParent | ( | ModelFactoryBase | , |
| itk::Object | |||
| ) |
The documentation for this class was generated from the following file:
