mitk::ROIBasedParameterFitImageGenerator Class Reference

#include <mitkROIBasedParameterFitImageGenerator.h>

Inheritance diagram for mitk::ROIBasedParameterFitImageGenerator:

Collaboration diagram for mitk::ROIBasedParameterFitImageGenerator:

Public Types
using	ParameterImagePixelType = ScalarType
using	FunctorValueArrayType = std::vector< ParameterImagePixelType >
using	FitFunctorType = ModelFitFunctorBase
using	ParameterizerType = ModelParameterizerBase
using	ModelBaseType = ParameterFitImageGeneratorBase::ModelBaseType
using	ParameterNameType = ParameterFitImageGeneratorBase::ParameterNameType
using	ParameterImageMapType = ParameterFitImageGeneratorBase::ParameterImageMapType
using	TimeGridType = ModelBaseType::TimeGridType
using	SignalType = ModelBaseType::ModelResultType
Public Types inherited from mitk::ParameterFitImageGeneratorBase
using	ParameterImagePixelType = ScalarType
using	ModelBaseType = ModelBase
using	ParameterNameType = ModelBaseType::ParameterNameType
using	ParameterNamesType = ModelBaseType::ParameterNamesType
using	ParameterImageMapType = std::map< ParameterNameType, Image::Pointer >

Public Member Functions
	mitkClassMacro (ROIBasedParameterFitImageGenerator, ParameterFitImageGeneratorBase)
virtual void	SetMask (Image *_arg)
virtual const Image *	GetMask ()
virtual const SignalType &	GetSignal ()
virtual void	SetSignal (SignalType _arg)
virtual const TimeGridType &	GetTimeGrid ()
virtual void	SetTimeGrid (TimeGridType _arg)
virtual void	SetFitFunctor (FitFunctorType *_arg)
virtual FitFunctorType *	GetFitFunctor ()
virtual void	SetModelParameterizer (ParameterizerType *_arg)
virtual ParameterizerType *	GetModelParameterizer ()
double	GetProgress () const override
ParameterNamesType	GetParameterNames () const override
ParameterNamesType	GetDerivedParameterNames () const override
ParameterNamesType	GetCriterionNames () const override
ParameterNamesType	GetEvaluationParameterNames () const override
Public Member Functions inherited from mitk::ParameterFitImageGeneratorBase
	mitkClassMacroItkParent (ParameterFitImageGeneratorBase, ::itk::Object)
void	Generate ()
ParameterImageMapType	GetParameterImages ()
ParameterImageMapType	GetDerivedParameterImages ()
ParameterImageMapType	GetCriterionImages ()
ParameterImageMapType	GetEvaluationParameterImages ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	ROIBasedParameterFitImageGenerator ()
	~ROIBasedParameterFitImageGenerator () override=default
template<typename TPixel , unsigned int VDim>
void	DoImageGeneration (itk::Image< TPixel, VDim > *image, double value)
void	onFitProgressEvent (::itk::Object *caller, const ::itk::EventObject &eventObject)
bool	HasOutdatedResult () const override
void	CheckValidInputs () const override
void	DoFitAndGetResults (ParameterImageMapType &parameterImages, ParameterImageMapType &derivedParameterImages, ParameterImageMapType &criterionImages, ParameterImageMapType &evaluationParameterImages) override
Protected Member Functions inherited from mitk::ParameterFitImageGeneratorBase
	ParameterFitImageGeneratorBase ()
	~ParameterFitImageGeneratorBase () override

Additional Inherited Members
Protected Attributes inherited from mitk::ParameterFitImageGeneratorBase
itk::TimeStamp	m_GenerationTimeStamp

Detailed Description

Class for generators for parameter fits of a given model based on one given signal and its time grid. The class uses a model fit functor (based on ModelFitFunctorBase) given by the user. It will fit the model to the passed signal. To produce the output/parameter images, the passed mask will be used as template. The geometry of the mask specifies the geometry of the result images. Every pixel inside the mask (mask value > 0) will be filled with the fitting results. Every pixel outside the mask (mask value == 0) will be set to 0.
The generators creates 4 types of images:

