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

#include <sitkGrayscaleGrindPeakImageFilter.h>

Inheritance diagram for itk::simple::GrayscaleGrindPeakImageFilter:

Collaboration diagram for itk::simple::GrayscaleGrindPeakImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef GrayscaleGrindPeakImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, bool fullyConnected)

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

bool	GetFullyConnected () const

std::string	GetName () const

	GrayscaleGrindPeakImageFilter ()

Self &	SetFullyConnected (bool FullyConnected)

std::string	ToString () const

	~GrayscaleGrindPeakImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
bool	m_FullyConnected

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

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; itk::simple::GrayscaleGrindPeak for the procedural interface; itk::GrayscaleGrindPeakImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkGrayscaleGrindPeakImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::GrayscaleGrindPeakImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 103 of file sitkGrayscaleGrindPeakImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::GrayscaleGrindPeakImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkGrayscaleGrindPeakImageFilter.h.

typedef GrayscaleGrindPeakImageFilter itk::simple::GrayscaleGrindPeakImageFilter::Self

Definition at line 57 of file sitkGrayscaleGrindPeakImageFilter.h.

Constructor & Destructor Documentation

itk::simple::GrayscaleGrindPeakImageFilter::GrayscaleGrindPeakImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::GrayscaleGrindPeakImageFilter::~GrayscaleGrindPeakImageFilter ( )

Destructor

Member Function Documentation

Image itk::simple::GrayscaleGrindPeakImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::GrayscaleGrindPeakImageFilter::Execute	(	const Image &	image1,
		bool	fullyConnected
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::GrayscaleGrindPeakImageFilter::ExecuteInternal ( const Image & image1 )

private

Self& itk::simple::GrayscaleGrindPeakImageFilter::FullyConnectedOff ( )

inline

Definition at line 78 of file sitkGrayscaleGrindPeakImageFilter.h.

Self& itk::simple::GrayscaleGrindPeakImageFilter::FullyConnectedOn ( )

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 77 of file sitkGrayscaleGrindPeakImageFilter.h.

bool itk::simple::GrayscaleGrindPeakImageFilter::GetFullyConnected ( ) const

inline

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.

Definition at line 83 of file sitkGrayscaleGrindPeakImageFilter.h.

std::string itk::simple::GrayscaleGrindPeakImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 85 of file sitkGrayscaleGrindPeakImageFilter.h.

Self& itk::simple::GrayscaleGrindPeakImageFilter::SetFullyConnected ( bool FullyConnected )

inline

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.

Definition at line 74 of file sitkGrayscaleGrindPeakImageFilter.h.

std::string itk::simple::GrayscaleGrindPeakImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.