Medical Imaging Interaction Toolkit  2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::PixelBasedParameterFitImageGenerator Class Reference

#include <mitkPixelBasedParameterFitImageGenerator.h>

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

Public Types

typedef ScalarType ParameterImagePixelType
 
typedef std::vector< ParameterImagePixelType > FunctorValueArrayType
 
typedef ModelFitFunctorBase FitFunctorType
 
typedef ModelParameterizerBase ParameterizerType
 
typedef ParameterFitImageGeneratorBase::ModelBaseType ModelBaseType
 
typedef ParameterFitImageGeneratorBase::ParameterNameType ParameterNameType
 
typedef ParameterFitImageGeneratorBase::ParameterImageMapType ParameterImageMapType
 
- 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 (PixelBasedParameterFitImageGenerator, ParameterFitImageGeneratorBase)
 
virtual void SetDynamicImage (Image *_arg)
 
virtual const Image * GetDynamicImage ()
 
virtual void SetMask (Image *_arg)
 
virtual const Image * GetMask ()
 
virtual void SetFitFunctor (FitFunctorType *_arg)
 
virtual FitFunctorType * GetFitFunctor ()
 
virtual void SetModelParameterizer (ParameterizerType *_arg)
 
virtual ParameterizerType * GetModelParameterizer ()
 
virtual void SetTimeGridByParameterizer (bool _arg)
 
virtual bool GetTimeGridByParameterizer ()
 
virtual void TimeGridByParameterizerOn ()
 
virtual void TimeGridByParameterizerOff ()
 
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

 PixelBasedParameterFitImageGenerator ()
 
 ~PixelBasedParameterFitImageGenerator () override=default
 
template<typename TPixel , unsigned int VDim>
void DoParameterFit (itk::Image< TPixel, VDim > *image)
 
template<typename TPixel , unsigned int VDim>
void DoPrepareMask (itk::Image< TPixel, VDim > *image)
 
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 pixel based parameter fits of a given model based on a given 4D mitk image. The class uses a model fit functor (based on ModelFitFunctorBase) given by the use.

Remarks
This generator fits every pixel on its own. If you want to fit the mean value of the given mask use ROIBasedParameterFitImageGenerator. The generator 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 40 of file mitkPixelBasedParameterFitImageGenerator.h.

Member Typedef Documentation

◆ FitFunctorType

typedef ModelFitFunctorBase mitk::PixelBasedParameterFitImageGenerator::FitFunctorType

Definition at line 50 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ FunctorValueArrayType

typedef std::vector<ParameterImagePixelType> mitk::PixelBasedParameterFitImageGenerator::FunctorValueArrayType

Definition at line 48 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ ModelBaseType

typedef ParameterFitImageGeneratorBase::ModelBaseType mitk::PixelBasedParameterFitImageGenerator::ModelBaseType

Definition at line 54 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ ParameterImageMapType

typedef ParameterFitImageGeneratorBase::ParameterImageMapType mitk::PixelBasedParameterFitImageGenerator::ParameterImageMapType

Definition at line 56 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ ParameterImagePixelType

typedef ScalarType mitk::PixelBasedParameterFitImageGenerator::ParameterImagePixelType

Definition at line 45 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ ParameterizerType

typedef ModelParameterizerBase mitk::PixelBasedParameterFitImageGenerator::ParameterizerType

Definition at line 52 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ ParameterNameType

typedef ParameterFitImageGeneratorBase::ParameterNameType mitk::PixelBasedParameterFitImageGenerator::ParameterNameType

Definition at line 55 of file mitkPixelBasedParameterFitImageGenerator.h.

Constructor & Destructor Documentation

◆ PixelBasedParameterFitImageGenerator()

mitk::PixelBasedParameterFitImageGenerator::PixelBasedParameterFitImageGenerator ( )
inlineprotected

Definition at line 85 of file mitkPixelBasedParameterFitImageGenerator.h.

◆ ~PixelBasedParameterFitImageGenerator()

mitk::PixelBasedParameterFitImageGenerator::~PixelBasedParameterFitImageGenerator ( )
overrideprotecteddefault

Member Function Documentation

◆ CheckValidInputs()

void mitk::PixelBasedParameterFitImageGenerator::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::PixelBasedParameterFitImageGenerator::DoFitAndGetResults ( ParameterImageMapType &  parameterImages,
ParameterImageMapType &  derivedParameterImages,
ParameterImageMapType &  criterionImages,
ParameterImageMapType &  evaluationParameterImages 
)
overrideprotectedvirtual

Implements mitk::ParameterFitImageGeneratorBase.

◆ DoParameterFit()

template<typename TPixel , unsigned int VDim>
void mitk::PixelBasedParameterFitImageGenerator::DoParameterFit ( itk::Image< TPixel, VDim > *  image)
protected

◆ DoPrepareMask()

template<typename TPixel , unsigned int VDim>
void mitk::PixelBasedParameterFitImageGenerator::DoPrepareMask ( itk::Image< TPixel, VDim > *  image)
protected

◆ GetCriterionNames()

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

◆ GetDynamicImage()

virtual const Image* mitk::PixelBasedParameterFitImageGenerator::GetDynamicImage ( )
virtual

◆ GetEvaluationParameterNames()

ParameterNamesType mitk::PixelBasedParameterFitImageGenerator::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::PixelBasedParameterFitImageGenerator::GetFitFunctor ( )
virtual

◆ GetMask()

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

◆ GetModelParameterizer()

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

◆ GetParameterNames()

ParameterNamesType mitk::PixelBasedParameterFitImageGenerator::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::PixelBasedParameterFitImageGenerator::GetProgress ( ) const
overridevirtual

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

Implements mitk::ParameterFitImageGeneratorBase.

◆ GetTimeGridByParameterizer()

virtual bool mitk::PixelBasedParameterFitImageGenerator::GetTimeGridByParameterizer ( )
virtual

◆ HasOutdatedResult()

bool mitk::PixelBasedParameterFitImageGenerator::HasOutdatedResult ( ) const
overrideprotectedvirtual

Reimplemented from mitk::ParameterFitImageGeneratorBase.

◆ mitkClassMacro()

mitk::PixelBasedParameterFitImageGenerator::mitkClassMacro ( PixelBasedParameterFitImageGenerator  ,
ParameterFitImageGeneratorBase   
)

◆ New()

static Pointer mitk::PixelBasedParameterFitImageGenerator::New ( )
static

◆ onFitProgressEvent()

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

◆ SetDynamicImage()

virtual void mitk::PixelBasedParameterFitImageGenerator::SetDynamicImage ( Image *  _arg)
virtual

◆ SetFitFunctor()

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

◆ SetMask()

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

◆ SetModelParameterizer()

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

◆ SetTimeGridByParameterizer()

virtual void mitk::PixelBasedParameterFitImageGenerator::SetTimeGridByParameterizer ( bool  _arg)
virtual

◆ TimeGridByParameterizerOff()

virtual void mitk::PixelBasedParameterFitImageGenerator::TimeGridByParameterizerOff ( )
virtual

◆ TimeGridByParameterizerOn()

virtual void mitk::PixelBasedParameterFitImageGenerator::TimeGridByParameterizerOn ( )
virtual
The documentation for this class was generated from the following file: