Medical Imaging Interaction Toolkit  2023.12.99-3b10b122
Medical Imaging Interaction Toolkit
mitk::ModelFitProviderBase< TModelFactory > Class Template Reference

Base class for model fit provider. More...

#include <mitkModelFitProviderBase.h>

Inheritance diagram for mitk::ModelFitProviderBase< TModelFactory >:
Collaboration diagram for mitk::ModelFitProviderBase< TModelFactory >:

Public Member Functions

itk::SmartPointer< ModelFactoryBaseGenerateFactory () const override
 
ModelBase::TimeGridType GetVariableGrid (const modelFit::ModelFitInfo *fitInfo) const override
 
us::ServiceRegistration< IModelFitProviderRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
 ModelFitProviderBase ()
 
 ~ModelFitProviderBase () override
 
- Public Member Functions inherited from mitk::IModelFitProvider
virtual ~IModelFitProvider ()
 

Protected Member Functions

 ModelFitProviderBase (const ModelFitProviderBase &other)
 
virtual us::ServiceProperties GetServiceProperties () const
 
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
 
int GetRanking () const
 

Additional Inherited Members

- Static Public Member Functions inherited from mitk::IModelFitProvider
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

template<class TModelFactory>
class mitk::ModelFitProviderBase< TModelFactory >

Base class for model fit provider.

Definition at line 32 of file mitkModelFitProviderBase.h.

Constructor & Destructor Documentation

◆ ModelFitProviderBase() [1/2]

template<class TModelFactory >
mitk::ModelFitProviderBase< TModelFactory >::ModelFitProviderBase ( )

◆ ~ModelFitProviderBase()

template<class TModelFactory >
mitk::ModelFitProviderBase< TModelFactory >::~ModelFitProviderBase ( )
override

◆ ModelFitProviderBase() [2/2]

template<class TModelFactory >
mitk::ModelFitProviderBase< TModelFactory >::ModelFitProviderBase ( const ModelFitProviderBase< TModelFactory > &  other)
protected

Member Function Documentation

◆ GenerateFactory()

template<class TModelFactory >
itk::SmartPointer<ModelFactoryBase> mitk::ModelFitProviderBase< TModelFactory >::GenerateFactory ( ) const
overridevirtual

Returns an instance of the model factory that is represented by the provider.

Implements mitk::IModelFitProvider.

◆ GetRanking()

template<class TModelFactory >
int mitk::ModelFitProviderBase< TModelFactory >::GetRanking ( ) const
protected

◆ GetServiceProperties()

template<class TModelFactory >
virtual us::ServiceProperties mitk::ModelFitProviderBase< TModelFactory >::GetServiceProperties ( ) const
protectedvirtual

◆ GetVariableGrid()

template<class TModelFactory >
ModelBase::TimeGridType mitk::ModelFitProviderBase< TModelFactory >::GetVariableGrid ( const modelFit::ModelFitInfo fitInfo) const
overridevirtual

Returns the grid of the model variable extracted from the fit info. The default implementation returns a time grid extracted from the time geometry of the fitInfo->inputImage. Reimplement for other models/fits to generate other variable grids.

Precondition
fitInfo is a valid instance for the model fit.

Implements mitk::IModelFitProvider.

◆ RegisterService()

template<class TModelFactory >
us::ServiceRegistration<IModelFitProvider> mitk::ModelFitProviderBase< TModelFactory >::RegisterService ( us::ModuleContext *  context = us::GetModuleContext())

◆ SetRanking()

template<class TModelFactory >
void mitk::ModelFitProviderBase< TModelFactory >::SetRanking ( int  ranking)
protected

Set the service ranking for this file reader.

Default is zero and should only be chosen differently for a reason. The ranking is used to determine which reader to use if several equivalent readers have been found. It may be used to replace a default reader from MITK in your own project. E.g. if you want to use your own reader for nrrd files instead of the default, implement it and give it a higher ranking than zero.

◆ UnregisterService()

template<class TModelFactory >
void mitk::ModelFitProviderBase< TModelFactory >::UnregisterService ( )

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