ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage > Class Template Reference

#include <itkMaskedFFTNormalizedCorrelationImageFilter.h>

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

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:

* FilterType::Pointer 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

Definition at line 140 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef FFTImageType::Pointer FFTImagePointer
 
typedef Image< std::complex
< RealPixelType >
, ImageDimension
FFTImageType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::Pointer InputImagePointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::RegionType InputRegionType
 
typedef InputImageType::SizeType InputSizeType
 
typedef MaskImageType::Pointer MaskImagePointer
 
typedef TMaskImage MaskImageType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef SmartPointer< SelfPointer
 
typedef RealImageType::Pointer RealImagePointer
 
typedef Image< RealPixelType,
ImageDimension
RealImageType
 
typedef RealImageType::IndexType RealIndexType
 
typedef OutputPixelType RealPixelType
 
typedef RealImageType::PointType RealPointType
 
typedef RealImageType::RegionType RealRegionType
 
typedef RealImageType::SizeType RealSizeType
 
typedef
MaskedFFTNormalizedCorrelationImageFilter 
Self
 
typedef itk::SizeValueType SizeValueType
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual SizeValueType GetMaximumNumberOfOverlappingPixels ()
 
virtual const char * GetNameOfClass () const
 
void SetFixedImage (const InputImageType *input)
 
InputImageTypeGetFixedImage ()
 
void SetMovingImage (const InputImageType *input)
 
InputImageTypeGetMovingImage ()
 
void SetFixedImageMask (const MaskImageType *input)
 
MaskImageTypeGetFixedImageMask ()
 
void SetMovingImageMask (const MaskImageType *input)
 
MaskImageTypeGetMovingImageMask ()
 
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 InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

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

Private Attributes

float m_AccumulatedProgress
 
SizeValueType m_MaximumNumberOfOverlappingPixels
 
RealPixelType m_RequiredFractionOfOverlappingPixels
 
SizeValueType m_RequiredNumberOfOverlappingPixels
 
const unsigned int m_TotalForwardAndInverseFFTs
 

Additional Inherited Members

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

Member Typedef Documentation

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef SmartPointer<const Self> itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ConstPointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef FFTImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FFTImagePointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef Image< std::complex<RealPixelType>, ImageDimension > itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FFTImageType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef InputImageType::ConstPointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageConstPointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef InputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImagePointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef TInputImage itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageType

Extract some information from the image types.

Definition at line 162 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef InputImageType::RegionType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::InputRegionType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef InputImageType::SizeType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::InputSizeType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef MaskImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImagePointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef TMaskImage itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef OutputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImagePointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef TOutputImage itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef OutputImageType::PixelType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputPixelType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef SmartPointer<Self> itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::Pointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef RealImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealImagePointer
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef Image< RealPixelType, ImageDimension> itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealImageType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef RealImageType::IndexType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealIndexType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef OutputPixelType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealPixelType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef RealImageType::PointType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealPointType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef RealImageType::RegionType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealRegionType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef RealImageType::SizeType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RealSizeType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef MaskedFFTNormalizedCorrelationImageFilter itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::Self

Standard class typedefs.

Definition at line 145 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef itk::SizeValueType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SizeValueType
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::Superclass

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskedFFTNormalizedCorrelationImageFilter ( )
inlineprotected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
virtual itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::~MaskedFFTNormalizedCorrelationImageFilter ( )
inlineprotectedvirtual

Member Function Documentation

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
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
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
template<typename LocalInputImageType >
double itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::CalculatePrecisionTolerance ( LocalInputImageType *  inputImage)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
virtual::itk::LightObject::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
template<typename LocalInputImageType >
LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementPositive ( LocalInputImageType *  inputImage)
protected
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
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
template<typename LocalInputImageType >
LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementQuotient ( LocalInputImageType *  inputImage1,
LocalInputImageType *  inputImage2 
)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
template<typename LocalInputImageType , typename LocalOutputImageType >
LocalOutputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementRound ( LocalInputImageType *  inputImage)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
template<typename LocalInputImageType >
LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ElementSubtraction ( LocalInputImageType *  inputImage1,
LocalInputImageType *  inputImage2 
)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::EnlargeOutputRequestedRegion ( DataObject )
overrideprotectedvirtual

Give the process object a chance to indictate 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.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FactorizeNumber ( int  n)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::FindClosestValidDimension ( int  n)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData ( )
overrideprotectedvirtual

Standard pipeline method.

Reimplemented from itk::ImageSource< TOutputImage >.

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

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.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
InputImageType* itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetFixedImage ( )
inline

Set and get the fixed image

Definition at line 192 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
MaskImageType* itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetFixedImageMask ( )
inline

Set and get the fixed mask

Definition at line 214 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

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

Get the maximum number of overlapping pixels.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
InputImageType* itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMovingImage ( )
inline

Set and get the moving image

Definition at line 203 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
MaskImageType* itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMovingImageMask ( )
inline

Set and get the moving mask

Definition at line 225 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
virtual const char* itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

Reimplemented in itk::FFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage >.

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

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

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

Method for creation through the object factory.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
TInputImage::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::PreProcessImage ( const InputImageType inputImage,
const MaskImageType inputMask 
)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
TMaskImage::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::PreProcessMask ( const InputImageType inputImage,
const MaskImageType inputMask 
)
protected
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 >.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
template<typename LocalInputImageType >
LocalInputImageType::Pointer itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::RotateImage ( LocalInputImageType *  inputImage)
protected
template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SetFixedImage ( const InputImageType input)
inline

Set and get the fixed image

Definition at line 188 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SetFixedImageMask ( const MaskImageType input)
inline

Set and get the fixed mask

Definition at line 210 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMovingImage ( const InputImageType input)
inline

Set and get the moving image

Definition at line 199 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMovingImageMask ( const MaskImageType input)
inline

Set and get the moving mask

Definition at line 221 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

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

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

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
void itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::VerifyInputInformation ( )
overrideprotectedvirtual

Overlap the VerifyInputInformation method

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

Member Data Documentation

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
const unsigned int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::ImageDimension = TOutputImage::ImageDimension
static

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

Definition at line 159 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
float itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_AccumulatedProgress
private

The total accumulated progress

Definition at line 345 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
SizeValueType itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_MaximumNumberOfOverlappingPixels
private

This is computed internally

Definition at line 339 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

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 336 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

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 326 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
const unsigned int itk::MaskedFFTNormalizedCorrelationImageFilter< TInputImage, TOutputImage, TMaskImage >::m_TotalForwardAndInverseFFTs
private

This is used for the progress reporter

Definition at line 342 of file itkMaskedFFTNormalizedCorrelationImageFilter.h.


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