SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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

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
 
SelfInverseOff ()
 
SelfInverseOn ()
 
SelfSetInverse (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. More...
 
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
 
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. 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- 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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (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 52 of file sitkFFTShiftImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 96 of file sitkFFTShiftImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkFFTShiftImageFilter.h.

◆ Self

Definition at line 54 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

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 82 of file sitkFFTShiftImageFilter.h.

◆ InverseOff()

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

Definition at line 74 of file sitkFFTShiftImageFilter.h.

◆ InverseOn()

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

Set the value of Inverse to true or false respectfully.

Definition at line 73 of file sitkFFTShiftImageFilter.h.

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

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 100 of file sitkFFTShiftImageFilter.h.

Member Data Documentation

◆ m_Inverse

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

Definition at line 106 of file sitkFFTShiftImageFilter.h.

◆ m_MemberFactory

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

Definition at line 102 of file sitkFFTShiftImageFilter.h.


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