Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::IModelFitProvider Struct Referenceabstract

The common interface for all model providers for model fitting. More...

#include <mitkIModelFitProvider.h>

Inheritance diagram for mitk::IModelFitProvider:

Public Member Functions

virtual ~IModelFitProvider ()
 
virtual itk::SmartPointer< ModelFactoryBaseGenerateFactory () const =0
 returns a factory instance for the model represented by the provider. More...
 
virtual ModelBase::TimeGridType GetVariableGrid (const modelFit::ModelFitInfo *fitInfo) const =0
 

Static Public Member Functions

static std::string PROP_DESCRIPTION ()
 Service property name for a description. More...
 
static std::string PROP_MODEL_CLASS_ID ()
 Service property name for the model ID handled by the provider. More...
 
static std::string PROP_MODEL_TYPE ()
 Service property name for the model type of the model handled by the provider. More...
 

Detailed Description

The common interface for all model providers for model fitting.

Implementations of this interface must be registered as a service to make themselves available via the service registry.

It is recommended to derive new implementations from ModelFitProviderBase or from AbstractFileIO (if both reader and writer is implemented), which provide correct service registration semantics.

See also
ModelFitProviderBase

Definition at line 52 of file mitkIModelFitProvider.h.

Constructor & Destructor Documentation

◆ ~IModelFitProvider()

virtual mitk::IModelFitProvider::~IModelFitProvider ( )
virtual

Member Function Documentation

◆ GenerateFactory()

virtual itk::SmartPointer<ModelFactoryBase> mitk::IModelFitProvider::GenerateFactory ( ) const
pure virtual

returns a factory instance for the model represented by the provider.

Implemented in mitk::ModelFitProviderBase< TModelFactory >.

◆ GetVariableGrid()

virtual ModelBase::TimeGridType mitk::IModelFitProvider::GetVariableGrid ( const modelFit::ModelFitInfo fitInfo) const
pure virtual
Parameters
fitInfoPointer to a fit info instance for the respective model.

This methods returns the values of the model variable that was used by the fit. Normally it is a time grid directly extracted from the input image time geometry. But depending on the model and fit it could be generated out of other properties. This method is a.o. used when the fit should be plotted correctly.

Implemented in mitk::ModelFitProviderBase< TModelFactory >.

◆ PROP_DESCRIPTION()

static std::string mitk::IModelFitProvider::PROP_DESCRIPTION ( )
static

Service property name for a description.

The property value must be of type std::string.

Returns
The property name.

◆ PROP_MODEL_CLASS_ID()

static std::string mitk::IModelFitProvider::PROP_MODEL_CLASS_ID ( )
static

Service property name for the model ID handled by the provider.

The property value must be of type std::string.

Returns
The property name.

◆ PROP_MODEL_TYPE()

static std::string mitk::IModelFitProvider::PROP_MODEL_TYPE ( )
static

Service property name for the model type of the model handled by the provider.

The property value must be of type std::string.

Returns
The property name.

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