Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::HotspotMaskGenerator Class Reference

The HotspotMaskGenerator class is used when a hotspot has to be found in an image. A hotspot is the region of the image where the mean intensity is maximal (=brightest spot). It is usually used in PET scans. The identification of the hotspot is done as follows: First a cubic (or circular, if image is 2d) mask of predefined size is generated. This mask is then convolved with the input image (in fourier domain). The maximum value of the convolved image then corresponds to the hotspot. If a maskGenerator is set, only the pixels of the convolved image where the corresponding mask is == label are searched for the maximum value. More...

#include <mitkHotspotMaskGenerator.h>

Inheritance diagram for mitk::HotspotMaskGenerator:
Collaboration diagram for mitk::HotspotMaskGenerator:

Classes

class  ImageExtrema
 

Public Types

typedef HotspotMaskGenerator Self
 
typedef MaskGenerator Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual const char * GetClassName () const
 
unsigned int GetNumberOfMasks () const override
 
virtual void SetMask (MaskGenerator *_arg)
 Set a mask (can be nullptr if no mask is desired) More...
 
virtual double GetHotspotRadiusInMM () const
 Set the radius of the hotspot (in MM) More...
 
virtual void SetHotspotRadiusInMM (double _arg)
 
virtual bool GetHotspotMustBeCompletelyInsideImage () const
 Define whether the hotspot must be completely inside the image. Default is true. More...
 
virtual void SetHotspotMustBeCompletelyInsideImage (bool _arg)
 
virtual void SetLabel (unsigned short _arg)
 If a maskGenerator is set, this determines which mask value is used. More...
 
- 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 mitk::Image::ConstPointer GetReferenceImage ()
 GetReferenceImage per default returns the inputImage (as set by SetInputImage). If no input image is set it will return a nullptr. 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 ()
 

Protected Member Functions

 HotspotMaskGenerator ()
 
 ~HotspotMaskGenerator () override
 
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

The HotspotMaskGenerator class is used when a hotspot has to be found in an image. A hotspot is the region of the image where the mean intensity is maximal (=brightest spot). It is usually used in PET scans. The identification of the hotspot is done as follows: First a cubic (or circular, if image is 2d) mask of predefined size is generated. This mask is then convolved with the input image (in fourier domain). The maximum value of the convolved image then corresponds to the hotspot. If a maskGenerator is set, only the pixels of the convolved image where the corresponding mask is == label are searched for the maximum value.

Warning
Until T30375 is not clarified the class should be deemed deprecated/erroneous and should not be used

Definition at line 39 of file mitkHotspotMaskGenerator.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

Standard Self typedef

Definition at line 43 of file mitkHotspotMaskGenerator.h.

◆ Superclass

Constructor & Destructor Documentation

◆ HotspotMaskGenerator()

mitk::HotspotMaskGenerator::HotspotMaskGenerator ( )
protected

◆ ~HotspotMaskGenerator()

mitk::HotspotMaskGenerator::~HotspotMaskGenerator ( )
overrideprotected

Member Function Documentation

◆ DoGetMask()

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

DoGetMask must be overridden by derived classes.

Parameters
maskIDParameter indicating which mask should be returned.
Returns
mitk::Image::Pointer of generated mask requested

Implements mitk::MaskGenerator.

◆ GetClassName()

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

Runtime information support.

◆ GetHotspotMustBeCompletelyInsideImage()

virtual bool mitk::HotspotMaskGenerator::GetHotspotMustBeCompletelyInsideImage ( ) const
virtual

Define whether the hotspot must be completely inside the image. Default is true.

◆ GetHotspotRadiusInMM()

virtual double mitk::HotspotMaskGenerator::GetHotspotRadiusInMM ( ) const
virtual

Set the radius of the hotspot (in MM)

◆ GetNumberOfMasks()

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

Implements mitk::MaskGenerator.

◆ New()

static Pointer mitk::HotspotMaskGenerator::New ( )
static

Method for creation through the object factory.

◆ SetHotspotMustBeCompletelyInsideImage()

virtual void mitk::HotspotMaskGenerator::SetHotspotMustBeCompletelyInsideImage ( bool  _arg)
virtual

◆ SetHotspotRadiusInMM()

virtual void mitk::HotspotMaskGenerator::SetHotspotRadiusInMM ( double  _arg)
virtual

◆ SetLabel()

virtual void mitk::HotspotMaskGenerator::SetLabel ( unsigned short  _arg)
virtual

If a maskGenerator is set, this determines which mask value is used.

◆ SetMask()

virtual void mitk::HotspotMaskGenerator::SetMask ( MaskGenerator _arg)
virtual

Set a mask (can be nullptr if no mask is desired)


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