Medical Imaging Interaction Toolkit  2018.4.99-a3d2e8fb
Medical Imaging Interaction Toolkit
mitk::LinearModel Class Reference

#include <mitkLinearModel.h>

Inheritance diagram for mitk::LinearModel:
Collaboration diagram for mitk::LinearModel:

Public Types

typedef LinearModel Self
 
typedef mitk::ModelBase Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::ParameterNameType ParameterNameType
 
typedef Superclass::ParametersSizeType ParametersSizeType
 
- Public Types inherited from mitk::ModelBase
typedef ModelBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef ModelTraitsInterface::ModelResultType ModelResultType
 
typedef ModelTraitsInterface::ParameterValueType ParameterValueType
 
typedef ModelTraitsInterface::ParametersType ParametersType
 
typedef itk::Array< double > TimeGridType
 
typedef ModelTraitsInterface::ParameterNameType ParameterNameType
 
typedef ModelTraitsInterface::ParameterNamesType ParameterNamesType
 
typedef ModelTraitsInterface::ParametersSizeType ParametersSizeType
 
typedef ModelTraitsInterface::DerivedParameterNamesType DerivedParameterNamesType
 
typedef ModelTraitsInterface::DerivedParametersSizeType DerivedParametersSizeType
 
typedef double StaticParameterValueType
 
typedef std::vector< StaticParameterValueTypeStaticParameterValuesType
 
typedef std::map< ParameterNameType, StaticParameterValuesTypeStaticParameterMapType
 
typedef double DerivedParameterValueType
 
typedef std::map< ParameterNameType, DerivedParameterValueTypeDerivedParameterMapType
 
- 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

Pointer Clone () const
 
virtual const char * GetClassName () const
 
std::string GetModelDisplayName () const override
 
std::string GetModelType () const override
 
FunctionStringType GetFunctionString () const override
 
std::string GetXName () const override
 
ParameterNamesType GetParameterNames () const override
 
ParametersSizeType GetNumberOfParameters () const override
 
ParameterNamesType GetStaticParameterNames () const override
 
ParametersSizeType GetNumberOfStaticParameters () const override
 
ParameterNamesType GetDerivedParameterNames () const override
 
ParametersSizeType GetNumberOfDerivedParameters () const override
 
- Public Member Functions inherited from mitk::ModelBase
ParamterScaleMapType GetParameterScales () const override
 
ParamterUnitMapType GetParameterUnits () 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
 
virtual ParamterUnitMapType GetStaticParameterUnits () const
 
DerivedParameterNamesType GetDerivedParameterNames () const override
 
DerivedParametersSizeType GetNumberOfDerivedParameters () const override
 
void SetStaticParameters (const StaticParameterMapType &parameters, bool allParameters=true)
 
StaticParameterMapType GetStaticParameters () const
 
DerivedParameterMapType GetDerivedParameters (const ParametersType &parameters) const
 
virtual void SetTimeGrid (const TimeGridType &grid)
 
virtual const TimeGridTypeGetTimeGrid ()
 
ModelResultType GetSignal (const ParametersType &parameters) const
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 LinearModel ()
 
 ~LinearModel () override
 
itk::LightObject::Pointer InternalClone () const override
 
ModelResultType ComputeModelfunction (const ParametersType &parameters) const override
 
DerivedParameterMapType ComputeDerivedParameters (const mitk::ModelBase::ParametersType &parameters) const override
 
void SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values) override
 
StaticParameterValuesType GetStaticParameterValue (const ParameterNameType &name) const override
 
- Protected Member Functions inherited from mitk::ModelBase
virtual bool ValidateModel (std::string &error) const
 
 ModelBase ()
 
 ~ModelBase () override
 
