#include <itkMaskedFFTNormalizedCorrelationImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
class itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >

Calculate masked normalized cross correlation using FFTs.

This filter calculates the masked normalized cross correlation (NCC) of two images under masks using FFTs instead of spatial correlation. It is much faster than spatial correlation for reasonably large structuring elements. This filter is not equivalent to simply masking the images first and then correlating them; the latter approach yields incorrect results because the zeros in the images still affect the metric in the correlation process. This filter implements the masked NCC correctly so that the masked-out regions are completely ignored. The fundamental difference is described in detail in the references below. If the masks are set to images of all ones, the result of this filter is the same as standard NCC.

Inputs: Two images are required as inputs, fixedImage and movingImage, and two are optional, fixedMask and movingMask. 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). In the fixedMask and movingMask, non-zero positive values indicate locations of useful information in the corresponding image, whereas zero and negative values indicate locations that should be masked out (ignored). Internally, the masks are converted to have values of only 0 and 1. For each optional mask that is not set, the filter internally creates an image of ones, which is equivalent to not masking the image. Thus, if both masks are not set, the result will be equivalent to unmasked NCC. For example, if only a mask for the fixed image is needed, the movingMask can either not be set or can be set to an image of ones.

Optional parameters: The RequiredNumberOfOverlappingPixels enables the user to specify the minimum number of voxels of the two masks that 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.

The RequiredFractionOfOverlappingPixels enables the user to specify a fraction of the maximum number of overlapping pixels that need to overlap; any location in the correlation map that results from fewer than the product of this fraction and the internally computed maximum number of overlapping pixels will be set to zero. The value ranges between 0.0 and 1.0. This is very useful when the user does does not know beforehand the maximum number of pixels of the masks that will overlap. For example, when the masks have strange shapes, it is difficult to predict how the correlation of the masks will interact and what the maximum overlap will be. It is also useful when the mask shapes or sizes change because it is relative to the internally computed maximum of the overlap. 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. Experiments have shown that a value between 0.1 and 0.6 works well for images with significant overlap and between 0.05 and 0.1 for images with little overlap (such as in stitching applications). If RequiredFractionOfOverlappingPixels is set to 0, the default, no zeroing will take place.

The user can either specify RequiredNumberOfOverlappingPixels or RequiredFractionOfOverlappingPixels (or both or none). Internally, the number of required pixels resulting from both of these methods is calculated and the one that gives the largest number of pixels is chosen. Since these both default to 0, if a user only sets one, the other is ignored.

Image size: fixedImage and movingImage need not be the same size, but fixedMask must be the same size as fixedImage, and movingMask must be the same size as movingImage. 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 masked 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::MaskedFFTNormalizedCorrelationImageFilter< ShortImageType, DoubleImageType >;
auto filter = FilterType::New();
filter->SetFixedImage( fixedImage );
filter->SetMovingImage( movingImage );
filter->SetFixedImageMask( fixedMask );
filter->SetMovingImageMask( movingMask );
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 144 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

Inheritance diagram for itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >:

Collaboration diagram for itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >:

Public Types
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
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::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::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
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 ()

Private Attributes
float	m_AccumulatedProgress {}

SizeValueType	m_MaximumNumberOfOverlappingPixels {}

RealPixelType	m_RequiredFractionOfOverlappingPixels {}

SizeValueType	m_RequiredNumberOfOverlappingPixels {}

const unsigned int	m_TotalForwardAndInverseFFTs { 12 }

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 , typename TMaskImage = TInputImage>

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

Definition at line 154 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ FFTImagePointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FFTImagePointer = typename FFTImageType::Pointer

Definition at line 190 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ FFTImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FFTImageType = Image<std::complex<RealPixelType>, ImageDimension>

Definition at line 189 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 170 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 169 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageType = TInputImage

Extract some information from the image types.

Definition at line 167 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ InputRegionType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 168 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ InputSizeType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 171 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ MaskImagePointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 187 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ MaskImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageType = TMaskImage

Definition at line 186 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 175 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageType = TOutputImage

Definition at line 174 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 176 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

Definition at line 153 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealImagePointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealImagePointer = typename RealImageType::Pointer

Definition at line 180 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealImageType = Image<RealPixelType, ImageDimension>

Definition at line 179 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealIndexType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealIndexType = typename RealImageType::IndexType

Definition at line 181 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealPixelType = OutputPixelType

Definition at line 178 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealPointType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealPointType = typename RealImageType::PointType

Definition at line 184 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealRegionType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealRegionType = typename RealImageType::RegionType

Definition at line 183 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ RealSizeType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealSizeType = typename RealImageType::SizeType

Definition at line 182 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::Self = MaskedFFTNormalizedCorrelationImageFilter

Standard class type aliases.

Definition at line 151 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ SizeValueType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SizeValueType = itk::SizeValueType

Definition at line 172 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 152 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

Constructor & Destructor Documentation

◆ MaskedFFTNormalizedCorrelationImageFilter()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskedFFTNormalizedCorrelationImageFilter ( )

inlineprotected

Definition at line 232 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ ~MaskedFFTNormalizedCorrelationImageFilter()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::~MaskedFFTNormalizedCorrelationImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CalculateForwardFFT()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType , typename LocalOutputImageType >

LocalOutputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::CalculateForwardFFT	(	LocalInputImageType *	inputImage,
		InputSizeType &	FFTImageSize
	)

protected

◆ CalculateInverseFFT()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType , typename LocalOutputImageType >

LocalOutputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::CalculateInverseFFT	(	LocalInputImageType *	inputImage,
		RealSizeType &	combinedImageSize
	)

protected

◆ CalculatePrecisionTolerance()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType >

double itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::CalculatePrecisionTolerance ( LocalInputImageType * inputImage )

protected

◆ ElementPositive()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType >

LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementPositive ( LocalInputImageType * inputImage )

protected

◆ ElementProduct()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType , typename LocalOutputImageType >

LocalOutputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementProduct	(	LocalInputImageType *	inputImage1,
		LocalInputImageType *	inputImage2
	)

protected

◆ ElementQuotient()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType >

LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementQuotient	(	LocalInputImageType *	inputImage1,
		LocalInputImageType *	inputImage2
	)

protected

◆ ElementRound()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType , typename LocalOutputImageType >

LocalOutputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementRound ( LocalInputImageType * inputImage )

protected

◆ ElementSubtraction()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType >

LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementSubtraction	(	LocalInputImageType *	inputImage1,
		LocalInputImageType *	inputImage2
	)

protected

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

Give the process object a chance to indicate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

◆ FactorizeNumber()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FactorizeNumber ( int n )

protected

◆ FindClosestValidDimension()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FindClosestValidDimension ( int n )

protected

◆ GenerateData()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData ( )

overrideprotectedvirtual

Standard pipeline method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

This filter needs a different input requested region than the output requested region. As such, it needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also: ProcessObject::GenerateInputRequestedRegion()

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

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Since the output of this filter is a different size than the input, it must provide an implementation of GenerateOutputInformation.

See also: ProcessObject::GenerateOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GetMaximumNumberOfOverlappingPixels()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual SizeValueType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMaximumNumberOfOverlappingPixels ( )

virtual

Get the maximum number of overlapping pixels.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetRequiredFractionOfOverlappingPixels()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual RealPixelType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetRequiredFractionOfOverlappingPixels ( )

virtual

Set and get the required fraction of overlapping pixels

◆ GetRequiredNumberOfOverlappingPixels()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual SizeValueType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetRequiredNumberOfOverlappingPixels ( )

virtual

Set and get the required number of overlapping pixels

◆ itkGetInputMacro() [1/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkGetInputMacro	(	FixedImage	,
		InputImageType
	)

Set and get the fixed image

◆ itkGetInputMacro() [2/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkGetInputMacro	(	FixedImageMask	,
		MaskImageType
	)

Set and get the fixed mask

◆ itkGetInputMacro() [3/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkGetInputMacro	(	MovingImage	,
		InputImageType
	)

Set and get the moving image

◆ itkGetInputMacro() [4/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkGetInputMacro	(	MovingImageMask	,
		MaskImageType
	)

Set and get the moving mask

◆ itkSetInputMacro() [1/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkSetInputMacro	(	FixedImage	,
		InputImageType
	)

Set and get the fixed image

◆ itkSetInputMacro() [2/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkSetInputMacro	(	FixedImageMask	,
		MaskImageType
	)

Set and get the fixed mask

◆ itkSetInputMacro() [3/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkSetInputMacro	(	MovingImage	,
		InputImageType
	)

Set and get the moving image

◆ itkSetInputMacro() [4/4]

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::itkSetInputMacro	(	MovingImageMask	,
		MaskImageType
	)

Set and get the moving mask

◆ New()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

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

static

Method for creation through the object factory.

◆ PreProcessImage()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

TInputImage::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::PreProcessImage	(	const InputImageType *	inputImage,
		const MaskImageType *	inputMask
	)

protected

◆ PreProcessMask()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

TMaskImage::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::PreProcessMask	(	const InputImageType *	inputImage,
		const MaskImageType *	inputMask
	)

protected

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::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 >.

◆ RotateImage()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

template<typename LocalInputImageType >

LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RotateImage ( LocalInputImageType * inputImage )

protected

◆ SetRequiredFractionOfOverlappingPixels()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SetRequiredFractionOfOverlappingPixels ( RealPixelType _arg )

virtual

Set and get the required fraction of overlapping pixels

◆ SetRequiredNumberOfOverlappingPixels()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SetRequiredNumberOfOverlappingPixels ( SizeValueType _arg )

virtual

Set and get the required number of overlapping pixels

◆ VerifyInputInformation()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::VerifyInputInformation ( ) const

overrideprotectedvirtual

Overlap the VerifyInputInformation method

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

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

constexpr unsigned int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::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 164 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ m_AccumulatedProgress

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

float itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_AccumulatedProgress {}

private

The total accumulated progress

Definition at line 352 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ m_MaximumNumberOfOverlappingPixels

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

SizeValueType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_MaximumNumberOfOverlappingPixels {}

private

This is computed internally

Definition at line 346 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ m_RequiredFractionOfOverlappingPixels

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

RealPixelType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_RequiredFractionOfOverlappingPixels {}

private

Similar to m_RequiredNumberOfOverlappingPixels except that the m_RequiredFractionOfOverlappingPixels is multiplied by the m_MaximumNumberOfOverlappingPixels to determine the requiredNumberOfOverlappingPixels. The default is 0.

Definition at line 343 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ m_RequiredNumberOfOverlappingPixels

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

SizeValueType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_RequiredNumberOfOverlappingPixels {}

private

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. The default is set to 0.

Definition at line 339 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

◆ m_TotalForwardAndInverseFFTs

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

const unsigned int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_TotalForwardAndInverseFFTs { 12 }

private

This is used for the progress reporter

Definition at line 349 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

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

itkMaskedFFTNormalizedCorrelationImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FFTImagePointer

◆ FFTImageType

◆ InputImageConstPointer

◆ InputImagePointer

◆ InputImageType

◆ InputRegionType

◆ InputSizeType

◆ MaskImagePointer

◆ MaskImageType

◆ OutputImagePointer

◆ OutputImageType

◆ OutputPixelType

◆ Pointer

◆ RealImagePointer

◆ RealImageType

◆ RealIndexType

◆ RealPixelType

◆ RealPointType

◆ RealRegionType

◆ RealSizeType

◆ Self

◆ SizeValueType

◆ Superclass

Constructor & Destructor Documentation

◆ MaskedFFTNormalizedCorrelationImageFilter()

◆ ~MaskedFFTNormalizedCorrelationImageFilter()

Member Function Documentation

◆ CalculateForwardFFT()

◆ CalculateInverseFFT()

◆ CalculatePrecisionTolerance()

◆ ElementPositive()

◆ ElementProduct()

◆ ElementQuotient()

◆ ElementRound()

◆ ElementSubtraction()

◆ EnlargeOutputRequestedRegion()

◆ FactorizeNumber()

◆ FindClosestValidDimension()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetMaximumNumberOfOverlappingPixels()

◆ GetNameOfClass()

◆ GetRequiredFractionOfOverlappingPixels()

◆ GetRequiredNumberOfOverlappingPixels()

◆ itkGetInputMacro() [1/4]

◆ itkGetInputMacro() [2/4]

◆ itkGetInputMacro() [3/4]

◆ itkGetInputMacro() [4/4]

◆ itkSetInputMacro() [1/4]

◆ itkSetInputMacro() [2/4]

◆ itkSetInputMacro() [3/4]

◆ itkSetInputMacro() [4/4]

◆ New()

◆ PreProcessImage()

◆ PreProcessMask()

◆ PrintSelf()

◆ RotateImage()

◆ SetRequiredFractionOfOverlappingPixels()

◆ SetRequiredNumberOfOverlappingPixels()

◆ VerifyInputInformation()

Member Data Documentation

◆ ImageDimension

◆ m_AccumulatedProgress

◆ m_MaximumNumberOfOverlappingPixels

◆ m_RequiredFractionOfOverlappingPixels

◆ m_RequiredNumberOfOverlappingPixels

◆ m_TotalForwardAndInverseFFTs