ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType > Class Template Reference

#include <itkNormalizedCorrelationImageFilter.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const TMaskImage * GetMaskImage () const
virtual const char * GetNameOfClass () const
void SetMaskImage (const TMaskImage *mask)
void SetTemplate (const OutputNeighborhoodType &t)
 typedef (Concept::SameDimension< InputImageDimension, MaskImageDimension >) SameDimensionCheck
 typedef (Concept::HasNumericTraits< OutputPixelType >) OutputHasNumericTraitsCheck
 typedef (Concept::HasNumericTraits< OperatorValueType >) OperatorHasNumericTraitsCheck
 typedef (Concept::Signed< OutputPixelType >) SignedOutputPixelType

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int ImageDimension = TOutputImage::ImageDimension
static const unsigned int MaskImageDimension = TMaskImage::ImageDimension

Protected Member Functions

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

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 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
Wiki Examples:

Definition at line 51 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
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 96 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
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef TInputImage itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageType
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef TInputImage::InternalPixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputInternalPixelType
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef TInputImage::PixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputPixelType
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 93 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 90 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 76 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 75 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
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef Superclass::OutputImageRegionType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageRegionType
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef TOutputImage itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageType
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef TOutputImage::InternalPixelType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputInternalPixelType
template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
typedef Superclass::OutputNeighborhoodType itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputNeighborhoodType
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 67 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
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 56 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

Constructor & Destructor Documentation

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

End concept checking

Definition at line 138 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]

End concept checking

Definition at line 139 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::NormalizedCorrelationImageFilter ( const Self ) [private]

Standard PrintSelf method


Member Function Documentation

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
virtual::itk::LightObject::Pointer itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::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::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

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>
static 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 >::operator= ( const Self ) [private]
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]
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 118 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  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 >.

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::typedef ( Concept::SameDimension< InputImageDimension, MaskImageDimension )

Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< InputImageDimension, MaskImageDimension > )

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

This class requires OutputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< OutputPixelType > )

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::typedef ( Concept::HasNumericTraits< OperatorValueType )

This class requires OperatorHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< OperatorValueType > )

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

This class requires SignedOutputPixelType in the form of ( Concept::Signed< OutputPixelType > )


Member Data Documentation

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
const unsigned int itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageDimension = TOutputImage::ImageDimension [static]

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 83 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
const unsigned int itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageDimension = TInputImage::ImageDimension [static]

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 81 of file itkNormalizedCorrelationImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage , class TOperatorValueType = typename TOutputImage::PixelType>
const unsigned int itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageDimension = TMaskImage::ImageDimension [static]

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

Definition at line 85 of file itkNormalizedCorrelationImageFilter.h.


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