mitk::MaskGenerator Class Reference

Base Class for all Mask Generators. Mask generators are classes that provide functionality for the creation of binary (or unsigned short) masks that can be applied to an image. See derived classes for more information. 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
mitk::Image::ConstPointer	GetMask (unsigned int maskID)
	GetMask returns the requested (multi) label mask. More...
virtual mitk::Image::ConstPointer	GetReferenceImage ()
	GetReferenceImage per default returns the inputImage (as set by SetInputImage). If no input image is set it will return a nullptr. More...
virtual void	SetInputImage (const mitk::Image *_arg)
	SetInputImage is used to set the input image to the mask generator. Some subclasses require an input image, others don't. See the documentation of the specific Mask Generator for more information. More...
virtual void	SetTimePoint (TimePointType _arg)

Protected Member Functions
	MaskGenerator ()
virtual mitk::Image::ConstPointer	DoGetMask (unsigned int maskID)=0
	DoGetMask must be overridden by derived classes. More...

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

Detailed Description

Base Class for all Mask Generators. Mask generators are classes that provide functionality for the creation of binary (or unsigned short) masks that can be applied to an image. See derived classes for more information.

Definition at line 30 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

DoGetMask must be overridden by derived classes.

Parameters

maskID

Parameter indicating which mask should be returned.

Returns

mitk::Image::Pointer of generated mask requested

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

GetMask()

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

(

unsigned int

maskID

)

GetMask returns the requested (multi) label mask.

Parameters

maskID

Parameter indicating which mask should be returned.

Returns

mitk::Image::Pointer of generated mask requested

GetNumberOfMasks()

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

pure virtual

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

GetReferenceImage()

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

virtual

GetReferenceImage per default returns the inputImage (as set by SetInputImage). If no input image is set it will return a nullptr.

Reimplemented in mitk::PlanarFigureMaskGenerator.

mitkClassMacroItkParent()

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

SetInputImage()

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

virtual

SetInputImage is used to set the input image to the mask generator. Some subclasses require an input image, others don't. See the documentation of the specific Mask Generator for more information.

SetTimePoint()

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

virtual

Member Data Documentation

m_InputImage

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

protected

Definition at line 66 of file mitkMaskGenerator.h.

m_TimePoint

TimePointType mitk::MaskGenerator::m_TimePoint

protected

Definition at line 65 of file mitkMaskGenerator.h.

---

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

• mitkMaskGenerator.h