Medical Imaging Interaction Toolkit  2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::ConcreteModelParameterizerBase< TModel > Class Template Reference

#include <mitkConcreteModelParameterizerBase.h>

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

Public Types

typedef ConcreteModelParameterizerBase< TModel > Self
 
typedef ModelParameterizerBase Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::ModelBaseType ModelBaseType
 
typedef Superclass::ModelBasePointer ModelBasePointer
 
typedef TModel ModelType
 
typedef ModelType::Pointer ModelPointer
 
typedef Superclass::StaticParameterValueType StaticParameterValueType
 
typedef Superclass::StaticParameterValuesType StaticParameterValuesType
 
typedef Superclass::StaticParameterMapType StaticParameterMapType
 
typedef Superclass::IndexType IndexType
 
- Public Types inherited from mitk::ModelParameterizerBase
typedef ModelParameterizerBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef ModelBase ModelBaseType
 
typedef ModelBaseType::Pointer ModelBasePointer
 
typedef ModelBaseType::ParametersType ParametersType
 
typedef ModelBaseType::StaticParameterValueType StaticParameterValueType
 
typedef ModelBaseType::StaticParameterValuesType StaticParameterValuesType
 
typedef ModelBaseType::StaticParameterMapType StaticParameterMapType
 
typedef ModelBaseType::TimeGridType TimeGridType
 
typedef ::itk::Index< 3 > IndexType
 
- 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

virtual const char * GetClassName () const
 
StaticParameterMapType GetGlobalStaticParameters () const override
 
StaticParameterMapType GetLocalStaticParameters (const IndexType &) const override
 
ModelBasePointer GenerateParameterizedModel (const IndexType &currentPosition) const override
 
ModelBasePointer GenerateParameterizedModel () const override
 
ParametersType GetDefaultInitialParameterization () 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::ModelParameterizerBase
ParametersType GetInitialParameterization () const
 
ParametersType GetInitialParameterization (const IndexType &currentPosition) const
 
void SetInitialParameterizationDelegate (const InitialParameterizationDelegateBase *delegate)
 
virtual void SetDefaultTimeGrid (TimeGridType _arg)
 
virtual const TimeGridType & GetDefaultTimeGrid ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ConcreteModelParameterizerBase ()
 
 ~ConcreteModelParameterizerBase () override
 
- Protected Member Functions inherited from mitk::ModelParameterizerBase
 ModelParameterizerBase ()
 
 ~ModelParameterizerBase () override
 
- Protected Member Functions inherited from mitk::ModelTraitsInterface
 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::ModelParameterizerBase
InitialParameterizationDelegateBase::ConstPointer m_InitialDelegate
 
TimeGridType m_DefaultTimeGrid
 

Detailed Description

template<class TModel>
class mitk::ConcreteModelParameterizerBase< TModel >

Definition at line 21 of file mitkConcreteModelParameterizerBase.h.

Member Typedef Documentation

◆ ConstPointer

template<class TModel >
typedef itk::SmartPointer< const Self > mitk::ConcreteModelParameterizerBase< TModel >::ConstPointer

Definition at line 27 of file mitkConcreteModelParameterizerBase.h.

◆ IndexType

template<class TModel >
typedef Superclass::IndexType mitk::ConcreteModelParameterizerBase< TModel >::IndexType

Definition at line 42 of file mitkConcreteModelParameterizerBase.h.

◆ ModelBasePointer

template<class TModel >
typedef Superclass::ModelBasePointer mitk::ConcreteModelParameterizerBase< TModel >::ModelBasePointer

Definition at line 33 of file mitkConcreteModelParameterizerBase.h.

◆ ModelBaseType

template<class TModel >
typedef Superclass::ModelBaseType mitk::ConcreteModelParameterizerBase< TModel >::ModelBaseType

Definition at line 30 of file mitkConcreteModelParameterizerBase.h.

◆ ModelPointer

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

Definition at line 36 of file mitkConcreteModelParameterizerBase.h.

◆ ModelType

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

Definition at line 35 of file mitkConcreteModelParameterizerBase.h.

◆ Pointer

template<class TModel >
typedef itk::SmartPointer< Self > mitk::ConcreteModelParameterizerBase< TModel >::Pointer

Definition at line 26 of file mitkConcreteModelParameterizerBase.h.

◆ Self

template<class TModel >
typedef ConcreteModelParameterizerBase<TModel> mitk::ConcreteModelParameterizerBase< TModel >::Self

Definition at line 24 of file mitkConcreteModelParameterizerBase.h.

◆ StaticParameterMapType

template<class TModel >
typedef Superclass::StaticParameterMapType mitk::ConcreteModelParameterizerBase< TModel >::StaticParameterMapType

Definition at line 40 of file mitkConcreteModelParameterizerBase.h.

◆ StaticParameterValuesType

template<class TModel >
typedef Superclass::StaticParameterValuesType mitk::ConcreteModelParameterizerBase< TModel >::StaticParameterValuesType

Definition at line 39 of file mitkConcreteModelParameterizerBase.h.

◆ StaticParameterValueType

template<class TModel >
typedef Superclass::StaticParameterValueType mitk::ConcreteModelParameterizerBase< TModel >::StaticParameterValueType

Definition at line 38 of file mitkConcreteModelParameterizerBase.h.

◆ Superclass

template<class TModel >
typedef ModelParameterizerBase mitk::ConcreteModelParameterizerBase< TModel >::Superclass

Definition at line 25 of file mitkConcreteModelParameterizerBase.h.

Constructor & Destructor Documentation

◆ ConcreteModelParameterizerBase()

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

Definition at line 189 of file mitkConcreteModelParameterizerBase.h.

