Medical Imaging Interaction Toolkit  2023.12.99-4f729362
Medical Imaging Interaction Toolkit
mitk::IgnorePixelMaskGenerator Class Reference

The IgnorePixelMaskGenerator class is used to generate a mask that is zero for specific pixel values in the input image. This class requires an input image. More...

#include <mitkIgnorePixelMaskGenerator.h>

Inheritance diagram for mitk::IgnorePixelMaskGenerator:
Collaboration diagram for mitk::IgnorePixelMaskGenerator:

Public Types

typedef IgnorePixelMaskGenerator Self
 
typedef MaskGenerator Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef double RealType
 

Public Member Functions

virtual const char * GetClassName () const
 
void SetIgnoredPixelValue (RealType pixelValue)
 The mask will be 0 there inputImage==pixelValue and 1 otherwise. More...
 
unsigned int GetNumberOfMasks () const override
 
- Public Member Functions inherited from mitk::MaskGenerator
 mitkClassMacroItkParent (MaskGenerator, itk::Object)
 
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)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 IgnorePixelMaskGenerator ()
 
 ~IgnorePixelMaskGenerator ()=default
 
mitk::Image::ConstPointer DoGetMask (unsigned int maskID) override
 DoGetMask must be overridden by derived classes. More...
 
template<typename TPixel , unsigned int VImageDimension>
void InternalCalculateMask (const itk::Image< TPixel, VImageDimension > *image)
 
- Protected Member Functions inherited from mitk::MaskGenerator
 MaskGenerator ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::MaskGenerator
TimePointType m_TimePoint
 
mitk::Image::ConstPointer m_InputImage
 

Detailed Description

The IgnorePixelMaskGenerator class is used to generate a mask that is zero for specific pixel values in the input image. This class requires an input image.

Definition at line 28 of file mitkIgnorePixelMaskGenerator.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ RealType

◆ Self

Standard Self typedef

Definition at line 32 of file mitkIgnorePixelMaskGenerator.h.

◆ Superclass

Constructor & Destructor Documentation

◆ IgnorePixelMaskGenerator()

mitk::IgnorePixelMaskGenerator::IgnorePixelMaskGenerator ( )
inlineprotected

Definition at line 50 of file mitkIgnorePixelMaskGenerator.h.

◆ ~IgnorePixelMaskGenerator()

mitk::IgnorePixelMaskGenerator::~IgnorePixelMaskGenerator ( )
protecteddefault

Member Function Documentation

◆ DoGetMask()

mitk::Image::ConstPointer mitk::IgnorePixelMaskGenerator::DoGetMask ( unsigned int  maskID)
overrideprotectedvirtual

DoGetMask must be overridden by derived classes.

Parameters
maskIDParameter indicating which mask should be returned.
Returns
mitk::Image::Pointer of generated mask requested

Implements mitk::MaskGenerator.

◆ GetClassName()

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

Runtime information support.

◆ GetNumberOfMasks()

unsigned int mitk::IgnorePixelMaskGenerator::GetNumberOfMasks ( ) const
overridevirtual

Implements mitk::MaskGenerator.

◆ InternalCalculateMask()

template<typename TPixel , unsigned int VImageDimension>
void mitk::IgnorePixelMaskGenerator::InternalCalculateMask ( const itk::Image< TPixel, VImageDimension > *  image)
protected

◆ New()

static Pointer mitk::IgnorePixelMaskGenerator::New ( )
static

Method for creation through the object factory.

◆ SetIgnoredPixelValue()

void mitk::IgnorePixelMaskGenerator::SetIgnoredPixelValue ( RealType  pixelValue)

The mask will be 0 there inputImage==pixelValue and 1 otherwise.


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