void PrintSelf (std::ostream &os, ::itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::ModelTraitsInterface
 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::ModelBase
TimeGridType m_TimeGrid
 

Detailed Description

Definition at line 23 of file mitkLinearModel.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 30 of file mitkLinearModel.h.

◆ ParameterNameType

◆ ParametersSizeType

◆ Pointer

Definition at line 29 of file mitkLinearModel.h.

◆ Self

Definition at line 27 of file mitkLinearModel.h.

◆ Superclass

Constructor & Destructor Documentation

◆ LinearModel()

mitk::LinearModel::LinearModel ( )
inlineprotected

Definition at line 63 of file mitkLinearModel.h.

◆ ~LinearModel()

mitk::LinearModel::~LinearModel ( )
inlineoverrideprotected

Definition at line 64 of file mitkLinearModel.h.

Member Function Documentation

◆ Clone()

Pointer mitk::LinearModel::Clone ( ) const

◆ ComputeDerivedParameters()

mitk::ModelBase::DerivedParameterMapType mitk::LinearModel::ComputeDerivedParameters ( const mitk::ModelBase::ParametersType parameters) const
overrideprotectedvirtual

Helper function called by GetDerivedParameters(). Implement in derived classes to realize the concrete computation of derived parameters.

Remarks
Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

Definition at line 109 of file mitkLinearModel.cpp.

◆ ComputeModelfunction()

mitk::LinearModel::ModelResultType mitk::LinearModel::ComputeModelfunction ( const ParametersType parameters) const
overrideprotectedvirtual

Implements mitk::ModelBase.

Definition at line 65 of file mitkLinearModel.cpp.

References mitk::ModelBase::m_TimeGrid.

◆ GetClassName()

virtual const char* mitk::LinearModel::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterNames()

mitk::LinearModel::ParameterNamesType mitk::LinearModel::GetDerivedParameterNames ( ) const
overridevirtual

Returns the names of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

Implements mitk::ModelTraitsInterface.

Definition at line 51 of file mitkLinearModel.cpp.

◆ GetFunctionString()

mitk::LinearModel::FunctionStringType mitk::LinearModel::GetFunctionString ( ) const
overridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 25 of file mitkLinearModel.cpp.

◆ GetModelDisplayName()

std::string mitk::LinearModel::GetModelDisplayName ( ) const
overridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 15 of file mitkLinearModel.cpp.

◆ GetModelType()

std::string mitk::LinearModel::GetModelType ( ) const
overridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 20 of file mitkLinearModel.cpp.

◆ GetNumberOfDerivedParameters()

mitk::LinearModel::ParametersSizeType mitk::LinearModel::GetNumberOfDerivedParameters ( ) const
overridevirtual

Returns the number of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

Implements mitk::ModelTraitsInterface.

Definition at line 59 of file mitkLinearModel.cpp.

◆ GetNumberOfParameters()

mitk::LinearModel::ParametersSizeType mitk::LinearModel::GetNumberOfParameters ( ) const
overridevirtual

Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()).

Implements mitk::ModelTraitsInterface.

Definition at line 45 of file mitkLinearModel.cpp.

◆ GetNumberOfStaticParameters()

mitk::LinearModel::ParametersSizeType mitk::LinearModel::GetNumberOfStaticParameters ( ) const
overridevirtual

Returns the number of static parameters that will be used when using the model to compute the signal (but are not defined via GetSignal()).

Implements mitk::ModelBase.

Definition at line 88 of file mitkLinearModel.cpp.

◆ GetParameterNames()

mitk::LinearModel::ParameterNamesType mitk::LinearModel::GetParameterNames ( ) const
overridevirtual

Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()).

Implements mitk::ModelTraitsInterface.

Definition at line 36 of file mitkLinearModel.cpp.

◆ GetStaticParameterNames()

mitk::LinearModel::ParameterNamesType mitk::LinearModel::GetStaticParameterNames ( ) const
overridevirtual

Returns the names of static parameters that will be used when using the model to compute the signal (but are not defined via GetSignal()).

Implements mitk::ModelBase.

Definition at line 81 of file mitkLinearModel.cpp.

◆ GetStaticParameterValue()

mitk::LinearModel::StaticParameterValuesType mitk::LinearModel::GetStaticParameterValue ( const ParameterNameType name) const
overrideprotectedvirtual

Helper function called by GetStaticParameters(). Implement in derived classes to realize the concrete retrieval of static parameters.

Implements mitk::ModelBase.

Definition at line 99 of file mitkLinearModel.cpp.

◆ GetXName()

std::string mitk::LinearModel::GetXName ( ) const
overridevirtual

Implements mitk::ModelTraitsInterface.

Definition at line 30 of file mitkLinearModel.cpp.

◆ InternalClone()

itk::LightObject::Pointer mitk::LinearModel::InternalClone ( ) const
overrideprotected

Actual implementation of the clone method. This method should be reimplemeted in subclasses to clone the extra required parameters.

Definition at line 118 of file mitkLinearModel.cpp.

References mitk::ModelBase::m_TimeGrid, and New().

◆ New()

◆ SetStaticParameter()

void mitk::LinearModel::SetStaticParameter ( const ParameterNameType name,
const StaticParameterValuesType values 
)
overrideprotectedvirtual

Helper function called by SetStaticParameters(). Implement in derived classes to realize the concrete setting of static parameters.

Implements mitk::ModelBase.

Definition at line 93 of file mitkLinearModel.cpp.


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