Medical Imaging Interaction Toolkit  2023.12.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 Types inherited from mitk::MaskGenerator
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
 
mitk::Image::ConstPointer GetMask () override
 GetMask Computes and returns the mask. More...
 
void SetPlanarFigure (mitk::PlanarFigure *planarFigure)
 
mitk::Image::ConstPointer GetReferenceImage () override
 GetReferenceImage per default returns the inputImage (as set by SetInputImage). If no input image is set it will return a nullptr. More...
 
void SetTimeStep (unsigned int timeStep) override
 SetTimeStep is used to set the time step for which the mask is to be generated. More...
 
virtual unsigned int GetPlanarFigureAxis () const
 
virtual unsigned int GetPlanarFigureSlice () const
 
- Public Member Functions inherited from mitk::MaskGenerator
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...
 

Static Public Member Functions

static Pointer New ()
 
static bool CheckPlanarFigureIsNotTilted (const PlaneGeometry *planarGeometry, const BaseGeometry *geometry)
 

Protected Member Functions

 PlanarFigureMaskGenerator ()
 
- Protected Member Functions inherited from mitk::MaskGenerator
 MaskGenerator ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::MaskGenerator
unsigned int m_TimeStep
 
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 66 of file mitkPlanarFigureMaskGenerator.h.

References mitk::Image::New().

Member Function Documentation

◆ CheckPlanarFigureIsNotTilted()

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

Helper function that indicates if a passed planar geometry is tilted regarding a given geometry and its main axis.

Precondition
If either planarGeometry or geometry is nullptr it will return false.

◆ GetClassName()

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

Runtime information support.

Reimplemented from mitk::MaskGenerator.

◆ GetMask()

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

GetMask Computes and returns the mask.

Returns
mitk::Image::Pointer of the generated mask

Implements mitk::MaskGenerator.

◆ GetPlanarFigureAxis()

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

◆ GetPlanarFigureSlice()

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

◆ GetReferenceImage()

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

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

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)

◆ SetTimeStep()

void mitk::PlanarFigureMaskGenerator::SetTimeStep ( unsigned int  timeStep)
overridevirtual

SetTimeStep is used to set the time step for which the mask is to be generated.

Parameters
timeStep

Reimplemented from mitk::MaskGenerator.

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