Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::ConcreteModelFactoryBase< TModel > Class Template Reference

#include <mitkConcreteModelFactoryBase.h>

Inheritance diagram for mitk::ConcreteModelFactoryBase< TModel >:
Inheritance graph
[legend]
Collaboration diagram for mitk::ConcreteModelFactoryBase< TModel >:
Collaboration graph
[legend]

Public Types

typedef ModelFactoryBase::ModelBaseType ModelBaseType
 
typedef ModelFactoryBase::ModelBasePointer ModelBasePointer
 
typedef TModel ModelType
 
typedef ModelType::Pointer ModelPointer
 
typedef ModelFactoryBase::ParameterNameType ParameterNameType
 
typedef ModelFactoryBase::ParameterNamesType ParameterNamesType
 
typedef ModelFactoryBase::ParametersSizeType ParametersSizeType
 
typedef ModelFactoryBase::ParamterScaleMapType ParamterScaleMapType
 
typedef ModelFactoryBase::ParamterUnitMapType ParamterUnitMapType
 
typedef ModelFactoryBase::DerivedParameterNamesType DerivedParameterNamesType
 
typedef ModelFactoryBase::DerivedParametersSizeType DerivedParametersSizeType
 
typedef ModelFactoryBase::DerivedParamterScaleMapType DerivedParamterScaleMapType
 
typedef ModelFactoryBase::DerivedParamterUnitMapType DerivedParamterUnitMapType
 
typedef ModelFactoryBase::FunctionStringType FunctionStringType
 
typedef ModelFactoryBase::ModellClassIDType ModellClassIDType
 
- Public Types inherited from mitk::ModelFactoryBase
typedef ModelBase ModelBaseType
 
typedef ModelBaseType::Pointer ModelBasePointer
 
typedef ModelTraitsInterface::ParameterNameType ParameterNameType
 
typedef ModelTraitsInterface::ParameterNamesType ParameterNamesType
 
typedef ModelTraitsInterface::ParametersSizeType ParametersSizeType
 
typedef ModelTraitsInterface::ParamterScaleMapType ParamterScaleMapType
 
typedef ModelTraitsInterface::ParamterUnitMapType ParamterUnitMapType
 
typedef ModelTraitsInterface::FunctionStringType FunctionStringType
 
typedef ModelTraitsInterface::ModellClassIDType ModellClassIDType
 
typedef ModelTraitsInterface::DerivedParameterNamesType DerivedParameterNamesType
 
typedef ModelTraitsInterface::DerivedParametersSizeType DerivedParametersSizeType
 
typedef ModelTraitsInterface::DerivedParamterScaleMapType DerivedParamterScaleMapType
 
typedef ModelTraitsInterface::DerivedParamterUnitMapType DerivedParamterUnitMapType
 
- Public Types inherited from mitk::ModelTraitsInterface
typedef itk::Array< double > ModelResultType
 
using ParameterValueType = double
 
typedef itk::Array< ParameterValueType > ParametersType
 
typedef std::string ParameterNameType
 
typedef std::vector< ParameterNameType > ParameterNamesType
 
typedef ParametersType::SizeValueType ParametersSizeType
 
typedef ParameterNamesType DerivedParameterNamesType
 
typedef ParametersSizeType DerivedParametersSizeType
 
typedef std::map< ParameterNameType, double > ParamterScaleMapType
 
typedef std::map< ParameterNameType, std::string > ParamterUnitMapType
 
typedef std::map< ParameterNameType, double > DerivedParamterScaleMapType
 
typedef std::map< ParameterNameType, std::string > DerivedParamterUnitMapType
 
typedef std::string FunctionStringType
 
typedef std::string ModellClassIDType
 

Public Member Functions

 mitkClassMacro (ConcreteModelFactoryBase, ModelFactoryBase)
 
ModelBasePointer CreateModel () const override
 
ConstraintCheckerBase::Pointer CreateDefaultConstraints () const override
 
ParameterNamesType GetParameterNames () const override
 
ParametersSizeType GetNumberOfParameters () const override
 
