Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType > Class Template Reference
[Image Filters]

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

#include <itkNormalizedCorrelationImageFilter.h>

Inheritance diagram for itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >:

Inheritance graph
[legend]
Collaboration diagram for itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef NormalizedCorrelationImageFilter Self
typedef NeighborhoodOperatorImageFilter<
TInputImage, TOutputImage,
TOperatorValueType > 		Superclass
typedef SmartPointer< Self > Pointer
typedef SmartPointer< const
Self > 		ConstPointer
typedef TOutputImage::PixelType OutputPixelType
typedef TOutputImage::InternalPixelType OutputInternalPixelType
typedef TInputImage::PixelType InputPixelType
typedef TInputImage::InternalPixelType InputInternalPixelType
typedef TMaskImage::PixelType MaskPixelType
typedef TMaskImage::InternalPixelType MaskInternalPixelType
typedef TInputImage InputImageType
typedef TMaskImage MaskImageType
typedef TOutputImage OutputImageType
typedef InputImageType::Pointer InputImagePointer
typedef MaskImageType::Pointer MaskImagePointer
typedef ImageBoundaryCondition<
OutputImageType > * 		ImageBoundaryConditionPointerType
typedef Superclass::OutputImageRegionType OutputImageRegionType
typedef Superclass::OperatorValueType OperatorValueType
typedef Superclass::OutputNeighborhoodType OutputNeighborhoodType

Public Member Functions

virtual const char * GetNameOfClass () const
 itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
void SetMaskImage (const TMaskImage *mask)
const TMaskImage * GetMaskImage () const
void SetTemplate (const OutputNeighborhoodType &t)

Static Public Member Functions

Pointer New ()

Protected Member Functions

 NormalizedCorrelationImageFilter ()
virtual ~NormalizedCorrelationImageFilter ()
void GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
class itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >

Computes the normalized correlation of an image and a template.

This filter calculated 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 constrast.

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

Definition at line 44 of file itkNormalizedCorrelationImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef SmartPointer<const Self> itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ConstPointer
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 52 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef ImageBoundaryCondition<OutputImageType>* itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageBoundaryConditionPointerType
 

Typedef for generic boundary condition pointer.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 83 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef InputImageType::Pointer itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImagePointer
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 78 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TInputImage itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageType
 

Image typedef support.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 75 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TInputImage::InternalPixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputInternalPixelType
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 65 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TInputImage::PixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputPixelType
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 64 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef MaskImageType::Pointer itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImagePointer
 

Definition at line 79 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TMaskImage itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageType
 

Definition at line 76 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TMaskImage::InternalPixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskInternalPixelType
 

Definition at line 67 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TMaskImage::PixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskPixelType
 

Definition at line 66 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef Superclass::OperatorValueType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OperatorValueType
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 87 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef Superclass::OutputImageRegionType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageRegionType
 

Superclass typedefs.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 86 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TOutputImage itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageType
 

Some convenient typedefs.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 77 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TOutputImage::InternalPixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputInternalPixelType
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 63 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef Superclass::OutputNeighborhoodType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputNeighborhoodType
 

Neighborhood types

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 90 of file itkNormalizedCorrelationImageFilter.h.

Referenced by itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetTemplate().

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef TOutputImage::PixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputPixelType
 

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 62 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef SmartPointer<Self> itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Pointer
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 51 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef NormalizedCorrelationImageFilter itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Self
 

Standard "Self" & Superclass typedef.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 49 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
typedef NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType > itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Superclass
 

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 50 of file itkNormalizedCorrelationImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::NormalizedCorrelationImageFilter (   )  [inline, protected]
 

Definition at line 111 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
virtual itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::~NormalizedCorrelationImageFilter (   )  [inline, protected, virtual]
 

Definition at line 112 of file itkNormalizedCorrelationImageFilter.h.

Member Function Documentation

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GenerateInputRequestedRegion (   )  throw (InvalidRequestedRegionError) [protected, virtual]
 

NormalizedCorrelationImageFilter needs to request enough of an input image to account for template size. The input requested region is expanded by the radius of the template. If the request extends past the LargestPossibleRegion for the input, the request is cropped by the LargestPossibleRegion.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
const TMaskImage* itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetMaskImage (   )  const
 

Get the mask image. Using a mask is optional. When a mask is specified, the normalized correlation is only calculated for those pixels under the mask.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
virtual const char* itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetNameOfClass (   )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::itkStaticConstMacro (  ImageDimension  ,
unsigned  int,
TOutputImage::ImageDimension 
) 
 

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
Pointer itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::New (   )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::PrintSelf (  std::ostream &  os,
Indent  indent
)  const [inline, protected, virtual]
 

Standard PrintSelf method

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

Definition at line 136 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetMaskImage (  const TMaskImage *  mask  ) 
 

Set the mask image. Using a mask is optional. When a mask is specified, the normalized correlation is only calculated for those pixels under the mask.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetTemplate (  const OutputNeighborhoodType &  t  )  [inline]
 

Set the template used in the calculation of the normalized correlation. The elements of the template must be set prior to calling SetTemplate().

Definition at line 105 of file itkNormalizedCorrelationImageFilter.h.

References itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputNeighborhoodType.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread,
int  threadId
)  [protected, virtual]
 

NormalizedCorrelationImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

The documentation for this class was generated from the following file:
Generated at Thu May 25 01:57:31 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000