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 dervied classes for more information. More...

#include <mitkMaskGenerator.h>

Inheritance diagram for mitk::MaskGenerator:

Collaboration diagram for mitk::MaskGenerator:

Public Types
typedef MaskGenerator	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual const char *	GetClassName () const
virtual mitk::Image::Pointer	GetMask ()
	GetMask must be overridden by derived classes. More...
virtual mitk::Image::Pointer	GetReferenceImage ()
	GetReferenceImage per default returns the inputImage (as set by SetInputImage). If no input image is set it will return a nullptr. More...
void	SetInputImage (mitk::Image::Pointer inputImg)
	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	SetTimeStep (unsigned int timeStep)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	MaskGenerator ()

Protected Attributes
unsigned int	m_TimeStep
mitk::Image::Pointer	m_InternalMask
mitk::Image::Pointer	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 dervied classes for more information.

Definition at line 18 of file mitkMaskGenerator.h.

Member Typedef Documentation

typedef itk::SmartPointer< const Self > mitk::MaskGenerator::ConstPointer

Definition at line 25 of file mitkMaskGenerator.h.

typedef itk::SmartPointer< Self > mitk::MaskGenerator::Pointer

Definition at line 24 of file mitkMaskGenerator.h.

typedef MaskGenerator mitk::MaskGenerator::Self

Standard Self typedef

Definition at line 22 of file mitkMaskGenerator.h.

typedef itk::Object mitk::MaskGenerator::Superclass

Definition at line 23 of file mitkMaskGenerator.h.

Constructor & Destructor Documentation

mitk::MaskGenerator::MaskGenerator ( )

protected

Definition at line 6 of file mitkMaskGenerator.cpp.

References m_inputImage.

Member Function Documentation

virtual const char* mitk::MaskGenerator::GetClassName ( ) const

virtual

Runtime information support.

Reimplemented in mitk::HotspotMaskGenerator, mitk::PlanarFigureMaskGenerator, mitk::IgnorePixelMaskGenerator, and mitk::ImageMaskGenerator.

mitk::Image::Pointer mitk::MaskGenerator::GetMask ( )

virtual

GetMask must be overridden by derived classes.

Returns

mitk::Image::Pointer of generated mask

Reimplemented in mitk::HotspotMaskGenerator, mitk::IgnorePixelMaskGenerator, mitk::PlanarFigureMaskGenerator, and mitk::ImageMaskGenerator.

Definition at line 12 of file mitkMaskGenerator.cpp.

References mitk::Image::New().

mitk::Image::Pointer 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.

Definition at line 47 of file mitkMaskGenerator.cpp.

References m_inputImage.

static Pointer mitk::MaskGenerator::New ( )

static

Method for creation through the object factory.

void mitk::MaskGenerator::SetInputImage

(

mitk::Image::Pointer

inputImg

)

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.

Definition at line 38 of file mitkMaskGenerator.cpp.

References m_inputImage.

void mitk::MaskGenerator::SetTimeStep ( unsigned int  timeStep )

virtual

Reimplemented in mitk::HotspotMaskGenerator, mitk::PlanarFigureMaskGenerator, mitk::IgnorePixelMaskGenerator, and mitk::ImageMaskGenerator.

Definition at line 30 of file mitkMaskGenerator.cpp.

References m_TimeStep.

Member Data Documentation

mitk::Image::Pointer mitk::MaskGenerator::m_inputImage

protected

Definition at line 58 of file mitkMaskGenerator.h.

Referenced by mitk::IgnorePixelMaskGenerator::GetMask(), mitk::HotspotMaskGenerator::GetMask(), GetReferenceImage(), MaskGenerator(), mitk::HotspotMaskGenerator::SetInputImage(), and SetInputImage().

mitk::Image::Pointer mitk::MaskGenerator::m_InternalMask

protected

Definition at line 57 of file mitkMaskGenerator.h.

Referenced by mitk::ImageMaskGenerator::GetMask(), mitk::IgnorePixelMaskGenerator::GetMask(), mitk::PlanarFigureMaskGenerator::GetMask(), mitk::HotspotMaskGenerator::GetMask(), mitk::HotspotMaskGenerator::HotspotMaskGenerator(), and mitk::IgnorePixelMaskGenerator::InternalCalculateMask().

unsigned int mitk::MaskGenerator::m_TimeStep

protected

Definition at line 56 of file mitkMaskGenerator.h.

Referenced by mitk::IgnorePixelMaskGenerator::GetMask(), mitk::HotspotMaskGenerator::GetMask(), mitk::HotspotMaskGenerator::HotspotMaskGenerator(), mitk::ImageMaskGenerator::SetTimeStep(), mitk::IgnorePixelMaskGenerator::SetTimeStep(), mitk::PlanarFigureMaskGenerator::SetTimeStep(), SetTimeStep(), and mitk::HotspotMaskGenerator::SetTimeStep().

---

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

• mitkMaskGenerator.h
• mitkMaskGenerator.cpp