mitk::MaskGenerator Class Reference

Abstract base class for all mask generators used in image statistics. More...

#include <mitkMaskGenerator.h>

Inheritance diagram for mitk::MaskGenerator:

Collaboration diagram for mitk::MaskGenerator:

Public Member Functions
	mitkClassMacroItkParent (MaskGenerator, itk::Object)
virtual unsigned int	GetNumberOfMasks () const =0
	Get the number of masks this generator can produce. More...
mitk::Image::ConstPointer	GetMask (unsigned int maskID)
	Get the generated mask image. More...
virtual mitk::Image::ConstPointer	GetReferenceImage ()
	Get the reference image associated with this mask generator. More...
virtual void	SetInputImage (const mitk::Image *_arg)
	Set the input image for the mask generator. More...
virtual void	SetTimePoint (TimePointType _arg)
	Set the time point for which to generate the mask. More...

Protected Member Functions
	MaskGenerator ()
virtual mitk::Image::ConstPointer	DoGetMask (unsigned int maskID)=0
	Must be overridden by derived classes to generate the requested mask. More...

Protected Attributes
TimePointType	m_TimePoint
mitk::Image::ConstPointer	m_InputImage

Detailed Description

Abstract base class for all mask generators used in image statistics.

Mask generators create binary (unsigned short) masks that define regions of interest for image statistics calculations. Derived classes implement the actual mask creation logic in DoGetMask().

A mask generator may optionally require an input image (set via SetInputImage()) and a time point (set via SetTimePoint()). The public GetMask() method delegates to the pure virtual DoGetMask() after any necessary validation.

See also

ImageStatisticsCalculator

ImageMaskGenerator

PlanarFigureMaskGenerator

IgnorePixelMaskGenerator

HotspotMaskGenerator

MultiLabelMaskGenerator

Definition at line 44 of file mitkMaskGenerator.h.

Constructor & Destructor Documentation

MaskGenerator()

mitk::MaskGenerator::MaskGenerator ( )

protected

Member Function Documentation

DoGetMask()

virtual mitk::Image::ConstPointer mitk::MaskGenerator::DoGetMask ( unsigned int  maskID )

protectedpure virtual

Must be overridden by derived classes to generate the requested mask.

Parameters

[in]

maskID

Parameter indicating which mask should be returned.

Returns

The generated mask image.

Implemented in mitk::PlanarFigureMaskGenerator, mitk::ImageMaskGenerator, mitk::HotspotMaskGenerator, mitk::MultiLabelMaskGenerator, and mitk::IgnorePixelMaskGenerator.

GetMask()

mitk::Image::ConstPointer mitk::MaskGenerator::GetMask

(

unsigned int

maskID

)

Get the generated mask image.

Parameters

[in]

maskID

Index of the mask to retrieve (for generators that produce multiple masks).

Returns

Const pointer to the generated mask image.

GetNumberOfMasks()

virtual unsigned int mitk::MaskGenerator::GetNumberOfMasks ( ) const

pure virtual

Get the number of masks this generator can produce.

Returns

The number of available masks.

Implemented in mitk::PlanarFigureMaskGenerator, mitk::MultiLabelMaskGenerator, mitk::ImageMaskGenerator, mitk::IgnorePixelMaskGenerator, and mitk::HotspotMaskGenerator.

GetReferenceImage()

virtual mitk::Image::ConstPointer mitk::MaskGenerator::GetReferenceImage ( )

virtual

Get the reference image associated with this mask generator.

By default, returns the input image (as set by SetInputImage()). If no input image is set, returns nullptr. Subclasses may override this to return a different reference image.

Returns

Const pointer to the reference image, or nullptr.

Reimplemented in mitk::PlanarFigureMaskGenerator.

mitkClassMacroItkParent()

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

SetInputImage()

virtual void mitk::MaskGenerator::SetInputImage ( const mitk::Image *  _arg )

virtual

Set the input image for the mask generator.

Some subclasses require an input image to generate the mask (e.g., IgnorePixelMaskGenerator). Others do not. See the documentation of the specific subclass.

Parameters

[in]

_arg

Const pointer to the input image.

SetTimePoint()

virtual void mitk::MaskGenerator::SetTimePoint ( TimePointType  _arg )

virtual

Set the time point for which to generate the mask.

Parameters

[in]

_arg

The time point value.

Member Data Documentation

m_InputImage

mitk::Image::ConstPointer mitk::MaskGenerator::m_InputImage

protected

Definition at line 102 of file mitkMaskGenerator.h.

m_TimePoint

TimePointType mitk::MaskGenerator::m_TimePoint

protected

Definition at line 101 of file mitkMaskGenerator.h.

---

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

• mitkMaskGenerator.h