#include <itkFFTNormalizedCorrelationImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >

Calculate normalized cross correlation using FFTs.

This filter calculates the normalized cross correlation (NCC) of two images using FFTs instead of spatial correlation. It is much faster than spatial correlation for reasonably large structuring elements. This filter is a subclass of the more general MaskedFFTNormalizedCorrelationImageFilter and operates by essentially setting the masks in that algorithm to images of ones. As described in detail in the references below, there is no computational overhead to utilizing the more general masked algorithm because the FFTs of the images of ones are still necessary for the computations.

Inputs: Two images are required as inputs, fixedImage and movingImage. In the context of correlation, inputs are often defined as: "image" and "template". In this filter, the fixedImage plays the role of the image, and the movingImage plays the role of the template. However, this filter is capable of correlating any two images and is not restricted to small movingImages (templates).

Optional parameters: The RequiredNumberOfOverlappingPixels enables the user to specify how many voxels of the two images must overlap; any location in the correlation map that results from fewer than this number of voxels will be set to zero. Larger values zero-out pixels on a larger border around the correlation image. Thus, larger values remove less stable computations but also limit the capture range. If RequiredNumberOfOverlappingPixels is set to 0, the default, no zeroing will take place.

Image size: fixedImage and movingImage need not be the same size. Furthermore, whereas some algorithms require that the "template" be smaller than the "image" because of errors in the regions where the two are not fully overlapping, this filter has no such restriction.

Image spacing: Since the computations are done in the pixel domain, all input images must have the same spacing.

Outputs; The output is an image of RealPixelType that is the NCC of the two images and its values range from -1.0 to 1.0. The size of this NCC image is, by definition, size(fixedImage) + size(movingImage) - 1.

Example filter usage:

using FilterType = itk::FFTNormalizedCorrelationImageFilter< ShortImageType, DoubleImageType >;
auto filter = FilterType::New();
filter->SetFixedImage( fixedImage );
filter->SetMovingImage( movingImage );
filter->SetRequiredNumberOfOverlappingPixels(20);
filter->Update();

Warning: The pixel type of the output image must be of real type (float or double). ConceptChecking is used to enforce the output pixel type. You will get a compilation error if the pixel type of the output image is not float or double.

References: 1) D. Padfield. "Masked object registration in the Fourier domain." Transactions on Image Processing. 2) D. Padfield. "Masked FFT registration". In Proc. Computer Vision and Pattern Recognition, 2010.

Author: : Dirk Padfield, GE Global Research, padfield@research.ge.com

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 103 of file itkFFTNormalizedCorrelationImageFilter.h.

Inheritance diagram for itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	OutputPixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	Self = FFTNormalizedCorrelationImageFilter

using	Superclass = MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >

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

using	FFTImagePointer = typename FFTImageType::Pointer

using	FFTImageType = Image< std::complex< RealPixelType >, ImageDimension >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	MaskImagePointer = typename MaskImageType::Pointer

using	MaskImageType = TMaskImage

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	OutputPixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RealImagePointer = typename RealImageType::Pointer

using	RealImageType = Image< RealPixelType, ImageDimension >

using	RealIndexType = typename RealImageType::IndexType

using	RealPixelType = OutputPixelType

using	RealPointType = typename RealImageType::PointType

using	RealRegionType = typename RealImageType::RegionType

using	RealSizeType = typename RealImageType::SizeType

using	Self = MaskedFFTNormalizedCorrelationImageFilter

using	SizeValueType = itk::SizeValueType

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

Public Member Functions inherited from itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >
virtual SizeValueType	GetMaximumNumberOfOverlappingPixels ()

const char *	GetNameOfClass () const override

	itkSetInputMacro (FixedImage, InputImageType)

	itkGetInputMacro (FixedImage, InputImageType)

	itkSetInputMacro (MovingImage, InputImageType)

	itkGetInputMacro (MovingImage, InputImageType)

	itkSetInputMacro (FixedImageMask, MaskImageType)

	itkGetInputMacro (FixedImageMask, MaskImageType)

	itkSetInputMacro (MovingImageMask, MaskImageType)

	itkGetInputMacro (MovingImageMask, MaskImageType)

virtual void	SetRequiredNumberOfOverlappingPixels (SizeValueType _arg)

virtual SizeValueType	GetRequiredNumberOfOverlappingPixels ()

virtual RealPixelType	GetRequiredFractionOfOverlappingPixels ()

virtual void	SetRequiredFractionOfOverlappingPixels (RealPixelType _arg)

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::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >
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 Public Attributes inherited from itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

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

void	GenerateData () override

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

	~FFTNormalizedCorrelationImageFilter () override=default

Protected Member Functions inherited from itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >
template<typename LocalInputImageType , typename LocalOutputImageType >
LocalOutputImageType::Pointer	CalculateForwardFFT (LocalInputImageType *inputImage, InputSizeType &FFTImageSize)

template<typename LocalInputImageType , typename LocalOutputImageType >
LocalOutputImageType::Pointer	CalculateInverseFFT (LocalInputImageType *inputImage, RealSizeType &combinedImageSize)

template<typename LocalInputImageType >
double	CalculatePrecisionTolerance (LocalInputImageType *inputImage)

template<typename LocalInputImageType >
LocalInputImageType::Pointer	ElementPositive (LocalInputImageType *inputImage)

template<typename LocalInputImageType , typename LocalOutputImageType >
LocalOutputImageType::Pointer	ElementProduct (LocalInputImageType inputImage1, LocalInputImageType inputImage2)

template<typename LocalInputImageType >
LocalInputImageType::Pointer	ElementQuotient (LocalInputImageType inputImage1, LocalInputImageType inputImage2)

template<typename LocalInputImageType , typename LocalOutputImageType >
LocalOutputImageType::Pointer	ElementRound (LocalInputImageType *inputImage)

template<typename LocalInputImageType >
LocalInputImageType::Pointer	ElementSubtraction (LocalInputImageType inputImage1, LocalInputImageType inputImage2)

void	EnlargeOutputRequestedRegion (DataObject *output) override

int	FactorizeNumber (int n)

int	FindClosestValidDimension (int n)

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

	MaskedFFTNormalizedCorrelationImageFilter ()

TInputImage::Pointer	PreProcessImage (const InputImageType inputImage, const MaskImageType inputMask)

TMaskImage::Pointer	PreProcessMask (const InputImageType inputImage, const MaskImageType inputMask)

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

template<typename LocalInputImageType >
LocalInputImageType::Pointer	RotateImage (LocalInputImageType *inputImage)

void	VerifyInputInformation () const override

	~MaskedFFTNormalizedCorrelationImageFilter () 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 void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

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

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 113 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 130 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 129 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Extract some information from the image types.

Definition at line 126 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ InputRegionType

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::InputRegionType = typename InputImageType::RegionType

Definition at line 128 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ InputSizeType

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::InputSizeType = typename InputImageType::SizeType

Definition at line 131 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 132 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 127 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 133 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 112 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::Self = FFTNormalizedCorrelationImageFilter

Standard class type aliases.

Definition at line 110 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::Superclass = MaskedFFTNormalizedCorrelationImageFilter<TInputImage, TOutputImage>

Definition at line 111 of file itkFFTNormalizedCorrelationImageFilter.h.

Constructor & Destructor Documentation

◆ FFTNormalizedCorrelationImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::FFTNormalizedCorrelationImageFilter ( )

inlineprotected

Definition at line 136 of file itkFFTNormalizedCorrelationImageFilter.h.

◆ ~FFTNormalizedCorrelationImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::~FFTNormalizedCorrelationImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Standard pipeline method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char * itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

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

Definition at line 123 of file itkFFTNormalizedCorrelationImageFilter.h.

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

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

◆ InputImageConstPointer

◆ InputImagePointer

◆ InputImageType

◆ InputRegionType

◆ InputSizeType

◆ OutputImagePointer

◆ OutputImageType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ FFTNormalizedCorrelationImageFilter()

◆ ~FFTNormalizedCorrelationImageFilter()

Member Function Documentation

◆ GenerateData()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension