Medical Imaging Interaction Toolkit  2018.4.99-1bab67a2
Medical Imaging Interaction Toolkit
mitk::ParameterFitImageGeneratorBase Class Referenceabstract

#include <mitkParameterFitImageGeneratorBase.h>

Inheritance diagram for mitk::ParameterFitImageGeneratorBase:
Collaboration diagram for mitk::ParameterFitImageGeneratorBase:

Public Types

using ParameterImagePixelType = ScalarType
 
using ModelBaseType = ModelBase
 
using ParameterNameType = ModelBaseType::ParameterNameType
 
using ParameterNamesType = ModelBaseType::ParameterNamesType
 
using ParameterImageMapType = std::map< ParameterNameType, Image::Pointer >
 

Public Member Functions

 mitkClassMacroItkParent (ParameterFitImageGeneratorBase, ::itk::Object)
 
virtual double GetProgress () const =0
 
void Generate ()
 
ParameterImageMapType GetParameterImages ()
 
ParameterImageMapType GetDerivedParameterImages ()
 
ParameterImageMapType GetCriterionImages ()
 
ParameterImageMapType GetEvaluationParameterImages ()
 
virtual ParameterNamesType GetParameterNames () const =0
 
virtual ParameterNamesType GetDerivedParameterNames () const =0
 
virtual ParameterNamesType GetCriterionNames () const =0
 
virtual ParameterNamesType GetEvaluationParameterNames () const =0
 

Protected Member Functions

 ParameterFitImageGeneratorBase ()
 
 ~ParameterFitImageGeneratorBase () override
 
virtual bool HasOutdatedResult () const
 
virtual void CheckValidInputs () const
 
virtual void DoFitAndGetResults (ParameterImageMapType &parameterImages, ParameterImageMapType &derivedParameterImages, ParameterImageMapType &criterionImages, ParameterImageMapType &evaluationParameterImages)=0
 

Protected Attributes

itk::TimeStamp m_GenerationTimeStamp
 

Detailed Description

Base class for generators for parameter fits of a given model. 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 34 of file mitkParameterFitImageGeneratorBase.h.

Member Typedef Documentation

◆ ModelBaseType

◆ ParameterImageMapType

◆ ParameterImagePixelType

◆ ParameterNamesType

◆ ParameterNameType

Constructor & Destructor Documentation

◆ ParameterFitImageGeneratorBase()

mitk::ParameterFitImageGeneratorBase::ParameterFitImageGeneratorBase ( )
inlineprotected

Definition at line 83 of file mitkParameterFitImageGeneratorBase.h.

◆ ~ParameterFitImageGeneratorBase()

mitk::ParameterFitImageGeneratorBase::~ParameterFitImageGeneratorBase ( )
inlineoverrideprotected

Definition at line 84 of file mitkParameterFitImageGeneratorBase.h.

Member Function Documentation

◆ CheckValidInputs()

void mitk::ParameterFitImageGeneratorBase::CheckValidInputs ( ) const
protectedvirtual

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

Reimplemented in mitk::PixelBasedParameterFitImageGenerator, and mitk::ROIBasedParameterFitImageGenerator.

Definition at line 24 of file mitkParameterFitImageGeneratorBase.cpp.

Referenced by Generate().

◆ DoFitAndGetResults()

virtual void mitk::ParameterFitImageGeneratorBase::DoFitAndGetResults ( ParameterImageMapType parameterImages,
ParameterImageMapType derivedParameterImages,
ParameterImageMapType criterionImages,
ParameterImageMapType evaluationParameterImages 
)
protectedpure virtual

◆ Generate()

void mitk::ParameterFitImageGeneratorBase::Generate ( )

Commences the model fit over the dynamic image data. Stores the fitted parameter in parameter images. After this method call is finished the parameter images can be retrieved via GetParameterImages.

Precondition
Model must be set
DynamicImage must be set
Postcondition
Parameter image map contains an image for every parameter of the model referenced by the parameter name.

Definition at line 30 of file mitkParameterFitImageGeneratorBase.cpp.

References CheckValidInputs(), DoFitAndGetResults(), HasOutdatedResult(), and m_GenerationTimeStamp.

Referenced by GetCriterionImages(), GetDerivedParameterImages(), GetEvaluationParameterImages(), and GetParameterImages().