• parameter images: The images that encode the results of each fitted parameter
• derived parameter images: Images that encode the results of derived parameters defined by the model
• criterion images: Images that encode the criterion value of the fitting strategy for the fitted parameters
• evaluation parameter images: Images that encode measures of additional evaluation cost functions defined by the user. (These were not part of the fitting strategy)

Definition at line 41 of file mitkROIBasedParameterFitImageGenerator.h.

Member Typedef Documentation

FitFunctorType

using mitk::ROIBasedParameterFitImageGenerator::FitFunctorType = ModelFitFunctorBase

Definition at line 51 of file mitkROIBasedParameterFitImageGenerator.h.

FunctorValueArrayType

using mitk::ROIBasedParameterFitImageGenerator::FunctorValueArrayType = std::vector<ParameterImagePixelType>

Definition at line 49 of file mitkROIBasedParameterFitImageGenerator.h.

ModelBaseType

using mitk::ROIBasedParameterFitImageGenerator::ModelBaseType = ParameterFitImageGeneratorBase::ModelBaseType

Definition at line 55 of file mitkROIBasedParameterFitImageGenerator.h.

ParameterImageMapType

using mitk::ROIBasedParameterFitImageGenerator::ParameterImageMapType = ParameterFitImageGeneratorBase::ParameterImageMapType

Definition at line 57 of file mitkROIBasedParameterFitImageGenerator.h.

ParameterImagePixelType

using mitk::ROIBasedParameterFitImageGenerator::ParameterImagePixelType = ScalarType

Definition at line 48 of file mitkROIBasedParameterFitImageGenerator.h.

ParameterizerType

using mitk::ROIBasedParameterFitImageGenerator::ParameterizerType = ModelParameterizerBase

Definition at line 53 of file mitkROIBasedParameterFitImageGenerator.h.

ParameterNameType

using mitk::ROIBasedParameterFitImageGenerator::ParameterNameType = ParameterFitImageGeneratorBase::ParameterNameType

Definition at line 56 of file mitkROIBasedParameterFitImageGenerator.h.

SignalType

using mitk::ROIBasedParameterFitImageGenerator::SignalType = ModelBaseType::ModelResultType

Definition at line 60 of file mitkROIBasedParameterFitImageGenerator.h.

TimeGridType

using mitk::ROIBasedParameterFitImageGenerator::TimeGridType = ModelBaseType::TimeGridType

Definition at line 59 of file mitkROIBasedParameterFitImageGenerator.h.

Constructor & Destructor Documentation

ROIBasedParameterFitImageGenerator()

mitk::ROIBasedParameterFitImageGenerator::ROIBasedParameterFitImageGenerator ( )

inlineprotected

Definition at line 88 of file mitkROIBasedParameterFitImageGenerator.h.

~ROIBasedParameterFitImageGenerator()

mitk::ROIBasedParameterFitImageGenerator::~ROIBasedParameterFitImageGenerator ( )

overrideprotecteddefault

Member Function Documentation

CheckValidInputs()

void mitk::ROIBasedParameterFitImageGenerator::CheckValidInputs ( ) const

overrideprotectedvirtual

Check if the fit can be generated and all needed inputs are valid. Throw an exception for a non valid or missing input.

Reimplemented from mitk::ParameterFitImageGeneratorBase.

DoFitAndGetResults()

void mitk::ROIBasedParameterFitImageGenerator::DoFitAndGetResults ( ParameterImageMapType &  parameterImages, ParameterImageMapType &  derivedParameterImages, ParameterImageMapType &  criterionImages, ParameterImageMapType &  evaluationParameterImages  )

overrideprotectedvirtual

Implements mitk::ParameterFitImageGeneratorBase.

DoImageGeneration()

template<typename TPixel , unsigned int VDim>

void mitk::ROIBasedParameterFitImageGenerator::DoImageGeneration ( itk::Image< TPixel, VDim > *  image, double  value  )

protected

GetCriterionNames()

ParameterNamesType mitk::ROIBasedParameterFitImageGenerator::GetCriterionNames ( ) const

overridevirtual

Returns the names of the criteria, that will be generated. These are also the keys of the related image map.

Implements mitk::ParameterFitImageGeneratorBase.

GetDerivedParameterNames()

ParameterNamesType mitk::ROIBasedParameterFitImageGenerator::GetDerivedParameterNames ( ) const

overridevirtual

Returns the names of the derived parameters, that will be generated. These are also the keys of the related image map.

Implements mitk::ParameterFitImageGeneratorBase.

GetEvaluationParameterNames()

ParameterNamesType mitk::ROIBasedParameterFitImageGenerator::GetEvaluationParameterNames ( ) const

overridevirtual

Returns the names of the evaluation parameters, that will be generated. These are also the keys of the related image map.

Implements mitk::ParameterFitImageGeneratorBase.

GetFitFunctor()

virtual FitFunctorType* mitk::ROIBasedParameterFitImageGenerator::GetFitFunctor ( )

virtual

GetMask()

virtual const Image* mitk::ROIBasedParameterFitImageGenerator::GetMask ( )

virtual

GetModelParameterizer()

virtual ParameterizerType* mitk::ROIBasedParameterFitImageGenerator::GetModelParameterizer ( )

virtual

GetParameterNames()

ParameterNamesType mitk::ROIBasedParameterFitImageGenerator::GetParameterNames ( ) const

overridevirtual

Returns the names of the fitted/generated parameters, that will be generated. These are also the keys of the related image map.

Implements mitk::ParameterFitImageGeneratorBase.

GetProgress()

double mitk::ROIBasedParameterFitImageGenerator::GetProgress ( ) const

overridevirtual

Returns the progress of the current fit. e.g. 0 : none; 0.5 = 50%; 1: complete

Implements mitk::ParameterFitImageGeneratorBase.

GetSignal()

virtual const SignalType& mitk::ROIBasedParameterFitImageGenerator::GetSignal ( )

virtual

GetTimeGrid()

virtual const TimeGridType& mitk::ROIBasedParameterFitImageGenerator::GetTimeGrid ( )

virtual

HasOutdatedResult()

bool mitk::ROIBasedParameterFitImageGenerator::HasOutdatedResult ( ) const

overrideprotectedvirtual

Reimplemented from mitk::ParameterFitImageGeneratorBase.

mitkClassMacro()

mitk::ROIBasedParameterFitImageGenerator::mitkClassMacro	(	ROIBasedParameterFitImageGenerator	,
		ParameterFitImageGeneratorBase
	)

New()

static Pointer mitk::ROIBasedParameterFitImageGenerator::New ( )

static

onFitProgressEvent()

void mitk::ROIBasedParameterFitImageGenerator::onFitProgressEvent ( ::itk::Object *  caller, const ::itk::EventObject &  eventObject  )

protected

SetFitFunctor()

virtual void mitk::ROIBasedParameterFitImageGenerator::SetFitFunctor ( FitFunctorType *  _arg )

virtual

SetMask()

virtual void mitk::ROIBasedParameterFitImageGenerator::SetMask ( Image *  _arg )

virtual

SetModelParameterizer()

virtual void mitk::ROIBasedParameterFitImageGenerator::SetModelParameterizer ( ParameterizerType *  _arg )

virtual

SetSignal()

virtual void mitk::ROIBasedParameterFitImageGenerator::SetSignal ( SignalType  _arg )

virtual

SetTimeGrid()

virtual void mitk::ROIBasedParameterFitImageGenerator::SetTimeGrid ( TimeGridType  _arg )

virtual

---

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

• mitkROIBasedParameterFitImageGenerator.h