Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
mitk::ThreeStepLinearModel Class Reference

#include <mitkThreeStepLinearModel.h>

Inheritance diagram for mitk::ThreeStepLinearModel:
Inheritance graph
[legend]
Collaboration diagram for mitk::ThreeStepLinearModel:
Collaboration graph
[legend]

Public Types

typedef ThreeStepLinearModel Self
 
typedef mitk::ModelBase Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::ParameterNameType ParameterNameType
 
typedef Superclass::ParametersSizeType ParametersSizeType
 
- Public Types inherited from mitk::ModelBase
typedef ModelBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
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< StaticParameterValueType > StaticParameterValuesType
 
typedef std::map< ParameterNameType, StaticParameterValuesType > StaticParameterMapType
 
typedef double DerivedParameterValueType
 
typedef std::map< ParameterNameType, DerivedParameterValueType > DerivedParameterMapType
 
- 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

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
 
ParamterUnitMapType GetParameterUnits () const override
 
ParameterNamesType GetStaticParameterNames () const override
 
ParametersSizeType GetNumberOfStaticParameters () const override
 
ParameterNamesType GetDerivedParameterNames () const override
 
ParametersSizeType GetNumberOfDerivedParameters () const override
 
ParamterUnitMapType GetDerivedParameterUnits () const override
 
- Public Member Functions inherited from mitk::ModelBase
ParamterScaleMapType GetParameterScales () const override
 
DerivedParamterScaleMapType GetDerivedParameterScales () const override
 
ModellClassIDType GetClassID () 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
 
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 TimeGridType & GetTimeGrid ()
 
ModelResultType GetSignal (const ParametersType &parameters) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const std::string MODEL_DISPLAY_NAME
 
static const std::string NAME_PARAMETER_S0
 
static const std::string NAME_PARAMETER_t1
 
static const std::string NAME_PARAMETER_t2
 
static const std::string NAME_PARAMETER_a1
 
static const std::string NAME_PARAMETER_a2
 
static const std::string NAME_PARAMETER_b1
 
static const std::string NAME_PARAMETER_b2
 
static const std::string UNIT_PARAMETER_S0
 
static const std::string UNIT_PARAMETER_t1
 
static const std::string UNIT_PARAMETER_t2
 
static const std::string UNIT_PARAMETER_a1
 
static const std::string UNIT_PARAMETER_a2
 
static const std::string UNIT_PARAMETER_b1
 
static const std::string UNIT_PARAMETER_b2
 
static const unsigned int POSITION_PARAMETER_S0
 
static const unsigned int POSITION_PARAMETER_t1
 
static const unsigned int POSITION_PARAMETER_t2
 
static const unsigned int POSITION_PARAMETER_a1
 
static const unsigned int POSITION_PARAMETER_a2
 
static const unsigned int POSITION_PARAMETER_b1
 
static const unsigned int POSITION_PARAMETER_b2
 
static const unsigned int NUMBER_OF_PARAMETERS
 

Protected Member Functions

 ThreeStepLinearModel ()
 
 ~ThreeStepLinearModel () 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 mitkThreeStepLinearModel.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer< const Self > mitk::ThreeStepLinearModel::ConstPointer

Definition at line 30 of file mitkThreeStepLinearModel.h.

◆ ParameterNameType

typedef Superclass::ParameterNameType mitk::ThreeStepLinearModel::ParameterNameType

Definition at line 32 of file mitkThreeStepLinearModel.h.

◆ ParametersSizeType

typedef Superclass::ParametersSizeType mitk::ThreeStepLinearModel::ParametersSizeType

Definition at line 33 of file mitkThreeStepLinearModel.h.

◆ Pointer

typedef itk::SmartPointer< Self > mitk::ThreeStepLinearModel::Pointer

Definition at line 29 of file mitkThreeStepLinearModel.h.

◆ Self

typedef ThreeStepLinearModel mitk::ThreeStepLinearModel::Self

Definition at line 27 of file mitkThreeStepLinearModel.h.

◆ Superclass

typedef mitk::ModelBase mitk::ThreeStepLinearModel::Superclass

Definition at line 28 of file mitkThreeStepLinearModel.h.

Constructor & Destructor Documentation

◆ ThreeStepLinearModel()

mitk::ThreeStepLinearModel::ThreeStepLinearModel ( )
inlineprotected

Definition at line 95 of file mitkThreeStepLinearModel.h.

◆ ~ThreeStepLinearModel()

mitk::ThreeStepLinearModel::~ThreeStepLinearModel ( )
inlineoverrideprotected

Definition at line 96 of file mitkThreeStepLinearModel.h.

Member Function Documentation

◆ Clone()

Pointer mitk::ThreeStepLinearModel::Clone ( ) const

◆ ComputeDerivedParameters()

DerivedParameterMapType mitk::ThreeStepLinearModel::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.

◆ ComputeModelfunction()

ModelResultType mitk::ThreeStepLinearModel::ComputeModelfunction ( const ParametersType &  parameters) const
overrideprotectedvirtual

Implements mitk::ModelBase.

◆ GetClassName()

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

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterNames()

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

Returns the names of derived parameters that can/will be computed by the model given specific model parameters.

Remarks
Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterUnits()

ParamterUnitMapType mitk::ThreeStepLinearModel::GetDerivedParameterUnits ( ) const
overridevirtual

Default implementation returns no unit string ("") for every defined derived parameter.

Reimplemented from mitk::ModelBase.

◆ GetFunctionString()

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

Default implementation returns an empty functions string.

Reimplemented from mitk::ModelBase.

◆ GetModelDisplayName()

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

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

◆ GetModelType()

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

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

◆ GetNumberOfDerivedParameters()

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

Returns the number of derived parameters that can/will be computed by the model given specific model parameters.

Remarks
Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

◆ GetNumberOfParameters()

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

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

Implements mitk::ModelTraitsInterface.

◆ GetNumberOfStaticParameters()

ParametersSizeType mitk::ThreeStepLinearModel::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.

◆ GetParameterNames()

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

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

Implements mitk::ModelTraitsInterface.

◆ GetParameterUnits()

ParamterUnitMapType mitk::ThreeStepLinearModel::GetParameterUnits ( ) const
overridevirtual

Default implementation returns no unit string ("") for every defined parameter.

Reimplemented from mitk::ModelBase.

◆ GetStaticParameterNames()

ParameterNamesType mitk::ThreeStepLinearModel::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.

◆ GetStaticParameterValue()

StaticParameterValuesType mitk::ThreeStepLinearModel::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.

◆ GetXName()

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

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

◆ InternalClone()

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

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

◆ New()

static Pointer mitk::ThreeStepLinearModel::New ( )
static

Method for creation through the object factory.

◆ SetStaticParameter()

void mitk::ThreeStepLinearModel::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.

Member Data Documentation

◆ MODEL_DISPLAY_NAME

const std::string mitk::ThreeStepLinearModel::MODEL_DISPLAY_NAME
static

Definition at line 40 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_a1

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_a1
static

Definition at line 46 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_a2

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_a2
static

Definition at line 47 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_b1

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_b1
static

Definition at line 48 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_b2

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_b2
static

Definition at line 49 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_S0

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_S0
static

Definition at line 43 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_t1

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_t1
static

Definition at line 44 of file mitkThreeStepLinearModel.h.

◆ NAME_PARAMETER_t2

const std::string mitk::ThreeStepLinearModel::NAME_PARAMETER_t2
static

Definition at line 45 of file mitkThreeStepLinearModel.h.

◆ NUMBER_OF_PARAMETERS

const unsigned int mitk::ThreeStepLinearModel::NUMBER_OF_PARAMETERS
static

Definition at line 67 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_a1

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_a1
static

Definition at line 62 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_a2

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_a2
static

Definition at line 63 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_b1

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_b1
static

Definition at line 64 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_b2

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_b2
static

Definition at line 65 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_S0

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_S0
static

Definition at line 59 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_t1

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_t1
static

Definition at line 60 of file mitkThreeStepLinearModel.h.

◆ POSITION_PARAMETER_t2

const unsigned int mitk::ThreeStepLinearModel::POSITION_PARAMETER_t2
static

Definition at line 61 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_a1

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_a1
static

Definition at line 54 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_a2

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_a2
static

Definition at line 55 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_b1

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_b1
static

Definition at line 56 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_b2

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_b2
static

Definition at line 57 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_S0

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_S0
static

Definition at line 51 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_t1

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_t1
static

Definition at line 52 of file mitkThreeStepLinearModel.h.

◆ UNIT_PARAMETER_t2

const std::string mitk::ThreeStepLinearModel::UNIT_PARAMETER_t2
static

Definition at line 53 of file mitkThreeStepLinearModel.h.

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