◆ GetCriterionImages()

mitk::ParameterFitImageGeneratorBase::ParameterImageMapType mitk::ParameterFitImageGeneratorBase::GetCriterionImages ( )

Returns the generated criterion images. Triggers Generate() if result is outdated.

Definition at line 77 of file mitkParameterFitImageGeneratorBase.cpp.

References Generate(), and HasOutdatedResult().

Referenced by mitk::storeModelFitGeneratorResults().

◆ GetCriterionNames()

virtual ParameterNamesType mitk::ParameterFitImageGeneratorBase::GetCriterionNames ( ) const
pure virtual

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

Implemented in mitk::ROIBasedParameterFitImageGenerator, and mitk::PixelBasedParameterFitImageGenerator.

Referenced by mitk::previewModelFitGeneratorResults().

◆ GetDerivedParameterImages()

mitk::ParameterFitImageGeneratorBase::ParameterImageMapType mitk::ParameterFitImageGeneratorBase::GetDerivedParameterImages ( )

Returns the generated derived parameter images. Triggers Generate() if result is outdated.

Definition at line 66 of file mitkParameterFitImageGeneratorBase.cpp.

References Generate(), and HasOutdatedResult().

Referenced by mitk::storeModelFitGeneratorResults().

◆ GetDerivedParameterNames()

virtual ParameterNamesType mitk::ParameterFitImageGeneratorBase::GetDerivedParameterNames ( ) const
pure virtual

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

Implemented in mitk::ROIBasedParameterFitImageGenerator, and mitk::PixelBasedParameterFitImageGenerator.

Referenced by mitk::previewModelFitGeneratorResults().

◆ GetEvaluationParameterImages()

mitk::ParameterFitImageGeneratorBase::ParameterImageMapType mitk::ParameterFitImageGeneratorBase::GetEvaluationParameterImages ( )

Returns the generated evaluation parameter images. Triggers Generate() if result is outdated.

Definition at line 88 of file mitkParameterFitImageGeneratorBase.cpp.

References Generate(), and HasOutdatedResult().

Referenced by mitk::storeModelFitGeneratorResults().

◆ GetEvaluationParameterNames()

virtual ParameterNamesType mitk::ParameterFitImageGeneratorBase::GetEvaluationParameterNames ( ) const
pure virtual

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

Implemented in mitk::ROIBasedParameterFitImageGenerator, and mitk::PixelBasedParameterFitImageGenerator.

Referenced by mitk::previewModelFitGeneratorResults().

◆ GetParameterImages()

mitk::ParameterFitImageGeneratorBase::ParameterImageMapType mitk::ParameterFitImageGeneratorBase::GetParameterImages ( )

Returns the fitted/generated parameter images. Triggers Generate() if result is outdated.

Definition at line 55 of file mitkParameterFitImageGeneratorBase.cpp.

References Generate(), and HasOutdatedResult().

Referenced by mitk::storeModelFitGeneratorResults().

◆ GetParameterNames()

virtual ParameterNamesType mitk::ParameterFitImageGeneratorBase::GetParameterNames ( ) const
pure virtual

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

Implemented in mitk::ROIBasedParameterFitImageGenerator, and mitk::PixelBasedParameterFitImageGenerator.

Referenced by mitk::previewModelFitGeneratorResults().

◆ GetProgress()

virtual double mitk::ParameterFitImageGeneratorBase::GetProgress ( ) const
pure virtual

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

Implemented in mitk::ROIBasedParameterFitImageGenerator, and mitk::PixelBasedParameterFitImageGenerator.

Referenced by onFitEvent(), and ParameterFitBackgroundJob::OnFitEvent().

◆ HasOutdatedResult()

bool mitk::ParameterFitImageGeneratorBase::HasOutdatedResult ( ) const
protectedvirtual

◆ mitkClassMacroItkParent()

mitk::ParameterFitImageGeneratorBase::mitkClassMacroItkParent ( ParameterFitImageGeneratorBase  ,
::itk::Object   
)

Member Data Documentation

◆ m_GenerationTimeStamp

itk::TimeStamp mitk::ParameterFitImageGeneratorBase::m_GenerationTimeStamp
protected

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