Abstract base class for generators that produce parameter images from curve descriptors. More...

#include <mitkDescriptionParameterImageGeneratorBase.h>

Inheritance diagram for mitk::DescriptionParameterImageGeneratorBase:

Collaboration diagram for mitk::DescriptionParameterImageGeneratorBase:

Public Types
typedef ScalarType	ParameterImagePixelType
	Pixel type used in generated parameter images. More...

typedef CurveDescriptionParameterBase::CurveDescriptionParameterNameType	ParameterNameType
	String type for parameter names. More...

typedef std::map< ParameterNameType, Image::Pointer >	ParameterImageMapType
	Map from parameter names to their corresponding output images. More...

Public Member Functions
	mitkClassMacroItkParent (DescriptionParameterImageGeneratorBase, ::itk::Object)

virtual double	GetProgress () const =0
	Returns the current computation progress as a value between 0.0 and 1.0. More...

void	Generate ()
	Triggers the parameter image computation if results are outdated. More...

ParameterImageMapType	GetParameterImages ()
	Returns the computed parameter images. More...

Protected Member Functions
	DescriptionParameterImageGeneratorBase ()

	~DescriptionParameterImageGeneratorBase () override

virtual bool	HasOutdatedResult () const

virtual void	CheckValidInputs () const

virtual void	DoParameterCalculationAndGetResults (ParameterImageMapType &parameterImages)=0

Protected Attributes
itk::TimeStamp	m_GenerationTimeStamp

Detailed Description

Abstract base class for generators that produce parameter images from curve descriptors.

Subclasses implement the actual computation strategy (e.g. pixel-based or ROI-based) to generate one or more 3D parameter images from a 4D dynamic image, where each output image represents a specific curve descriptor value (e.g. AUC, maximum, time-to-peak).

The generator caches results and only recomputes when inputs have been modified.

See also: PixelBasedDescriptionParameterImageGenerator, CurveParameterFunctor

Definition at line 37 of file mitkDescriptionParameterImageGeneratorBase.h.

Member Typedef Documentation

◆ ParameterImageMapType

typedef std::map<ParameterNameType,Image::Pointer> mitk::DescriptionParameterImageGeneratorBase::ParameterImageMapType

Map from parameter names to their corresponding output images.

Definition at line 50 of file mitkDescriptionParameterImageGeneratorBase.h.

◆ ParameterImagePixelType

typedef ScalarType mitk::DescriptionParameterImageGeneratorBase::ParameterImagePixelType

Pixel type used in generated parameter images.

Definition at line 44 of file mitkDescriptionParameterImageGeneratorBase.h.

◆ ParameterNameType

typedef CurveDescriptionParameterBase::CurveDescriptionParameterNameType mitk::DescriptionParameterImageGeneratorBase::ParameterNameType

String type for parameter names.

Definition at line 47 of file mitkDescriptionParameterImageGeneratorBase.h.

Constructor & Destructor Documentation

◆ DescriptionParameterImageGeneratorBase()

mitk::DescriptionParameterImageGeneratorBase::DescriptionParameterImageGeneratorBase ( )

protected

◆ ~DescriptionParameterImageGeneratorBase()

mitk::DescriptionParameterImageGeneratorBase::~DescriptionParameterImageGeneratorBase ( )

overrideprotected

Member Function Documentation

◆ CheckValidInputs()

virtual void mitk::DescriptionParameterImageGeneratorBase::CheckValidInputs ( ) const

protectedvirtual

Reimplemented in mitk::PixelBasedDescriptionParameterImageGenerator.

◆ DoParameterCalculationAndGetResults()

virtual void mitk::DescriptionParameterImageGeneratorBase::DoParameterCalculationAndGetResults ( ParameterImageMapType & parameterImages )

protectedpure virtual

Implemented in mitk::PixelBasedDescriptionParameterImageGenerator.

◆ Generate()

void mitk::DescriptionParameterImageGeneratorBase::Generate ( )

Triggers the parameter image computation if results are outdated.

Validates inputs, performs computation via DoParameterCalculationAndGetResults(), and caches the results. Does nothing if the current results are still up-to-date.

◆ GetParameterImages()

ParameterImageMapType mitk::DescriptionParameterImageGeneratorBase::GetParameterImages ( )

Returns the computed parameter images.

Triggers re-generation if results are outdated.

Returns: Map of parameter names to their corresponding output images.

◆ GetProgress()

virtual double mitk::DescriptionParameterImageGeneratorBase::GetProgress ( ) const

pure virtual

Returns the current computation progress as a value between 0.0 and 1.0.

Returns: The computation progress fraction.

Implemented in mitk::PixelBasedDescriptionParameterImageGenerator.

◆ HasOutdatedResult()

virtual bool mitk::DescriptionParameterImageGeneratorBase::HasOutdatedResult ( ) const

protectedvirtual

Reimplemented in mitk::PixelBasedDescriptionParameterImageGenerator.

◆ mitkClassMacroItkParent()

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

Member Data Documentation

◆ m_GenerationTimeStamp

itk::TimeStamp mitk::DescriptionParameterImageGeneratorBase::m_GenerationTimeStamp