◆ ~ConcreteModelParameterizerBase()

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

Definition at line 193 of file mitkConcreteModelParameterizerBase.h.

Member Function Documentation

◆ GenerateParameterizedModel() [1/2]

template<class TModel >
ModelBasePointer mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel ( ) const
inlineoverridevirtual

Generate model instance, only with global static parametrization. Any local static parameter stay default.

Implements mitk::ModelParameterizerBase.

Definition at line 79 of file mitkConcreteModelParameterizerBase.h.

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

◆ GenerateParameterizedModel() [2/2]

template<class TModel >
ModelBasePointer mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel ( const IndexType &  currentPosition) const
inlineoverridevirtual

Implements mitk::ModelParameterizerBase.

Definition at line 66 of file mitkConcreteModelParameterizerBase.h.

◆ GetClassID()

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

Implements mitk::ModelTraitsInterface.

Definition at line 158 of file mitkConcreteModelParameterizerBase.h.

◆ GetClassName()

template<class TModel >
virtual const char* mitk::ConcreteModelParameterizerBase< TModel >::GetClassName ( ) const
virtual

Reimplemented from mitk::ModelParameterizerBase.

Reimplemented in mitk::AIFBasedModelParameterizerBase< mitk::TwoCompartmentExchangeModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoTissueCompartmentFDGModel >, mitk::AIFBasedModelParameterizerBase< mitk::ExtendedOneTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::OneTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::StandardToftsModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoTissueCompartmentModel >, and mitk::AIFBasedModelParameterizerBase< mitk::ExtendedToftsModel >.

◆ GetDefaultInitialParameterization()

template<class TModel >
ParametersType mitk::ConcreteModelParameterizerBase< TModel >::GetDefaultInitialParameterization ( ) const
inlineoverridevirtual

This function returns the default parameterization (e.g. initial parametrization for fitting) defined by the model developer for for the given model.

Implements mitk::ModelParameterizerBase.

Definition at line 93 of file mitkConcreteModelParameterizerBase.h.

◆ GetDerivedParameterNames()

template<class TModel >
ParameterNamesType mitk::ConcreteModelParameterizerBase< 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 123 of file mitkConcreteModelParameterizerBase.h.

◆ GetDerivedParameterScales()

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

Implements mitk::ModelTraitsInterface.

Definition at line 133 of file mitkConcreteModelParameterizerBase.h.

◆ GetDerivedParameterUnits()

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

Implements mitk::ModelTraitsInterface.

Definition at line 138 of file mitkConcreteModelParameterizerBase.h.

◆ GetFunctionString()

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

Implements mitk::ModelTraitsInterface.

Definition at line 153 of file mitkConcreteModelParameterizerBase.h.

◆ GetGlobalStaticParameters()

template<class TModel >
StaticParameterMapType mitk::ConcreteModelParameterizerBase< TModel >::GetGlobalStaticParameters ( ) const
inlineoverridevirtual

Implements mitk::ModelParameterizerBase.

Definition at line 47 of file mitkConcreteModelParameterizerBase.h.

Referenced by mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >::GenerateParameterizedModel().

◆ GetLocalStaticParameters()

template<class TModel >
StaticParameterMapType mitk::ConcreteModelParameterizerBase< TModel >::GetLocalStaticParameters ( const IndexType &  ) const
inlineoverridevirtual

Implements mitk::ModelParameterizerBase.

Definition at line 56 of file mitkConcreteModelParameterizerBase.h.

Referenced by mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >::GenerateParameterizedModel().

◆ GetModelDisplayName()

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

Implements mitk::ModelTraitsInterface.

Definition at line 143 of file mitkConcreteModelParameterizerBase.h.

◆ GetModelType()

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

Implements mitk::ModelTraitsInterface.

Definition at line 148 of file mitkConcreteModelParameterizerBase.h.

◆ GetNumberOfDerivedParameters()

template<class TModel >
ParametersSizeType mitk::ConcreteModelParameterizerBase< 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 128 of file mitkConcreteModelParameterizerBase.h.

◆ GetNumberOfParameters()

template<class TModel >
ParametersSizeType mitk::ConcreteModelParameterizerBase< 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 108 of file mitkConcreteModelParameterizerBase.h.

◆ GetParameterNames()

template<class TModel >
ParameterNamesType mitk::ConcreteModelParameterizerBase< 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 103 of file mitkConcreteModelParameterizerBase.h.

◆ GetParameterScales()

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

Implements mitk::ModelTraitsInterface.

Definition at line 113 of file mitkConcreteModelParameterizerBase.h.

◆ GetParameterUnits()

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

Implements mitk::ModelTraitsInterface.

Definition at line 118 of file mitkConcreteModelParameterizerBase.h.

◆ GetXAxisName()

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

Implements mitk::ModelTraitsInterface.

Definition at line 168 of file mitkConcreteModelParameterizerBase.h.

◆ GetXAxisUnit()

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

Implements mitk::ModelTraitsInterface.

Definition at line 173 of file mitkConcreteModelParameterizerBase.h.

◆ GetXName()

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

Implements mitk::ModelTraitsInterface.

Definition at line 163 of file mitkConcreteModelParameterizerBase.h.

◆ GetYAxisName()

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

Implements mitk::ModelTraitsInterface.

Definition at line 178 of file mitkConcreteModelParameterizerBase.h.

◆ GetYAxisUnit()

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

Implements mitk::ModelTraitsInterface.

Definition at line 183 of file mitkConcreteModelParameterizerBase.h.

◆ New()

template<class TModel >
static Pointer mitk::ConcreteModelParameterizerBase< TModel >::New ( )
static
The documentation for this class was generated from the following file: