mitk::HotspotMaskGenerator Class Reference

Generates a spherical mask centered on the hotspot (brightest region) of an image. 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< 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	SetMask (MaskGenerator *_arg)
	Set an optional mask generator to restrict the hotspot search area. More...
virtual double	GetHotspotRadiusInMM () const
	Set/Get the radius of the hotspot sphere in millimeters. More...
virtual void	SetHotspotRadiusInMM (double _arg)
virtual bool	GetHotspotMustBeCompletelyInsideImage () const
	Set/Get whether the hotspot sphere must be completely inside the image. More...
virtual void	SetHotspotMustBeCompletelyInsideImage (bool _arg)
virtual void	SetLabel (unsigned short _arg)
	Set the mask label value used to restrict the hotspot search. 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
	HotspotMaskGenerator ()
	~HotspotMaskGenerator () override
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 spherical mask centered on the hotspot (brightest region) of an image.

Warning

Until T30375 is clarified, this class should be considered deprecated/erroneous and should not be used.

A hotspot is the spherical region of the image where the mean intensity is maximal (the brightest spot). This is commonly used in PET scans.

The identification of the hotspot works as follows:

1. A cubic (or circular in 2D) convolution kernel of the specified radius is generated.
2. The kernel is convolved with the input image in the Fourier domain.
3. The maximum value of the convolved image corresponds to the hotspot center.
4. A binary spherical mask is generated around that center.

If an additional MaskGenerator is set, only pixels where the mask equals the specified label value are considered as candidate hotspot centers.

See also

MaskGenerator

ImageStatisticsCalculator

Definition at line 50 of file mitkHotspotMaskGenerator.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 57 of file mitkHotspotMaskGenerator.h.

Pointer

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

Definition at line 56 of file mitkHotspotMaskGenerator.h.

Self

typedef HotspotMaskGenerator mitk::HotspotMaskGenerator::Self

Standard Self typedef

Definition at line 54 of file mitkHotspotMaskGenerator.h.

Superclass

typedef MaskGenerator mitk::HotspotMaskGenerator::Superclass

Definition at line 55 of file mitkHotspotMaskGenerator.h.

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

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::HotspotMaskGenerator::GetClassName ( ) const

virtual

Runtime information support.

GetHotspotMustBeCompletelyInsideImage()

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

virtual

Set/Get whether the hotspot sphere must be completely inside the image.

When true, candidate hotspot centers are rejected if the sphere at that center extends beyond the image boundary. Default is true.

GetHotspotRadiusInMM()

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

virtual

Set/Get the radius of the hotspot sphere in millimeters.

GetNumberOfMasks()

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

overridevirtual

Returns the number of masks this generator provides.

Returns

Always returns 1.

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

Set the mask label value used to restrict the hotspot search.

Only pixels in the convolved image where the corresponding mask pixel equals this label value are considered as candidate hotspot centers.

Parameters

[in]

_arg

The label value to match.

SetMask()

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

virtual

Set an optional mask generator to restrict the hotspot search area.

Parameters

[in]

_arg

Pointer to a MaskGenerator, or nullptr to disable masking.

---

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

• mitkHotspotMaskGenerator.h