#include <itkNormalizedCorrelationImageFilter.h>

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

ITK Sphinx Examples:

<a href=
<a href=
<a href=
<a href=

Definition at line 56 of file itkNormalizedCorrelationImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ImageBoundaryConditionPointerType = ImageBoundaryCondition< OutputImageType > *

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputInternalPixelType = typename TInputImage::InternalPixelType

using	InputPixelType = typename TInputImage::PixelType

using	MaskImagePointer = typename MaskImageType::Pointer

using	MaskImageType = TMaskImage

using	MaskInternalPixelType = typename TMaskImage::InternalPixelType

using	MaskPixelType = typename TMaskImage::PixelType

using	OutputImageType = TOutputImage

using	OutputInternalPixelType = typename TOutputImage::InternalPixelType

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	Self = NormalizedCorrelationImageFilter

using	Superclass = NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >

Public Types inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, typename TOutputImage::PixelType >
using	ComputingPixelType = typename NumericTraits< OutputPixelType >::RealType

using	ConstPointer = SmartPointer< const Self >

using	DefaultBoundaryCondition = ZeroFluxNeumannBoundaryCondition< InputImageType >

using	ImageBoundaryConditionPointerType = ImageBoundaryCondition< InputImageType > *

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputInternalPixelType = typename TInputImage::InternalPixelType

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	OperatorValueType = typename TOutputImage::PixelType

using	OutputImageType = TOutputImage

using	OutputInternalPixelType = typename TOutputImage::InternalPixelType

using	OutputNeighborhoodType = Neighborhood< OperatorValueType, Self::ImageDimension >

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	Self = NeighborhoodOperatorImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const TMaskImage *	GetMaskImage () const

const char *	GetNameOfClass () const override

void	SetMaskImage (const TMaskImage *mask)

void	SetTemplate (const OutputNeighborhoodType &t)

Public Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, typename TOutputImage::PixelType >
void	GenerateInputRequestedRegion () override

ImageBoundaryConditionPointerType	GetBoundaryCondition ()

const char *	GetNameOfClass () const override

const OutputNeighborhoodType &	GetOperator () const

void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)

void	SetOperator (const OutputNeighborhoodType &p)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

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 >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, typename TOutputImage::PixelType >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	MaskImageDimension = TMaskImage::ImageDimension

Static Public Attributes inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, typename TOutputImage::PixelType >
static constexpr unsigned int	ImageDimension

static constexpr unsigned int	InputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	GenerateInputRequestedRegion () override

	NormalizedCorrelationImageFilter ()=default

	~NormalizedCorrelationImageFilter () override=default


void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, typename TOutputImage::PixelType >
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	NeighborhoodOperatorImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~NeighborhoodOperatorImageFilter () override=default

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)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (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

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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	PrintSelf (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 >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkNormalizedCorrelationImageFilter.h.

◆ ImageBoundaryConditionPointerType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageBoundaryConditionPointerType = ImageBoundaryCondition<OutputImageType> *

Typedef for generic boundary condition pointer.

Definition at line 98 of file itkNormalizedCorrelationImageFilter.h.

◆ InputImagePointer

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImagePointer = typename InputImageType::Pointer

Definition at line 94 of file itkNormalizedCorrelationImageFilter.h.

◆ InputImageType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageType = TInputImage

Image type alias support

Definition at line 91 of file itkNormalizedCorrelationImageFilter.h.

◆ InputInternalPixelType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputInternalPixelType = typename TInputImage::InternalPixelType

Definition at line 80 of file itkNormalizedCorrelationImageFilter.h.

◆ InputPixelType

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

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

Definition at line 79 of file itkNormalizedCorrelationImageFilter.h.

◆ MaskImagePointer

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImagePointer = typename MaskImageType::Pointer

Definition at line 95 of file itkNormalizedCorrelationImageFilter.h.

◆ MaskImageType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageType = TMaskImage

Definition at line 92 of file itkNormalizedCorrelationImageFilter.h.

◆ MaskInternalPixelType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskInternalPixelType = typename TMaskImage::InternalPixelType

Definition at line 82 of file itkNormalizedCorrelationImageFilter.h.

◆ MaskPixelType

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

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

Definition at line 81 of file itkNormalizedCorrelationImageFilter.h.

◆ OutputImageType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageType = TOutputImage

Definition at line 93 of file itkNormalizedCorrelationImageFilter.h.

◆ OutputInternalPixelType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputInternalPixelType = typename TOutputImage::InternalPixelType

Definition at line 78 of file itkNormalizedCorrelationImageFilter.h.

◆ OutputPixelType

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputPixelType = typename TOutputImage::PixelType

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

Definition at line 77 of file itkNormalizedCorrelationImageFilter.h.

◆ Pointer

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkNormalizedCorrelationImageFilter.h.

◆ Self

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Self = NormalizedCorrelationImageFilter

Standard "Self" & Superclass type alias.

Definition at line 63 of file itkNormalizedCorrelationImageFilter.h.

◆ Superclass

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

using itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Superclass = NeighborhoodOperatorImageFilter<TInputImage, TOutputImage, TOperatorValueType>

Definition at line 64 of file itkNormalizedCorrelationImageFilter.h.

Constructor & Destructor Documentation

◆ NormalizedCorrelationImageFilter()

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

itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::NormalizedCorrelationImageFilter ( )

protecteddefault

◆ ~NormalizedCorrelationImageFilter()

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

itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::~NormalizedCorrelationImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ DynamicThreadedGenerateData()

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

void itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

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

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

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

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::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetMaskImage()

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.

◆ GetNameOfClass()

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

const char * itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ New()

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.

◆ PrintSelf()

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

Standard PrintSelf method

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 166 of file itkNormalizedCorrelationImageFilter.h.

◆ SetMaskImage()

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.

◆ SetTemplate()

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

Member Data Documentation

◆ ImageDimension

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

constexpr unsigned int itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 87 of file itkNormalizedCorrelationImageFilter.h.

◆ InputImageDimension

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

constexpr unsigned int itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

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

Definition at line 86 of file itkNormalizedCorrelationImageFilter.h.

◆ MaskImageDimension

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

constexpr unsigned int itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageDimension = TMaskImage::ImageDimension

staticconstexpr

Definition at line 88 of file itkNormalizedCorrelationImageFilter.h.

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

itkNormalizedCorrelationImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ImageBoundaryConditionPointerType

◆ InputImagePointer

◆ InputImageType

◆ InputInternalPixelType

◆ InputPixelType

◆ MaskImagePointer

◆ MaskImageType

◆ MaskInternalPixelType

◆ MaskPixelType

◆ OutputImageType

◆ OutputInternalPixelType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ NormalizedCorrelationImageFilter()

◆ ~NormalizedCorrelationImageFilter()

Member Function Documentation

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GetMaskImage()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetMaskImage()

◆ SetTemplate()

Member Data Documentation

◆ ImageDimension

◆ InputImageDimension

◆ MaskImageDimension