ParamterScaleMapType GetParameterScales () const override
 
ParamterUnitMapType GetParameterUnits () const override
 
ParameterNamesType GetDerivedParameterNames () const override
 
ParametersSizeType GetNumberOfDerivedParameters () const override
 
DerivedParamterScaleMapType GetDerivedParameterScales () const override
 
DerivedParamterUnitMapType GetDerivedParameterUnits () const override
 
std::string GetModelDisplayName () const override
 
std::string GetModelType () const override
 
FunctionStringType GetFunctionString () const override
 
ModellClassIDType GetClassID () const override
 
std::string GetXName () const override
 
std::string GetXAxisName () const override
 
std::string GetXAxisUnit () const override
 
std::string GetYAxisName () const override
 
std::string GetYAxisUnit () const override
 
- Public Member Functions inherited from mitk::ModelFactoryBase
 mitkClassMacroItkParent (ModelFactoryBase, itk::Object)
 
ModelParameterizerBase::Pointer CreateParameterizer (const modelFit::ModelFitInfo *fit) const
 
virtual ParametersType GetDefaultInitialParameterization () const =0
 

Static Public Member Functions

static ModelPointer CreateConcreteModel ()
 

Protected Member Functions

 ConcreteModelFactoryBase ()
 
 ~ConcreteModelFactoryBase () override
 
- Protected Member Functions inherited from mitk::ModelFactoryBase
virtual ModelParameterizerBase::Pointer DoCreateParameterizer (const modelFit::ModelFitInfo *fit) const =0
 
 ModelFactoryBase ()
 
 ~ModelFactoryBase () override
 
- Protected Member Functions inherited from mitk::ModelTraitsInterface
 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Protected Attributes

ModelPointer m_Reference
 

Detailed Description

template<class TModel>
class mitk::ConcreteModelFactoryBase< TModel >

Definition at line 23 of file mitkConcreteModelFactoryBase.h.

Member Typedef Documentation

◆ DerivedParameterNamesType

template<class TModel >
typedef ModelFactoryBase::DerivedParameterNamesType mitk::ConcreteModelFactoryBase< TModel >::DerivedParameterNamesType

Definition at line 44 of file mitkConcreteModelFactoryBase.h.

◆ DerivedParametersSizeType

template<class TModel >
typedef ModelFactoryBase::DerivedParametersSizeType mitk::ConcreteModelFactoryBase< TModel >::DerivedParametersSizeType

Definition at line 45 of file mitkConcreteModelFactoryBase.h.

◆ DerivedParamterScaleMapType

template<class TModel >
typedef ModelFactoryBase::DerivedParamterScaleMapType mitk::ConcreteModelFactoryBase< TModel >::DerivedParamterScaleMapType

Definition at line 46 of file mitkConcreteModelFactoryBase.h.

◆ DerivedParamterUnitMapType

template<class TModel >
typedef ModelFactoryBase::DerivedParamterUnitMapType mitk::ConcreteModelFactoryBase< TModel >::DerivedParamterUnitMapType

Definition at line 47 of file mitkConcreteModelFactoryBase.h.

◆ FunctionStringType

template<class TModel >
typedef ModelFactoryBase::FunctionStringType mitk::ConcreteModelFactoryBase< TModel >::FunctionStringType

Definition at line 48 of file mitkConcreteModelFactoryBase.h.

◆ ModelBasePointer

template<class TModel >
typedef ModelFactoryBase::ModelBasePointer mitk::ConcreteModelFactoryBase< TModel >::ModelBasePointer

Definition at line 34 of file mitkConcreteModelFactoryBase.h.

◆ ModelBaseType

template<class TModel >
typedef ModelFactoryBase::ModelBaseType mitk::ConcreteModelFactoryBase< TModel >::ModelBaseType

Definition at line 33 of file mitkConcreteModelFactoryBase.h.

◆ ModellClassIDType

template<class TModel >
typedef ModelFactoryBase::ModellClassIDType mitk::ConcreteModelFactoryBase< TModel >::ModellClassIDType

Definition at line 49 of file mitkConcreteModelFactoryBase.h.

◆ ModelPointer

template<class TModel >
typedef ModelType::Pointer mitk::ConcreteModelFactoryBase< TModel >::ModelPointer

Definition at line 37 of file mitkConcreteModelFactoryBase.h.

◆ ModelType

template<class TModel >
typedef TModel mitk::ConcreteModelFactoryBase< TModel >::ModelType

Definition at line 36 of file mitkConcreteModelFactoryBase.h.

◆ ParameterNamesType

template<class TModel >
typedef ModelFactoryBase::ParameterNamesType mitk::ConcreteModelFactoryBase< TModel >::ParameterNamesType

Definition at line 40 of file mitkConcreteModelFactoryBase.h.

◆ ParameterNameType

template<class TModel >
typedef ModelFactoryBase::ParameterNameType mitk::ConcreteModelFactoryBase< TModel >::ParameterNameType

Definition at line 39 of file mitkConcreteModelFactoryBase.h.

◆ ParametersSizeType

template<class TModel >
typedef ModelFactoryBase::ParametersSizeType mitk::ConcreteModelFactoryBase< TModel >::ParametersSizeType

Definition at line 41 of file mitkConcreteModelFactoryBase.h.

◆ ParamterScaleMapType

template<class TModel >
typedef ModelFactoryBase::ParamterScaleMapType mitk::ConcreteModelFactoryBase< TModel >::ParamterScaleMapType

Definition at line 42 of file mitkConcreteModelFactoryBase.h.

◆ ParamterUnitMapType

template<class TModel >
typedef ModelFactoryBase::ParamterUnitMapType mitk::ConcreteModelFactoryBase< TModel >::ParamterUnitMapType

Definition at line 43 of file mitkConcreteModelFactoryBase.h.

Constructor & Destructor Documentation

◆ ConcreteModelFactoryBase()

template<class TModel >
mitk::ConcreteModelFactoryBase< TModel >::ConcreteModelFactoryBase ( )
inlineprotected

Definition at line 153 of file mitkConcreteModelFactoryBase.h.

◆ ~ConcreteModelFactoryBase()

template<class TModel >
mitk::ConcreteModelFactoryBase< TModel >::~ConcreteModelFactoryBase ( )
inlineoverrideprotected

Definition at line 158 of file mitkConcreteModelFactoryBase.h.

Member Function Documentation

◆ CreateConcreteModel()

template<class TModel >
static ModelPointer mitk::ConcreteModelFactoryBase< TModel >::CreateConcreteModel ( )
inlinestatic

Definition at line 51 of file mitkConcreteModelFactoryBase.h.

Referenced by mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::CreateModel().

◆ CreateDefaultConstraints()

template<class TModel >
ConstraintCheckerBase::Pointer mitk::ConcreteModelFactoryBase< TModel >::CreateDefaultConstraints ( ) const
inlineoverridevirtual

Create the default constraints that should/can be used for fitting if nothing else is specified by the user.

Returns
Pointer to the constraint checker for default constraints. May return a NULL pointer to indicated that the Model has no constraints by default.

Implements mitk::ModelFactoryBase.

Definition at line 61 of file mitkConcreteModelFactoryBase.h.

◆ CreateModel()

template<class TModel >
ModelBasePointer mitk::ConcreteModelFactoryBase< TModel >::CreateModel ( ) const
inlineoverridevirtual

Implements mitk::ModelFactoryBase.

Definition at line 56 of file mitkConcreteModelFactoryBase.h.

◆ GetClassID()

template<class TModel >
ModellClassIDType mitk::ConcreteModelFactoryBase< TModel >::GetClassID ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 122 of file mitkConcreteModelFactoryBase.h.

◆ GetDerivedParameterNames()

template<class TModel >
ParameterNamesType mitk::ConcreteModelFactoryBase< TModel >::GetDerivedParameterNames ( ) const
inlineoverridevirtual

Returns the names of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

Implements mitk::ModelTraitsInterface.

Definition at line 87 of file mitkConcreteModelFactoryBase.h.

