itk::HMaximaImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Enhancement Filters, Mathematical Morphology Image Filters]

Suppress local maxima whose height above the baseline is less than h. More...

#include <itkHMaximaImageFilter.h>

Inheritance diagram for itk::HMaximaImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::HMaximaImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef HMaximaImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	SetHeight (InputImagePixelType _arg)
virtual InputImagePixelType	GetHeight ()
unsigned long	GetNumberOfIterationsUsed ()
virtual void	SetFullyConnected (bool _arg)
virtual const bool &	GetFullyConnected ()
virtual void	FullyConnectedOn ()
virtual void	FullyConnectedOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	HMaximaImageFilter ()
	~HMaximaImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateInputRequestedRegion ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::HMaximaImageFilter< TInputImage, TOutputImage >

Suppress local maxima whose height above the baseline is less than h.

HMaximaImageFilter suppresses local maxima that are less than h intensity units above the (local) background. This has the effect of smoothing over the "high" parts of the noise in the image without smoothing over large changes in intensity (region boundaries). See the HMinimaImageFilter to suppress the local minima whose depth is less than h intensity units below the (local) background.

If the output of HMaximaImageFilter is subtracted from the original image, the signicant "peaks" in the image can be identified. This is what the HConvexImageFilter provides.

This filter uses the GrayscaleGeodesicDilateImageFilter. It provides its own input as the "mask" input to the geodesic dilation. The "marker" image for the geodesic dilation is the input image minus the height parameter h.

Geodesic morphology and the H-Maxima algorithm is described in Chapter 6 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

See also:

GrayscaleGeodesicDilateImageFilter, HMinimaImageFilter, HConvexImageFilter

MorphologyImageFilter, GrayscaleDilateImageFilter, GrayscaleFunctionDilateImageFilter, BinaryDilateImageFilter

Definition at line 53 of file itkHMaximaImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::HMaximaImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 62 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::ConstPointer itk::HMaximaImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::PixelType itk::HMaximaImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 70 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::Pointer itk::HMaximaImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 67 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::RegionType itk::HMaximaImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 69 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::HMaximaImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 65 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::ConstPointer itk::HMaximaImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

Definition at line 72 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::PixelType itk::HMaximaImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 74 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::Pointer itk::HMaximaImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 71 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::RegionType itk::HMaximaImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 73 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::HMaximaImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 66 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::HMaximaImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef HMaximaImageFilter itk::HMaximaImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 58 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter<TInputImage, TOutputImage> itk::HMaximaImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkHMaximaImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::HMaximaImageFilter< TInputImage, TOutputImage >::HMaximaImageFilter (   )  [protected]

template<class TInputImage, class TOutputImage> itk::HMaximaImageFilter< TInputImage, TOutputImage >::~HMaximaImageFilter (   )  [inline, protected]

Definition at line 120 of file itkHMaximaImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> void itk::HMaximaImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion (  DataObject *   )  [protected, virtual]

HMaximaImageFilter will produce the entire output. Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage> virtual void itk::HMaximaImageFilter< TInputImage, TOutputImage >::FullyConnectedOff (   )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> virtual void itk::HMaximaImageFilter< TInputImage, TOutputImage >::FullyConnectedOn (   )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> void itk::HMaximaImageFilter< TInputImage, TOutputImage >::GenerateData (   )  [protected, virtual]

Single-threaded version of GenerateData. This filter delegates to GrayscaleGeodesicErodeImageFilter. Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage> void itk::HMaximaImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [protected, virtual]

HMaximaImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion(). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual const bool& itk::HMaximaImageFilter< TInputImage, TOutputImage >::GetFullyConnected (   )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> virtual InputImagePixelType itk::HMaximaImageFilter< TInputImage, TOutputImage >::GetHeight (   )  [virtual]

Set/Get the height that a local maximum must be above the local background (local contrast) in order to survive the processing. Local maxima below this value are replaced with an estimate of the local background.

template<class TInputImage, class TOutputImage> virtual const char* itk::HMaximaImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

Runtime information support. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> unsigned long itk::HMaximaImageFilter< TInputImage, TOutputImage >::GetNumberOfIterationsUsed (   )  [inline]

Deprecated: Get the number of iterations used to produce the current output. This method is scheduled for removal since the implementation now uses a noniterative solution. Definition at line 102 of file itkHMaximaImageFilter.h.

template<class TInputImage, class TOutputImage> itk::HMaximaImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

ImageDimension constants Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> itk::HMaximaImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension constants Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> Pointer itk::HMaximaImageFilter< TInputImage, TOutputImage >::New (   )  [static]

Standard New method. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage> void itk::HMaximaImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::HMaximaImageFilter< TInputImage, TOutputImage >::SetFullyConnected (  bool  _arg  )  [virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage, class TOutputImage> virtual void itk::HMaximaImageFilter< TInputImage, TOutputImage >::SetHeight (  InputImagePixelType  _arg  )  [virtual]

Set/Get the height that a local maximum must be above the local background (local contrast) in order to survive the processing. Local maxima below this value are replaced with an estimate of the local background.

---

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

• itkHMaximaImageFilter.h

---