Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::PlanarFigureMaskGenerator Class Reference

Derived from MaskGenerator. This class is used to convert a mitk::PlanarFigure into a binary image mask. More...

#include <mitkPlanarFigureMaskGenerator.h>

Inheritance diagram for mitk::PlanarFigureMaskGenerator:
Inheritance graph
[legend]
Collaboration diagram for mitk::PlanarFigureMaskGenerator:
Collaboration graph
[legend]

Public Types

typedef PlanarFigureMaskGenerator Self
 
typedef MaskGenerator Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 

Public Member Functions

virtual const char * GetClassName () const
 
unsigned int GetNumberOfMasks () const override
 Get the number of masks this generator provides. More...
 
void SetPlanarFigure (mitk::PlanarFigure *planarFigure)
 Set the planar figure used to define the mask region. More...
 
mitk::Image::ConstPointer GetReferenceImage () override
 Get the reference image for this mask. More...
 
virtual unsigned int GetPlanarFigureAxis () const
 Get the image axis index perpendicular to the planar figure's plane. More...
 
virtual unsigned int GetPlanarFigureSlice () const
 Get the slice index at which the planar figure is located. More...
 
- Public Member Functions inherited from mitk::MaskGenerator
 mitkClassMacroItkParent (MaskGenerator, itk::Object)
 
mitk::Image::ConstPointer GetMask (unsigned int maskID)
 Get the generated mask image. 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...
 

Static Public Member Functions

static Pointer New ()
 
static bool CheckPlanarFigureIsNotTilted (const PlaneGeometry *planarGeometry, const BaseGeometry *geometry)
 Check whether a planar figure's plane is axis-aligned with a geometry. More...
 

Protected Member Functions

 PlanarFigureMaskGenerator ()
 
Image::ConstPointer DoGetMask (unsigned int) override
 Must be overridden by derived classes to generate the requested mask. More...
 
- 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

Derived from MaskGenerator. This class is used to convert a mitk::PlanarFigure into a binary image mask.

Definition at line 29 of file mitkPlanarFigureMaskGenerator.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 36 of file mitkPlanarFigureMaskGenerator.h.

◆ Pointer

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

Definition at line 35 of file mitkPlanarFigureMaskGenerator.h.

◆ Self

typedef PlanarFigureMaskGenerator mitk::PlanarFigureMaskGenerator::Self

Standard Self typedef

Definition at line 33 of file mitkPlanarFigureMaskGenerator.h.

◆ Superclass

typedef MaskGenerator mitk::PlanarFigureMaskGenerator::Superclass

Definition at line 34 of file mitkPlanarFigureMaskGenerator.h.

Constructor & Destructor Documentation

◆ PlanarFigureMaskGenerator()

mitk::PlanarFigureMaskGenerator::PlanarFigureMaskGenerator ( )
inlineprotected

Definition at line 92 of file mitkPlanarFigureMaskGenerator.h.

References mitk::Image::New().

Member Function Documentation

◆ CheckPlanarFigureIsNotTilted()

static bool mitk::PlanarFigureMaskGenerator::CheckPlanarFigureIsNotTilted ( const PlaneGeometry *  planarGeometry,
const BaseGeometry *  geometry 
)
static

Check whether a planar figure's plane is axis-aligned with a geometry.

Returns true if the planar figure's plane normal is parallel to one of the principal axes of the given geometry (i.e., the figure is not tilted).

Parameters
[in]planarGeometryThe plane geometry of the planar figure.
[in]geometryThe reference geometry to check against.
Returns
True if the planar figure is not tilted; false if tilted or if either argument is nullptr.
Precondition
If either planarGeometry or geometry is nullptr, returns false.

◆ DoGetMask()

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

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

Parameters
[in]maskIDParameter indicating which mask should be returned.
Returns
The generated mask image.

Implements mitk::MaskGenerator.

◆ GetClassName()

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

Runtime information support.

◆ GetNumberOfMasks()

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

Get the number of masks this generator provides.

Returns
Always returns 1.

Implements mitk::MaskGenerator.

◆ GetPlanarFigureAxis()

virtual unsigned int mitk::PlanarFigureMaskGenerator::GetPlanarFigureAxis ( ) const
virtual

Get the image axis index perpendicular to the planar figure's plane.

◆ GetPlanarFigureSlice()

virtual unsigned int mitk::PlanarFigureMaskGenerator::GetPlanarFigureSlice ( ) const
virtual

Get the slice index at which the planar figure is located.

◆ GetReferenceImage()

mitk::Image::ConstPointer mitk::PlanarFigureMaskGenerator::GetReferenceImage ( )
overridevirtual

Get the reference image for this mask.

Returns a 2D image slice extracted from the input image at the planar figure's plane position.

Returns
Const pointer to the 2D reference image slice.

Reimplemented from mitk::MaskGenerator.

◆ New()

static Pointer mitk::PlanarFigureMaskGenerator::New ( )
static

Method for creation through the object factory.

◆ SetPlanarFigure()

void mitk::PlanarFigureMaskGenerator::SetPlanarFigure ( mitk::PlanarFigure *  planarFigure)

Set the planar figure used to define the mask region.

The planar figure can be a closed shape (polygon, circle, ellipse, etc.) or an open shape (line, bezier curve). Closed shapes produce a filled 2D binary mask; open shapes produce a mask along the figure's polyline.

Parameters
[in]planarFigurePointer to the PlanarFigure.
The documentation for this class was generated from the following file: