mitk::TwoStepLinearModelFactory Class Reference

Factory for creating TwoStepLinearModel instances and their parameterizers. More...

#include <mitkTwoStepLinearModelFactory.h>

Inheritance diagram for mitk::TwoStepLinearModelFactory:

Collaboration diagram for mitk::TwoStepLinearModelFactory:

Public Member Functions
	mitkClassMacro (TwoStepLinearModelFactory, ConcreteModelFactoryBase< TwoStepLinearModel >)
ParametersType	GetDefaultInitialParameterization () const override
Public Member Functions inherited from mitk::ConcreteModelFactoryBase< TwoStepLinearModel >
	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< TwoStepLinearModel >
static ModelPointer	CreateConcreteModel ()

Protected Member Functions
ModelParameterizerBase::Pointer	DoCreateParameterizer (const modelFit::ModelFitInfo *fit) const override
	TwoStepLinearModelFactory ()
virtual	~TwoStepLinearModelFactory ()
Protected Member Functions inherited from mitk::ConcreteModelFactoryBase< TwoStepLinearModel >
	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
Public Types inherited from mitk::ConcreteModelFactoryBase< TwoStepLinearModel >
typedef ModelFactoryBase::ModelBaseType	ModelBaseType
typedef ModelFactoryBase::ModelBasePointer	ModelBasePointer
typedef TwoStepLinearModel	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...
Protected Attributes inherited from mitk::ConcreteModelFactoryBase< TwoStepLinearModel >
ModelPointer	m_Reference

Detailed Description

Factory for creating TwoStepLinearModel instances and their parameterizers.

See also

TwoStepLinearModel, TwoStepLinearModelParameterizer, ConcreteModelFactoryBase

Definition at line 33 of file mitkTwoStepLinearModelFactory.h.

Constructor & Destructor Documentation

TwoStepLinearModelFactory()

mitk::TwoStepLinearModelFactory::TwoStepLinearModelFactory ( )

protected

~TwoStepLinearModelFactory()

virtual mitk::TwoStepLinearModelFactory::~TwoStepLinearModelFactory ( )

protectedvirtual

Member Function Documentation

DoCreateParameterizer()

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

overrideprotectedvirtual

Implements mitk::ModelFactoryBase.

GetDefaultInitialParameterization()

ParametersType mitk::TwoStepLinearModelFactory::GetDefaultInitialParameterization ( ) const

overridevirtual

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

Implements mitk::ModelFactoryBase.

mitkClassMacro()

mitk::TwoStepLinearModelFactory::mitkClassMacro	(	TwoStepLinearModelFactory	,
		ConcreteModelFactoryBase< TwoStepLinearModel >
	)

New()

static Pointer mitk::TwoStepLinearModelFactory::New ( )

static

---

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

• mitkTwoStepLinearModelFactory.h