Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::MultiLabelMaskGenerator Class Reference

Generates masks for statistics computation from multi-label segmentations. More...

#include <mitkMultiLabelMaskGenerator.h>

Inheritance diagram for mitk::MultiLabelMaskGenerator:
Collaboration diagram for mitk::MultiLabelMaskGenerator:

Public Member Functions

 mitkClassMacro (MultiLabelMaskGenerator, MaskGenerator)
 
unsigned int GetNumberOfMasks () const override
 Get the number of masks (one per label in the segmentation). More...
 
virtual void SetMultiLabelSegmentation (const MultiLabelSegmentation *_arg)
 Set the multi-label segmentation from which to generate masks. 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

 MultiLabelMaskGenerator ()=default
 
 ~MultiLabelMaskGenerator ()=default
 
Image::ConstPointer DoGetMask (unsigned int maskID) 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 masks for statistics computation from multi-label segmentations.

This mask generator takes a MultiLabelSegmentation and produces one binary mask per label. Each mask isolates a single label from the segmentation, allowing per-label statistics to be computed via ImageStatisticsCalculator.

The number of masks returned by GetNumberOfMasks() equals the number of labels in the segmentation.

See also
MaskGenerator
ImageStatisticsCalculator
MultiLabelSegmentation

Definition at line 37 of file mitkMultiLabelMaskGenerator.h.

Constructor & Destructor Documentation

◆ MultiLabelMaskGenerator()

mitk::MultiLabelMaskGenerator::MultiLabelMaskGenerator ( )
protecteddefault

◆ ~MultiLabelMaskGenerator()

mitk::MultiLabelMaskGenerator::~MultiLabelMaskGenerator ( )
protecteddefault

Member Function Documentation

◆ DoGetMask()

Image::ConstPointer mitk::MultiLabelMaskGenerator::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.

◆ GetNumberOfMasks()

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

Get the number of masks (one per label in the segmentation).

Returns
Number of labels in the multi-label segmentation.

Implements mitk::MaskGenerator.

◆ mitkClassMacro()

mitk::MultiLabelMaskGenerator::mitkClassMacro ( MultiLabelMaskGenerator  ,
MaskGenerator   
)

Standard Self typedef

◆ New()

static Pointer mitk::MultiLabelMaskGenerator::New ( )
static

◆ SetMultiLabelSegmentation()

virtual void mitk::MultiLabelMaskGenerator::SetMultiLabelSegmentation ( const MultiLabelSegmentation *  _arg)
virtual

Set the multi-label segmentation from which to generate masks.

Parameters
[in]_argConst pointer to the MultiLabelSegmentation.

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