Template base factory for TwoTissueCompartmentModel variants. More...

#include <mitkTwoTissueCompartmentModelFactoryBase.h>

Inheritance diagram for mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >:

[legend]

Collaboration diagram for mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >:

[legend]

Public Types
typedef Superclass::ModelType	ModelType

typedef Superclass::ModelParameterizerType	ModelParameterizerType

typedef Superclass::ParametersType	ParametersType

Public Types inherited from mitk::ConcreteAIFBasedModelFactory< TModelParameterizer >
typedef Superclass::ModelType	ModelType

typedef TModelParameterizer	ModelParameterizerType

Public Types inherited from mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >
typedef ModelFactoryBase::ModelBaseType	ModelBaseType

typedef ModelFactoryBase::ModelBasePointer	ModelBasePointer

typedef TModelParameterizer::ModelType	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
	Type representing the model output signal as an array of doubles. More...

using	ParameterValueType = double
	Type of a single parameter value. More...

typedef itk::Array< ParameterValueType >	ParametersType
	Type representing a vector of parameter values. More...

typedef std::string	ParameterNameType
	Type used for parameter names. More...

typedef std::vector< ParameterNameType >	ParameterNamesType
	Type for a list of parameter names. More...

typedef ParametersType::SizeValueType	ParametersSizeType
	Type for the count of parameters. More...

typedef ParameterNamesType	DerivedParameterNamesType
	Type for a list of derived parameter names. More...

typedef ParametersSizeType	DerivedParametersSizeType
	Type for the count of derived parameters. More...

typedef std::map< ParameterNameType, double >	ParamterScaleMapType
	Map type associating parameter names to their scaling factors. More...

typedef std::map< ParameterNameType, std::string >	ParamterUnitMapType
	Map type associating parameter names to their unit strings. More...

typedef std::map< ParameterNameType, double >	DerivedParamterScaleMapType
	Map type associating derived parameter names to their scaling factors. More...

typedef std::map< ParameterNameType, std::string >	DerivedParamterUnitMapType
	Map type associating derived parameter names to their unit strings. More...

typedef std::string	FunctionStringType
	Type for the function string representation of the model. More...

typedef std::string	ModellClassIDType
	Type for the unique class identifier of the model. More...

Public Member Functions
	mitkClassMacro (TwoTissueCompartmentModelFactoryBase, ConcreteAIFBasedModelFactory< TModelParameterizer >)

ConstraintCheckerBase::Pointer	CreateDefaultConstraints () const override
	Creates default constraints for the model fitting process. More...

ParametersType	GetDefaultInitialParameterization () const override
	Returns the default initial parameterization defined by the model developer. More...

Public Member Functions inherited from mitk::ConcreteAIFBasedModelFactory< TModelParameterizer >
	mitkClassMacro (ConcreteAIFBasedModelFactory, ConcreteModelFactoryBase< typename TModelParameterizer::ModelType >)

Public Member Functions inherited from mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >
	mitkClassMacro (ConcreteModelFactoryBase, ModelFactoryBase)

ModelBasePointer	CreateModel () const override
	Creates and returns a new instance of the model. More...

ConstraintCheckerBase::Pointer	CreateDefaultConstraints () const override
	Creates default constraints for the model fitting process. More...

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...

ParamterScaleMapType	GetParameterScales () const override
	Returns the scaling factors for all model parameters. 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...

DerivedParamterScaleMapType	GetDerivedParameterScales () const override
	Returns the scaling factors for all derived parameters. More...

DerivedParamterUnitMapType	GetDerivedParameterUnits () const override
	Returns the unit strings for all derived 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...

ModellClassIDType	GetClassID () const override
	Returns the unique class identifier for this model type. 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...

Public Member Functions inherited from mitk::ModelFactoryBase
	mitkClassMacroItkParent (ModelFactoryBase, itk::Object)

ModelParameterizerBase::Pointer	CreateParameterizer (const modelFit::ModelFitInfo *fit) const
	Creates a model parameterizer configured according to the given model fit info. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >
static ModelPointer	CreateConcreteModel ()

Protected Member Functions
	TwoTissueCompartmentModelFactoryBase ()

	~TwoTissueCompartmentModelFactoryBase () override

Protected Member Functions inherited from mitk::ConcreteAIFBasedModelFactory< TModelParameterizer >
ModelParameterizerBase::Pointer	DoCreateParameterizer (const modelFit::ModelFitInfo *fit) const override

	ConcreteAIFBasedModelFactory ()

	~ConcreteAIFBasedModelFactory () override

Protected Member Functions inherited from mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >
	ConcreteModelFactoryBase ()

	~ConcreteModelFactoryBase () override

Protected Member Functions inherited from mitk::ModelFactoryBase
	ModelFactoryBase ()

	~ModelFactoryBase () override

Protected Member Functions inherited from mitk::ModelTraitsInterface
	ModelTraitsInterface ()

virtual	~ModelTraitsInterface ()

Additional Inherited Members
Protected Attributes inherited from mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >
ModelPointer	m_Reference

Detailed Description

template<class TModelParameterizer>
class mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >

Template base factory for TwoTissueCompartmentModel variants.

Provides default constraint settings and initial parameterization for the two-tissue compartment model family (both reversible and FDG variants).

Template Parameters

TModelParameterizer The concrete parameterizer type.

See also: TwoTissueCompartmentModel, TwoTissueCompartmentFDGModel

Definition at line 31 of file mitkTwoTissueCompartmentModelFactoryBase.h.

Member Typedef Documentation

◆ ModelParameterizerType

template<class TModelParameterizer >

typedef Superclass::ModelParameterizerType mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::ModelParameterizerType

Definition at line 40 of file mitkTwoTissueCompartmentModelFactoryBase.h.

◆ ModelType

template<class TModelParameterizer >

typedef Superclass::ModelType mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::ModelType

Definition at line 39 of file mitkTwoTissueCompartmentModelFactoryBase.h.

◆ ParametersType

template<class TModelParameterizer >

typedef Superclass::ParametersType mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::ParametersType

Definition at line 41 of file mitkTwoTissueCompartmentModelFactoryBase.h.

Constructor & Destructor Documentation

◆ TwoTissueCompartmentModelFactoryBase()

template<class TModelParameterizer >

mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::TwoTissueCompartmentModelFactoryBase ( )

inlineprotected

Definition at line 74 of file mitkTwoTissueCompartmentModelFactoryBase.h.

◆ ~TwoTissueCompartmentModelFactoryBase()

template<class TModelParameterizer >

mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::~TwoTissueCompartmentModelFactoryBase ( )

inlineoverrideprotected

Definition at line 78 of file mitkTwoTissueCompartmentModelFactoryBase.h.

Member Function Documentation

◆ CreateDefaultConstraints()

template<class TModelParameterizer >

ConstraintCheckerBase::Pointer mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::CreateDefaultConstraints ( ) const

inlineoverridevirtual

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.

Implements mitk::ModelFactoryBase.

Definition at line 43 of file mitkTwoTissueCompartmentModelFactoryBase.h.

References mitk::SimpleBarrierConstraintChecker::New().

◆ GetDefaultInitialParameterization()

template<class TModelParameterizer >

ParametersType mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::GetDefaultInitialParameterization ( ) const

inlineoverridevirtual

Returns the default initial parameterization defined by the model developer.

Returns: The default initial parameter values for fitting.

Implements mitk::ModelFactoryBase.

Definition at line 64 of file mitkTwoTissueCompartmentModelFactoryBase.h.

◆ mitkClassMacro()

template<class TModelParameterizer >

mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::mitkClassMacro	(	TwoTissueCompartmentModelFactoryBase< TModelParameterizer >	,
		ConcreteAIFBasedModelFactory< TModelParameterizer >
	)

◆ New()

template<class TModelParameterizer >

static Pointer mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >::New ( )

static

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

mitkTwoTissueCompartmentModelFactoryBase.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class TModelParameterizer> class mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >

Member Typedef Documentation

◆ ModelParameterizerType

◆ ModelType

◆ ParametersType

Constructor & Destructor Documentation

◆ TwoTissueCompartmentModelFactoryBase()

◆ ~TwoTissueCompartmentModelFactoryBase()

Member Function Documentation

◆ CreateDefaultConstraints()

◆ GetDefaultInitialParameterization()

◆ mitkClassMacro()

◆ New()

template<class TModelParameterizer>
class mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >