itk::simple::FFTShiftImageFilter Class Reference

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

#include <sitkFFTShiftImageFilter.h>

Inheritance diagram for itk::simple::FFTShiftImageFilter:

Collaboration diagram for itk::simple::FFTShiftImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList
typedef FFTShiftImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, bool inverse)
	FFTShiftImageFilter ()
bool	GetInverse () const
std::string	GetName () const
Self &	InverseOff ()
Self &	InverseOn ()
Self &	SetInverse (bool Inverse)
std::string	ToString () const
virtual	~FFTShiftImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
bool	m_Inverse
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TImageType >
static Image	CastITKToImage (TImageType *img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Shift the zero-frequency components of a Fourier transform 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.

https://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

itk::simple::FFTShift for the procedural interface

itk::FFTShiftImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkFFTShiftImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::FFTShiftImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 97 of file sitkFFTShiftImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::FFTShiftImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkFFTShiftImageFilter.h.

typedef FFTShiftImageFilter itk::simple::FFTShiftImageFilter::Self

Definition at line 52 of file sitkFFTShiftImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::FFTShiftImageFilter::~FFTShiftImageFilter ( )

virtual

Destructor

itk::simple::FFTShiftImageFilter::FFTShiftImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::FFTShiftImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::FFTShiftImageFilter::Execute	(	const Image &	image1,
		bool	inverse
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::FFTShiftImageFilter::ExecuteInternal ( const Image &  image1 )

private

bool itk::simple::FFTShiftImageFilter::GetInverse ( ) const

inline

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.

Definition at line 78 of file sitkFFTShiftImageFilter.h.

std::string itk::simple::FFTShiftImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 80 of file sitkFFTShiftImageFilter.h.

Self& itk::simple::FFTShiftImageFilter::InverseOff ( )

inline

Definition at line 73 of file sitkFFTShiftImageFilter.h.

Self& itk::simple::FFTShiftImageFilter::InverseOn ( )

inline

Set the value of Inverse to true or false respectfully.

Definition at line 72 of file sitkFFTShiftImageFilter.h.

Self& itk::simple::FFTShiftImageFilter::SetInverse ( bool  Inverse )

inline

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.

Definition at line 69 of file sitkFFTShiftImageFilter.h.

std::string itk::simple::FFTShiftImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 101 of file sitkFFTShiftImageFilter.h.

Member Data Documentation

bool itk::simple::FFTShiftImageFilter::m_Inverse

private

Definition at line 107 of file sitkFFTShiftImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::FFTShiftImageFilter::m_MemberFactory

private

Definition at line 103 of file sitkFFTShiftImageFilter.h.

---

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

• sitkFFTShiftImageFilter.h