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

Remove local maxima not connected to the boundary of the image. More...

#include <itkGrayscaleGrindPeakImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef GrayscaleGrindPeakImageFilter	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)
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
	GrayscaleGrindPeakImageFilter ()
	~GrayscaleGrindPeakImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateInputRequestedRegion ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()

---

Detailed Description

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

Remove local maxima not connected to the boundary of the image.

GrayscaleGrindPeakImageFilter removes peaks in a grayscale image. Peaks are local maxima in the grayscale topography that are not connected to boundaries of the image. Gray level values adjacent to a peak are extrapolated through the peak.

This filter is used to smooth over local maxima without affecting the values of local minima. If you take the difference between the output of this filter and the original image (and perhaps threshold the difference above a small value), you'll obtain a map of the local maxima.

This filter uses the GrayscaleGeodesicDilateImageFilter. It provides its own input as the "mask" input to the geodesic erosion. The "marker" image for the geodesic erosion is constructed such that boundary pixels match the boundary pixels of the input image and the interior pixels are set to the minimum pixel value in the input image.

This filter is the dual to the GrayscaleFillholeImageFilter which implements the Fillhole algorithm. Since it is a dual, it is somewhat superfluous but is provided as a convenience.

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

See also:

GrayscaleGeodesicDilateImageFilter

MorphologyImageFilter, GrayscaleDilateImageFilter, GrayscaleFunctionDilateImageFilter, BinaryDilateImageFilter

Definition at line 58 of file itkGrayscaleGrindPeakImageFilter.h.

---

Member Typedef Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

Definition at line 77 of file itkGrayscaleGrindPeakImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 79 of file itkGrayscaleGrindPeakImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 76 of file itkGrayscaleGrindPeakImageFilter.h.

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

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

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

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

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

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

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

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

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 117 of file itkGrayscaleGrindPeakImageFilter.h.

---

Member Function Documentation

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

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

template<class TInputImage, class TOutputImage> virtual void itk::GrayscaleGrindPeakImageFilter< 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::GrayscaleGrindPeakImageFilter< 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::GrayscaleGrindPeakImageFilter< TInputImage, TOutputImage >::GenerateData (   )  [protected, virtual]

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

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

GrayscaleGrindPeakImageFilter 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::GrayscaleGrindPeakImageFilter< 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 const char* itk::GrayscaleGrindPeakImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

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

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

Deprecated: Get the number of iterations used to produce the current output. This method id scheduled for removal since the implementation now uses a noniterative solution. Definition at line 99 of file itkGrayscaleGrindPeakImageFilter.h. References itk::GrayscaleGrindPeakImageFilter< TInputImage, TOutputImage >::GetNumberOfIterationsUsed(), and itkLegacyBody. Referenced by itk::GrayscaleGrindPeakImageFilter< TInputImage, TOutputImage >::GetNumberOfIterationsUsed().

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

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

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

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

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

Standard New method. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage> void itk::GrayscaleGrindPeakImageFilter< 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::GrayscaleGrindPeakImageFilter< 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.

---

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

• itkGrayscaleGrindPeakImageFilter.h

---