Medical Imaging Interaction Toolkit  2018.4.99-65942676
Medical Imaging Interaction Toolkit
mitk::ModelFactoryBase Class Referenceabstract

#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< ParameterValueTypeParametersType
 
typedef std::string ParameterNameType
 
typedef std::vector< ParameterNameTypeParameterNamesType
 
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

◆ DerivedParametersSizeType

◆ DerivedParamterScaleMapType

◆ DerivedParamterUnitMapType

◆ FunctionStringType

◆ ModelBasePointer

◆ ModelBaseType

◆ ModellClassIDType

◆ ParameterNamesType

◆ ParameterNameType

◆ ParametersSizeType

◆ ParamterScaleMapType

◆ ParamterUnitMapType

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::ConcreteModelFactoryBase< TwoTissueCompartmentFDGModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< TwoCompartmentExchangeModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< NumericTwoTissueCompartmentModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< ExtendedToftsModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< NumericTwoCompartmentExchangeModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< T2DecayModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< TwoTissueCompartmentModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< ExtendedOneTissueCompartmentModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< OneTissueCompartmentModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< StandardToftsModelParameterizer ::ModelType >, mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >, mitk::ExtendedOneTissueCompartmentModelFactory, mitk::TwoCompartmentExchangeModelFactoryBase< TModelParameterizer >, mitk::TwoCompartmentExchangeModelFactoryBase< NumericTwoCompartmentExchangeModelParameterizer >, mitk::TwoCompartmentExchangeModelFactoryBase< TwoCompartmentExchangeModelParameterizer >, mitk::T2DecayModelFactory, mitk::ExtendedToftsModelFactory, mitk::OneTissueCompartmentModelFactory, mitk::TwoTissueCompartmentFDGModelFactory, mitk::TwoTissueCompartmentModelFactoryBase< TModelParameterizer >, mitk::TwoTissueCompartmentModelFactoryBase< TwoTissueCompartmentModelParameterizer >, mitk::TwoTissueCompartmentModelFactoryBase< NumericTwoTissueCompartmentModelParameterizer >, and mitk::StandardToftsModelFactory.

◆ CreateModel()

◆ 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()

◆ GetDefaultInitialParameterization()

◆ mitkClassMacroItkParent()

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

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