Generates a mask from an existing mitk::Image for use in statistics calculations. More...

#include <mitkImageMaskGenerator.h>

Inheritance diagram for mitk::ImageMaskGenerator:

Collaboration diagram for mitk::ImageMaskGenerator:

Public Types
typedef ImageMaskGenerator	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
	Returns the number of masks this generator provides. More...

virtual void	SetImageMask (const Image *_arg)
	Set the image mask to use. 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 mitk::Image::ConstPointer	GetReferenceImage ()
	Get the reference image associated with this mask generator. 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 ()

Protected Member Functions
	ImageMaskGenerator ()

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

Generates a mask from an existing mitk::Image for use in statistics calculations.

This mask generator takes an external binary or label image (set via SetImageMask()) and provides it as a mask for the ImageStatisticsCalculator. The mask image is internally adapted (e.g., time step extraction) to match the input image geometry.

See also: MaskGenerator; ImageStatisticsCalculator

Definition at line 35 of file mitkImageMaskGenerator.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 42 of file mitkImageMaskGenerator.h.

◆ Pointer

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

Definition at line 41 of file mitkImageMaskGenerator.h.

◆ Self

typedef ImageMaskGenerator mitk::ImageMaskGenerator::Self

Standard Self typedef

Definition at line 39 of file mitkImageMaskGenerator.h.

◆ Superclass

typedef MaskGenerator mitk::ImageMaskGenerator::Superclass

Definition at line 40 of file mitkImageMaskGenerator.h.

Constructor & Destructor Documentation

◆ ImageMaskGenerator()

mitk::ImageMaskGenerator::ImageMaskGenerator ( )

inlineprotected

Definition at line 62 of file mitkImageMaskGenerator.h.

Member Function Documentation

◆ DoGetMask()

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

overrideprotectedvirtual

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

Parameters

[in] maskID Parameter indicating which mask should be returned.

Returns: The generated mask image.

Implements mitk::MaskGenerator.

◆ GetClassName()

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

virtual

Runtime information support.

◆ GetNumberOfMasks()

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

overridevirtual

Returns the number of masks this generator provides.

Returns: Always returns 1.

Implements mitk::MaskGenerator.

◆ New()

static Pointer mitk::ImageMaskGenerator::New ( )

static

Method for creation through the object factory.

◆ SetImageMask()

virtual void mitk::ImageMaskGenerator::SetImageMask ( const Image * _arg )

virtual

Set the image mask to use.

Parameters

[in] _arg Const pointer to the mask image. Non-zero pixels define the region of interest.

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

mitkImageMaskGenerator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members