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

Black top hat extract local minima that are larger than the structuring element. More...

#include <itkBlackTopHatImageFilter.h>

Inheritance diagram for itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >:

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

[legend]List of all members.

Public Types
typedef BlackTopHatImageFilter	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
typedef TKernel	KernelType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetKernel (KernelType _arg)
virtual const KernelType &	GetKernel ()
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BlackTopHatImageFilter ()
	~BlackTopHatImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateInputRequestedRegion ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()

---

Detailed Description

template<class TInputImage, class TOutputImage, class TKernel>
class itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >

Black top hat extract local minima that are larger than the structuring element.

Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

Author:

Gaëtan Lehmann. Biologie du Développement et de la Reproduction, INRA of Jouy-en-Josas, France.

Definition at line 36 of file itkBlackTopHatImageFilter.h.

---

Member Typedef Documentation

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

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

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

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

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

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

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

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

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

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

template<class TInputImage, class TOutputImage, class TKernel> typedef TInputImage itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType

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

template<class TInputImage, class TOutputImage, class TKernel> typedef TKernel itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::KernelType

Kernel typedef. Definition at line 60 of file itkBlackTopHatImageFilter.h. Referenced by itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::~BlackTopHatImageFilter().

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

Definition at line 55 of file itkBlackTopHatImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 57 of file itkBlackTopHatImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 54 of file itkBlackTopHatImageFilter.h.

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

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

template<class TInputImage, class TOutputImage, class TKernel> typedef TOutputImage itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType

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

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

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

template<class TInputImage, class TOutputImage, class TKernel> typedef BlackTopHatImageFilter itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 41 of file itkBlackTopHatImageFilter.h. Referenced by itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::~BlackTopHatImageFilter().

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 84 of file itkBlackTopHatImageFilter.h. References itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::KernelType, and itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::Self.

---

Member Function Documentation

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

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

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

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead. See also: ThreadedGenerateData() Reimplemented from itk::ImageSource< TOutputImage >.

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

BlackTopHatImageFilter 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, class TKernel> virtual const KernelType& itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetKernel (   )  [virtual]

Get the kernel (structuring element).

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

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

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

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

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

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

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

Standard New method. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage, class TKernel> void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::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, class TKernel> virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetKernel (  KernelType  _arg  )  [virtual]

Set kernel (structuring element).

---

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

• itkBlackTopHatImageFilter.h

---