ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
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 >:

Detailed Description

template<typename TInputImage, typename TMaskImage, typename TOutputImage, typename 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:
Examples:
WikiExamples/Images/NormalizedCorrelationImageFilter.cxx.

Definition at line 51 of file itkNormalizedCorrelationImageFilter.h.

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 Types inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
typedef NumericTraits
< OutputPixelType >::RealType 
ComputingPixelType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
ZeroFluxNeumannBoundaryCondition
< InputImageType
DefaultBoundaryCondition
 
typedef ImageBoundaryCondition
< InputImageType > * 
ImageBoundaryConditionPointerType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef TInputImage InputImageType
 
typedef
TInputImage::InternalPixelType 
InputInternalPixelType
 
typedef TInputImage::PixelType InputPixelType
 
typedef NumericTraits
< InputPixelType >::ValueType 
InputPixelValueType
 
typedef TOperatorValueType OperatorValueType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef
TOutputImage::InternalPixelType 
OutputInternalPixelType
 
typedef Neighborhood
< OperatorValueType,
itkGetStaticConstMacro(ImageDimension) > 
OutputNeighborhoodType
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef SmartPointer< SelfPointer
 
typedef
NeighborhoodOperatorImageFilter 
Self
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
const TMaskImage * GetMaskImage () const
 
virtual const char * GetNameOfClass () const
 
void SetMaskImage (const TMaskImage *mask)
 
void SetTemplate (const OutputNeighborhoodType &t)
 
- Public Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
ImageBoundaryConditionPointerType GetBoundaryCondition ()
 
const OutputNeighborhoodTypeGetOperator () const
 
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
 
void SetOperator (const OutputNeighborhoodType &p)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
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
 
- Static Public Attributes inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
static const unsigned int ImageDimension = TOutputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void GenerateInputRequestedRegion () override
 
 NormalizedCorrelationImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 
virtual ~NormalizedCorrelationImageFilter () override
 
- Protected Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
 NeighborhoodOperatorImageFilter ()
 
virtual ~NeighborhoodOperatorImageFilter () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter () override
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual ~ImageSource () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 61 of file itkNormalizedCorrelationImageFilter.h.

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

Typedef for generic boundary condition pointer.

Definition at line 96 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 92 of file itkNormalizedCorrelationImageFilter.h.

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

Image typedef support.

Definition at line 89 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 74 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 73 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 93 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 90 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 76 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 75 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 100 of file itkNormalizedCorrelationImageFilter.h.

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

Superclass typedefs.

Definition at line 99 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 91 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 72 of file itkNormalizedCorrelationImageFilter.h.

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

Neighborhood types

Definition at line 103 of file itkNormalizedCorrelationImageFilter.h.

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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.

Definition at line 67 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 60 of file itkNormalizedCorrelationImageFilter.h.

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

Standard "Self" & Superclass typedef.

Definition at line 56 of file itkNormalizedCorrelationImageFilter.h.

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

Definition at line 58 of file itkNormalizedCorrelationImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::NormalizedCorrelationImageFilter ( )
inlineprotected

Definition at line 138 of file itkNormalizedCorrelationImageFilter.h.

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::~NormalizedCorrelationImageFilter ( )
inlineoverrideprotectedvirtual

Definition at line 139 of file itkNormalizedCorrelationImageFilter.h.

Member Function Documentation

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual::itk::LightObject::Pointer itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::CreateAnother ( ) 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<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

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<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
static Pointer itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual
template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
overrideprotectedvirtual

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

Member Data Documentation

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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.

Definition at line 83 of file itkNormalizedCorrelationImageFilter.h.

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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.

Definition at line 81 of file itkNormalizedCorrelationImageFilter.h.

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename 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: