mitk::ModelFactoryBase Class Reference

#include <mitkModelFactoryBase.h>

Inheritance diagram for mitk::ModelFactoryBase:

Collaboration diagram for mitk::ModelFactoryBase:

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

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

Base class for model factories. Default implementation just passes the model properties through from an instance created with add model. To use the the base class, derive and at least implement the abstract member functions.

Definition at line 32 of file mitkModelFactoryBase.h.

Member Typedef Documentation

DerivedParameterNamesType

typedef ModelTraitsInterface::DerivedParameterNamesType mitk::ModelFactoryBase::DerivedParameterNamesType

Definition at line 54 of file mitkModelFactoryBase.h.

DerivedParametersSizeType

typedef ModelTraitsInterface::DerivedParametersSizeType mitk::ModelFactoryBase::DerivedParametersSizeType

Definition at line 55 of file mitkModelFactoryBase.h.

DerivedParamterScaleMapType

typedef ModelTraitsInterface::DerivedParamterScaleMapType mitk::ModelFactoryBase::DerivedParamterScaleMapType

Definition at line 56 of file mitkModelFactoryBase.h.

DerivedParamterUnitMapType

typedef ModelTraitsInterface::DerivedParamterUnitMapType mitk::ModelFactoryBase::DerivedParamterUnitMapType

Definition at line 57 of file mitkModelFactoryBase.h.

FunctionStringType

typedef ModelTraitsInterface::FunctionStringType mitk::ModelFactoryBase::FunctionStringType

Definition at line 51 of file mitkModelFactoryBase.h.

ModelBasePointer

typedef ModelBaseType::Pointer mitk::ModelFactoryBase::ModelBasePointer

Definition at line 43 of file mitkModelFactoryBase.h.

ModelBaseType

typedef ModelBase mitk::ModelFactoryBase::ModelBaseType

Definition at line 42 of file mitkModelFactoryBase.h.

ModellClassIDType

typedef ModelTraitsInterface::ModellClassIDType mitk::ModelFactoryBase::ModellClassIDType

Definition at line 52 of file mitkModelFactoryBase.h.

ParameterNamesType

typedef ModelTraitsInterface::ParameterNamesType mitk::ModelFactoryBase::ParameterNamesType

Definition at line 46 of file mitkModelFactoryBase.h.

ParameterNameType

typedef ModelTraitsInterface::ParameterNameType mitk::ModelFactoryBase::ParameterNameType

Definition at line 45 of file mitkModelFactoryBase.h.

ParametersSizeType

typedef ModelTraitsInterface::ParametersSizeType mitk::ModelFactoryBase::ParametersSizeType

Definition at line 47 of file mitkModelFactoryBase.h.

ParamterScaleMapType

typedef ModelTraitsInterface::ParamterScaleMapType mitk::ModelFactoryBase::ParamterScaleMapType

Definition at line 49 of file mitkModelFactoryBase.h.

ParamterUnitMapType

typedef ModelTraitsInterface::ParamterUnitMapType mitk::ModelFactoryBase::ParamterUnitMapType

Definition at line 50 of file mitkModelFactoryBase.h.

Constructor & Destructor Documentation

ModelFactoryBase()

mitk::ModelFactoryBase::ModelFactoryBase ( )

protected

~ModelFactoryBase()

mitk::ModelFactoryBase::~ModelFactoryBase ( )

overrideprotected

Member Function Documentation

CreateDefaultConstraints()

virtual ConstraintCheckerBase::Pointer mitk::ModelFactoryBase::CreateDefaultConstraints ( ) const

pure virtual

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.

Implemented in mitk::ConcreteModelFactoryBase< TModel >, mitk::ExtendedOneTissueCompartmentModelFactory, mitk::TwoCompartmentExchangeModelFactoryBase< TModelParameterizer >, mitk::ExponentialDecayModelFactory, mitk::ExponentialSaturationModelFactory, mitk::ExtendedToftsModelFactory, mitk::OneTissueCompartmentModelFactory, mitk::TwoTissueCompartmentFDGModelFactory, mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >, and mitk::StandardToftsModelFactory.

CreateModel()

virtual ModelBasePointer mitk::ModelFactoryBase::CreateModel ( ) const

pure virtual

Implemented in mitk::ConcreteModelFactoryBase< TModel >.

CreateParameterizer()

ModelParameterizerBase::Pointer mitk::ModelFactoryBase::CreateParameterizer

(

const modelFit::ModelFitInfo *

fit

)

const

Created a model parameterizer set up according to the passed model fit info.

Precondition

fit must point to a valid instance.

DoCreateParameterizer()

virtual ModelParameterizerBase::Pointer mitk::ModelFactoryBase::DoCreateParameterizer ( const modelFit::ModelFitInfo *  fit ) const

protectedpure virtual

Implemented in mitk::GenericParamModelFactory, mitk::ThreeStepLinearModelFactory, mitk::ExpDecayOffsetModelFactory, mitk::ExponentialDecayModelFactory, mitk::ExponentialSaturationModelFactory, mitk::LinearModelFactory, mitk::DescriptivePharmacokineticBrixModelFactory, mitk::TestModelFactory, mitk::ConcreteAIFBasedModelFactory< TModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< ExtendedToftsModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< TwoTissueCompartmentFDGModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< ExtendedOneTissueCompartmentModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< StandardToftsModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< OneTissueCompartmentModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< TwoCompartmentExchangeModelParameterizer >, mitk::ConcreteAIFBasedModelFactory< TwoTissueCompartmentModelParameterizer >, and mitk::TwoStepLinearModelFactory.

GetDefaultInitialParameterization()

virtual ParametersType mitk::ModelFactoryBase::GetDefaultInitialParameterization ( ) const

pure virtual

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

Implemented in mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >, mitk::TwoCompartmentExchangeModelFactoryBase< TModelParameterizer >, mitk::ExtendedOneTissueCompartmentModelFactory, mitk::GenericParamModelFactory, mitk::ThreeStepLinearModelFactory, mitk::ExtendedToftsModelFactory, mitk::OneTissueCompartmentModelFactory, mitk::TwoTissueCompartmentFDGModelFactory, mitk::LinearModelFactory, mitk::DescriptivePharmacokineticBrixModelFactory, mitk::StandardToftsModelFactory, mitk::ExpDecayOffsetModelFactory, mitk::ExponentialDecayModelFactory, mitk::ExponentialSaturationModelFactory, mitk::TestModelFactory, and mitk::TwoStepLinearModelFactory.

mitkClassMacroItkParent()

mitk::ModelFactoryBase::mitkClassMacroItkParent	(	ModelFactoryBase	,
		itk::Object
	)

---

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

• mitkModelFactoryBase.h