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:

Collaboration diagram for mitk::PlanarFigureMaskGenerator:

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
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...
virtual unsigned int	GetPlanarFigureAxis () const
virtual unsigned int	GetPlanarFigureSlice () const
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 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 ()
static bool	CheckPlanarFigureIsNotTilted (const PlaneGeometry *planarGeometry, const BaseGeometry *geometry)

Protected Member Functions
	PlanarFigureMaskGenerator ()
Image::ConstPointer	DoGetMask (unsigned int) override
	DoGetMask must be overridden by derived classes. 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 56 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.

DoGetMask()

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

overrideprotectedvirtual

DoGetMask must be overridden by derived classes.

Parameters

maskID

Parameter indicating which mask should be returned.

Returns

mitk::Image::Pointer of generated mask requested

Implements mitk::MaskGenerator.

GetClassName()

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

virtual

Runtime information support.

GetNumberOfMasks()

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

overridevirtual

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

)

---

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

• mitkPlanarFigureMaskGenerator.h