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:

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://doi.org/10.54294/xd0lzg

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 51 of file sitkFFTShiftImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList

using	Self = FFTShiftImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)

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

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.

virtual float	GetProgress () const
	An Active Measurement of the progress of execution.

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

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

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

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

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

Private Attributes
bool	m_Inverse {false}

std::unique_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 double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

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) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
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 TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType>
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 95 of file sitkFFTShiftImageFilter.h.

◆ PixelIDTypeList

using itk::simple::FFTShiftImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkFFTShiftImageFilter.h.

◆ Self

using itk::simple::FFTShiftImageFilter::Self = FFTShiftImageFilter

Definition at line 53 of file sitkFFTShiftImageFilter.h.

Constructor & Destructor Documentation

◆ ~FFTShiftImageFilter()

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

virtual

Destructor

◆ FFTShiftImageFilter()

itk::simple::FFTShiftImageFilter::FFTShiftImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetInverse()

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.

References m_Inverse.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 81 of file sitkFFTShiftImageFilter.h.

◆ InverseOff()

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

inline

Definition at line 73 of file sitkFFTShiftImageFilter.h.

References SetInverse().

◆ InverseOn()

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

inline

Set the value of Inverse to true or false respectfully.

Definition at line 72 of file sitkFFTShiftImageFilter.h.

References SetInverse().

◆ SetInverse()

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.

References m_Inverse.

Referenced by InverseOff(), and InverseOn().

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 96 of file sitkFFTShiftImageFilter.h.

References ExecuteInternal().

Member Data Documentation

◆ m_Inverse

bool itk::simple::FFTShiftImageFilter::m_Inverse {false}

private

Definition at line 105 of file sitkFFTShiftImageFilter.h.

Referenced by GetInverse(), and SetInverse().

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::FFTShiftImageFilter::m_MemberFactory

private

Definition at line 101 of file sitkFFTShiftImageFilter.h.

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

sitkFFTShiftImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~FFTShiftImageFilter()

◆ FFTShiftImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ GetInverse()

◆ GetName()

◆ InverseOff()

◆ InverseOn()

◆ SetInverse()

◆ ToString()

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_Inverse

◆ m_MemberFactory