Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
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 Types inherited from mitk::MaskGenerator
typedef MaskGenerator Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual const char * GetClassName () const
 
void SetInputImage (mitk::Image::Pointer inputImage)
 Set the input image. Required for this class. More...
 
void SetMask (MaskGenerator::Pointer mask)
 Set a mask (can be nullptr if no mask is desired) More...
 
void SetHotspotRadiusInMM (double radiusInMillimeter)
 Set the radius of the hotspot (in MM) More...
 
const double & GetHotspotRadiusinMM () const
 
void SetHotspotMustBeCompletelyInsideImage (bool hotspotCompletelyInsideImage)
 Define whether the hotspot must be completely inside the image. Default is true. More...
 
bool GetHotspotMustBeCompletelyInsideImage () const
 
void SetLabel (unsigned short label)
 If a maskGenerator is set, this detemines which mask value is used. More...
 
mitk::Image::Pointer GetMask () override
 Computes and returns the hotspot mask. The hotspot mask has the same size as the input image. The hopspot has value 1, the remaining pixels are set to 0. More...
 
vnl_vector< int > GetHotspotIndex ()
 Returns the image index where the hotspot is located. More...
 
vnl_vector< int > GetConvolutionImageMinIndex ()
 Returns the index where the convolution image is minimal (darkest spot in image) More...
 
void SetTimeStep (unsigned int timeStep) override
 SetTimeStep is used to set the time step for which the mask is to be generated. More...
 
- Public Member Functions inherited from mitk::MaskGenerator
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...
 
void SetInputImage (mitk::Image::ConstPointer inputImg)
 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...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::MaskGenerator
static Pointer New ()
 

Protected Member Functions

 HotspotMaskGenerator ()
 
 ~HotspotMaskGenerator () override
 
- Protected Member Functions inherited from mitk::MaskGenerator
 MaskGenerator ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::MaskGenerator
unsigned int m_TimeStep
 
mitk::Image::Pointer m_InternalMask
 
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.

Definition at line 37 of file mitkHotspotMaskGenerator.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

Standard Self typedef

Definition at line 41 of file mitkHotspotMaskGenerator.h.

◆ Superclass

Constructor & Destructor Documentation

◆ HotspotMaskGenerator()

mitk::HotspotMaskGenerator::HotspotMaskGenerator ( )
protected

◆ ~HotspotMaskGenerator()

mitk::HotspotMaskGenerator::~HotspotMaskGenerator ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

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

Runtime information support.

Reimplemented from mitk::MaskGenerator.

◆ GetConvolutionImageMinIndex()

vnl_vector<int> mitk::HotspotMaskGenerator::GetConvolutionImageMinIndex ( )

Returns the index where the convolution image is minimal (darkest spot in image)

◆ GetHotspotIndex()

vnl_vector<int> mitk::HotspotMaskGenerator::GetHotspotIndex ( )

Returns the image index where the hotspot is located.

◆ GetHotspotMustBeCompletelyInsideImage()

bool mitk::HotspotMaskGenerator::GetHotspotMustBeCompletelyInsideImage ( ) const

◆ GetHotspotRadiusinMM()

const double& mitk::HotspotMaskGenerator::GetHotspotRadiusinMM ( ) const

◆ GetMask()

mitk::Image::Pointer mitk::HotspotMaskGenerator::GetMask ( )
overridevirtual

Computes and returns the hotspot mask. The hotspot mask has the same size as the input image. The hopspot has value 1, the remaining pixels are set to 0.

Reimplemented from mitk::MaskGenerator.

◆ New()

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

Method for creation through the object factory.

◆ SetHotspotMustBeCompletelyInsideImage()

void mitk::HotspotMaskGenerator::SetHotspotMustBeCompletelyInsideImage ( bool  hotspotCompletelyInsideImage)

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

◆ SetHotspotRadiusInMM()

void mitk::HotspotMaskGenerator::SetHotspotRadiusInMM ( double  radiusInMillimeter)

Set the radius of the hotspot (in MM)

◆ SetInputImage()

void mitk::HotspotMaskGenerator::SetInputImage ( mitk::Image::Pointer  inputImage)

Set the input image. Required for this class.

◆ SetLabel()

void mitk::HotspotMaskGenerator::SetLabel ( unsigned short  label)

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

◆ SetMask()

void mitk::HotspotMaskGenerator::SetMask ( MaskGenerator::Pointer  mask)

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

◆ SetTimeStep()

void mitk::HotspotMaskGenerator::SetTimeStep ( unsigned int  timeStep)
overridevirtual

SetTimeStep is used to set the time step for which the mask is to be generated.

Parameters
timeStep

Reimplemented from mitk::MaskGenerator.


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