#include <itkBlackTopHatImageFilter.h>

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

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

Public Types
enum	{ BASIC = 0, HISTO = 1, ANCHOR = 2, VHGW = 3 }
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef TKernel	KernelType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef BlackTopHatImageFilter	Self
typedef KernelImageFilter < TInputImage, TOutputImage, TKernel >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	ForceAlgorithmOff ()
virtual void	ForceAlgorithmOn ()
virtual const bool &	GetForceAlgorithm ()
virtual const char *	GetNameOfClass () const
virtual void	SetForceAlgorithm (bool _arg)

virtual void	SetSafeBorder (bool _arg)
virtual const bool &	GetSafeBorder ()
virtual void	SafeBorderOn ()
virtual void	SafeBorderOff ()

virtual void	SetAlgorithm (int _arg)
virtual int	GetAlgorithm () const
Static Public Member Functions
static Pointer	New ()
Public Attributes
enum itk::BlackTopHatImageFilter:: { ... }	AlgorithmChoice
Static Public Attributes

static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Member Functions
	BlackTopHatImageFilter ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~BlackTopHatImageFilter ()
Private Member Functions
	BlackTopHatImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
int	m_Algorithm
bool	m_ForceAlgorithm
bool	m_SafeBorder

Detailed Description

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

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

Black top hat extract local minima that are smaller than the structuring element. It subtract the background in the input image. The output of the filter transforms the black peaks in white peaks.

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

Author:: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

Definition at line 42 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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 50 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 56 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 58 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 55 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 57 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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 53 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

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

Kernel typedef.

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 65 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

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

Definition at line 60 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

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

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

Definition at line 62 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 59 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 61 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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 54 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

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

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 49 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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 47 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

typedef KernelImageFilter< TInputImage, TOutputImage, TKernel > itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::Superclass

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Definition at line 48 of file itkBlackTopHatImageFilter.h.

Member Enumeration Documentation

template<class TInputImage , class TOutputImage , class TKernel >

anonymous enum

define values used to determine which algorithm to use

Enumerator:

BASIC
HISTO
ANCHOR
VHGW

Definition at line 89 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 106 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::BlackTopHatImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage , class TKernel >

virtual::itk::LightObject::Pointer itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::CreateAnother ( void ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::ForceAlgorithmOff ( ) [virtual]

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::ForceAlgorithmOn ( ) [virtual]

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 >

virtual int itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetAlgorithm ( ) const [virtual]

Set/Get the backend filter class.

template<class TInputImage , class TOutputImage , class TKernel >

virtual const bool& itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetForceAlgorithm ( ) [virtual]

template<class TInputImage , class TOutputImage , class TKernel >

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

Runtime information support.

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage , class TOutputImage , class TKernel >

virtual const bool& itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::GetSafeBorder ( ) [virtual]

A safe border is added to input image to avoid borders effects and remove it once the closing is done

template<class TInputImage , class TOutputImage , class TKernel >

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

Standard New method.

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage , class TOutputImage , class TKernel >

void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::operator= ( const Self & ) [private]

kernel or structuring element to use.

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

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::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SafeBorderOff ( ) [virtual]

A safe border is added to input image to avoid borders effects and remove it once the closing is done

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SafeBorderOn ( ) [virtual]

A safe border is added to input image to avoid borders effects and remove it once the closing is done

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetAlgorithm ( int _arg ) [virtual]

Set/Get the backend filter class.

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetForceAlgorithm ( bool _arg ) [virtual]

template<class TInputImage , class TOutputImage , class TKernel >

virtual void itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::SetSafeBorder ( bool _arg ) [virtual]

A safe border is added to input image to avoid borders effects and remove it once the closing is done

Member Data Documentation

enum { ... } itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::AlgorithmChoice

define values used to determine which algorithm to use

template<class TInputImage , class TOutputImage , class TKernel >

const unsigned int itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 69 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

int itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::m_Algorithm [private]

Definition at line 117 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

bool itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::m_ForceAlgorithm [private]

Definition at line 119 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

bool itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::m_SafeBorder [private]

Definition at line 115 of file itkBlackTopHatImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >

const unsigned int itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 71 of file itkBlackTopHatImageFilter.h.

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

itkBlackTopHatImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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