Computes the normalized correlation of an image and a template. More...

#include <sitkNormalizedCorrelationImageFilter.h>

Inheritance diagram for itk::simple::NormalizedCorrelationImageFilter:

Collaboration diagram for itk::simple::NormalizedCorrelationImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef NormalizedCorrelationImageFilter	Self

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

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

Public Member Functions
Image	Execute (const Image &image, const Image &maskImage, const Image &templateImage)

std::string	GetName () const

	NormalizedCorrelationImageFilter ()

std::string	ToString () const

virtual	~NormalizedCorrelationImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 0 >
	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 image, const Image maskImage, const Image *templateImage)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image image, const Image maskImage, const Image *templateImage)

Private Attributes
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) SITK_NOEXCEPT

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< 0 >
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

Computes the normalized correlation of an image and a template.

This filter calculates the normalized correlation between an image and the template. Normalized correlation is frequently use in feature detection because it is invariant to local changes in contrast.

The filter can be given a mask. When presented with an input image and a mask, the normalized correlation is only calculated at those pixels under the mask.

See also: Image; Neighborhood; NeighborhoodOperator; NeighborhoodIterator; itk::simple::NormalizedCorrelation for the procedural interface; itk::NormalizedCorrelationImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkNormalizedCorrelationImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::NormalizedCorrelationImageFilter::MemberFunctionType) (const Image *image, const Image *maskImage, const Image *templateImage)

private

Setup for member function dispatching

Definition at line 82 of file sitkNormalizedCorrelationImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::NormalizedCorrelationImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkNormalizedCorrelationImageFilter.h.

typedef NormalizedCorrelationImageFilter itk::simple::NormalizedCorrelationImageFilter::Self

Definition at line 54 of file sitkNormalizedCorrelationImageFilter.h.