◆ GetDerivedParameterScales()

template<class TModel >
DerivedParamterScaleMapType mitk::ConcreteModelFactoryBase< TModel >::GetDerivedParameterScales ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 97 of file mitkConcreteModelFactoryBase.h.

◆ GetDerivedParameterUnits()

template<class TModel >
DerivedParamterUnitMapType mitk::ConcreteModelFactoryBase< TModel >::GetDerivedParameterUnits ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 102 of file mitkConcreteModelFactoryBase.h.

◆ GetFunctionString()

template<class TModel >
FunctionStringType mitk::ConcreteModelFactoryBase< TModel >::GetFunctionString ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 117 of file mitkConcreteModelFactoryBase.h.

◆ GetModelDisplayName()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetModelDisplayName ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 107 of file mitkConcreteModelFactoryBase.h.

◆ GetModelType()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetModelType ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 112 of file mitkConcreteModelFactoryBase.h.

◆ GetNumberOfDerivedParameters()

template<class TModel >
ParametersSizeType mitk::ConcreteModelFactoryBase< TModel >::GetNumberOfDerivedParameters ( ) const
inlineoverridevirtual

Returns the number of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

Implements mitk::ModelTraitsInterface.

Definition at line 92 of file mitkConcreteModelFactoryBase.h.

◆ GetNumberOfParameters()

template<class TModel >
ParametersSizeType mitk::ConcreteModelFactoryBase< TModel >::GetNumberOfParameters ( ) const
inlineoverridevirtual

Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()).

Implements mitk::ModelTraitsInterface.

Definition at line 72 of file mitkConcreteModelFactoryBase.h.

◆ GetParameterNames()

template<class TModel >
ParameterNamesType mitk::ConcreteModelFactoryBase< TModel >::GetParameterNames ( ) const
inlineoverridevirtual

Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()).

Implements mitk::ModelTraitsInterface.

Definition at line 67 of file mitkConcreteModelFactoryBase.h.

◆ GetParameterScales()

template<class TModel >
ParamterScaleMapType mitk::ConcreteModelFactoryBase< TModel >::GetParameterScales ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 77 of file mitkConcreteModelFactoryBase.h.

◆ GetParameterUnits()

template<class TModel >
ParamterUnitMapType mitk::ConcreteModelFactoryBase< TModel >::GetParameterUnits ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 82 of file mitkConcreteModelFactoryBase.h.

◆ GetXAxisName()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetXAxisName ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 132 of file mitkConcreteModelFactoryBase.h.

◆ GetXAxisUnit()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetXAxisUnit ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 137 of file mitkConcreteModelFactoryBase.h.

◆ GetXName()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetXName ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 127 of file mitkConcreteModelFactoryBase.h.

◆ GetYAxisName()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetYAxisName ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 142 of file mitkConcreteModelFactoryBase.h.

◆ GetYAxisUnit()

template<class TModel >
std::string mitk::ConcreteModelFactoryBase< TModel >::GetYAxisUnit ( ) const
inlineoverridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 147 of file mitkConcreteModelFactoryBase.h.

◆ mitkClassMacro()

template<class TModel >
mitk::ConcreteModelFactoryBase< TModel >::mitkClassMacro ( ConcreteModelFactoryBase< TModel >  ,
ModelFactoryBase   
)

Member Data Documentation

◆ m_Reference

template<class TModel >
ModelPointer mitk::ConcreteModelFactoryBase< TModel >::m_Reference
protected

Definition at line 160 of file mitkConcreteModelFactoryBase.h.

Referenced by mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::ConcreteModelFactoryBase(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetClassID(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetDerivedParameterNames(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetDerivedParameterScales(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetDerivedParameterUnits(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetFunctionString(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetModelDisplayName(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetModelType(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetNumberOfDerivedParameters(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetNumberOfParameters(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetParameterNames(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetParameterScales(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetParameterUnits(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetXAxisName(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetXAxisUnit(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetXName(), mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetYAxisName(), and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >::GetYAxisUnit().

The documentation for this class was generated from the following file: