itk::FFTShiftImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkFFTShiftImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef OutputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef FFTShiftImageFilter	Self
typedef OutputImageType::SizeType	SizeType
typedef CyclicShiftImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::CyclicShiftImageFilter< TInputImage, TOutputImage >
typedef OutputImageType::OffsetType	OffsetType
typedef OutputImageType::OffsetValueType	OffsetValueType
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetInverse (bool _arg)
virtual const bool &	GetInverse ()
virtual void	InverseOn ()
virtual void	InverseOff ()
Public Member Functions inherited from itk::CyclicShiftImageFilter< TInputImage, TOutputImage >
virtual void	SetShift (OffsetType _arg)
virtual OffsetType	GetShift () const
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
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)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::CyclicShiftImageFilter< TInputImage, TOutputImage >
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 >

Protected Member Functions
	FFTShiftImageFilter ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~FFTShiftImageFilter ()
Protected Member Functions inherited from itk::CyclicShiftImageFilter< TInputImage, TOutputImage >
	CyclicShiftImageFilter ()
void	GenerateInputRequestedRegion ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	~CyclicShiftImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) 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 ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () 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 Member Functions
	FFTShiftImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_Inverse

Additional Inherited Members
Protected Attributes inherited from itk::CyclicShiftImageFilter< TInputImage, TOutputImage >
OffsetType	m_Shift

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::FFTShiftImageFilter< TInputImage, TOutputImage >

Shift the zero-frequency components of a Fourier transfrom to the center of the image.

The Fourier transform produces an image where the zero frequency components are in the corner of the image, making it difficult to understand. This filter shifts the component to the center of the image.

Note:

For images with an odd-sized dimension, applying this filter twice will not produce the same image as the original one without using SetInverse(true) on one (and only one) of the two filters.

http://hdl.handle.net/1926/321

Author:

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also:

ForwardFFTImageFilter, InverseFFTImageFilter

Definition at line 48 of file itkFFTShiftImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::FFTShiftImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 56 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::IndexType itk::FFTShiftImageFilter< TInputImage, TOutputImage >::IndexType

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

Definition at line 69 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::ConstPointer itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

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

Definition at line 62 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Definition at line 64 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::Pointer itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

Definition at line 61 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Definition at line 63 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 59 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::ConstPointer itk::FFTShiftImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

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

Definition at line 66 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType itk::FFTShiftImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

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

Definition at line 68 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::Pointer itk::FFTShiftImageFilter< TInputImage, TOutputImage >::OutputImagePointer

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

Definition at line 65 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType itk::FFTShiftImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 67 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::FFTShiftImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

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

Definition at line 60 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::FFTShiftImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 55 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef FFTShiftImageFilter itk::FFTShiftImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 53 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::SizeType itk::FFTShiftImageFilter< TInputImage, TOutputImage >::SizeType

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

Definition at line 70 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef CyclicShiftImageFilter< TInputImage, TOutputImage > itk::FFTShiftImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 54 of file itkFFTShiftImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

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

protected

template<class TInputImage , class TOutputImage >

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

inlineprotected

Definition at line 92 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::FFTShiftImageFilter< TInputImage, TOutputImage >::FFTShiftImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::FFTShiftImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) 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::CyclicShiftImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

protectedvirtual

Override GenerateData method to set some parameters in the superclass.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual const bool& itk::FFTShiftImageFilter< TInputImage, TOutputImage >::GetInverse ( )

virtual

Set/Get whether the filter must invert the transform or not. This option has no effect if none of the size of the input image is even, but is required to restore the original image if at least one of the dimensions has an odd size.

template<class TInputImage , class TOutputImage >

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

virtual

Runtime information support.

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

template<class TInputImage , class TOutputImage >

virtual void itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InverseOff ( )

virtual

Set/Get whether the filter must invert the transform or not. This option has no effect if none of the size of the input image is even, but is required to restore the original image if at least one of the dimensions has an odd size.

template<class TInputImage , class TOutputImage >

virtual void itk::FFTShiftImageFilter< TInputImage, TOutputImage >::InverseOn ( )

virtual

Set/Get whether the filter must invert the transform or not. This option has no effect if none of the size of the input image is even, but is required to restore the original image if at least one of the dimensions has an odd size.

template<class TInputImage , class TOutputImage >

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

static

Standard New method.

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

template<class TInputImage , class TOutputImage >

void itk::FFTShiftImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<class TInputImage , class TOutputImage >

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

protectedvirtual

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

template<class TInputImage , class TOutputImage >

virtual void itk::FFTShiftImageFilter< TInputImage, TOutputImage >::SetInverse ( bool  _arg )

virtual

Set/Get whether the filter must invert the transform or not. This option has no effect if none of the size of the input image is even, but is required to restore the original image if at least one of the dimensions has an odd size.

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

const unsigned int itk::FFTShiftImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

static

ImageDimension constants

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

Definition at line 73 of file itkFFTShiftImageFilter.h.

template<class TInputImage , class TOutputImage >

bool itk::FFTShiftImageFilter< TInputImage, TOutputImage >::m_Inverse

private

Definition at line 103 of file itkFFTShiftImageFilter.h.

---

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

• itkFFTShiftImageFilter.h