Medical Imaging Interaction Toolkit  2021.10.99-9c07a326
Medical Imaging Interaction Toolkit
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual const char * GetClassName () const
 
virtual mitk::Image::Pointer GetMask ()
 GetMask must be overridden by derived classes. 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...
 
void SetInputImage (mitk::Image::ConstPointer 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::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 dervied classes for more information.

Definition at line 30 of file mitkMaskGenerator.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 37 of file mitkMaskGenerator.h.

◆ Pointer

◆ Self

Standard Self typedef

Definition at line 34 of file mitkMaskGenerator.h.

◆ Superclass

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

Definition at line 35 of file mitkMaskGenerator.h.

Constructor & Destructor Documentation

◆ MaskGenerator()

mitk::MaskGenerator::MaskGenerator ( )
protected

Member Function Documentation

◆ GetClassName()

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

◆ GetMask()

virtual 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.

◆ 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.

◆ New()

static Pointer mitk::MaskGenerator::New ( )
static

Method for creation through the object factory.

◆ SetInputImage()

void mitk::MaskGenerator::SetInputImage ( mitk::Image::ConstPointer  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.

◆ SetTimeStep()

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

Member Data Documentation

◆ m_inputImage

mitk::Image::ConstPointer mitk::MaskGenerator::m_inputImage
protected

Definition at line 68 of file mitkMaskGenerator.h.

◆ m_InternalMask

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

Definition at line 67 of file mitkMaskGenerator.h.

◆ m_TimeStep

unsigned int mitk::MaskGenerator::m_TimeStep
protected

Definition at line 66 of file mitkMaskGenerator.h.


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