itk::simple::FFTPadImageFilter Class Reference

Pad an image to make it suitable for an FFT transformation. More...

#include <sitkFFTPadImageFilter.h>

Inheritance diagram for itk::simple::FFTPadImageFilter:

Collaboration diagram for itk::simple::FFTPadImageFilter:

Detailed Description

Pad an image to make it suitable for an FFT transformation.

FFT filters usually requires a specific image size. The size is decomposed in several prime factors, and the filter only supports prime factors up to a maximum value. This filter automatically finds the greatest prime factor required by the available implementation and pads the input appropriately.

This code was adapted from the Insight Journal contribution:

"FFT Based Convolution" by Gaetan Lehmann https://doi.org/10.54294/0iky0u

Author

Gaetan Lehmann

See also

FFTShiftImageFilter

itk::simple::FFTPad for the procedural interface

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

Definition at line 50 of file sitkFFTPadImageFilter.h.

Public Types
enum	BoundaryConditionType {   ZERO_PAD,   ZERO_FLUX_NEUMANN_PAD,   PERIODIC_PAD }
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = FFTPadImageFilter
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)
	FFTPadImageFilter ()
BoundaryConditionType	GetBoundaryCondition () const
std::string	GetName () const
int	GetSizeGreatestPrimeFactor () const
Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)
Self &	SetSizeGreatestPrimeFactor (int SizeGreatestPrimeFactor)
std::string	ToString () const
virtual	~FFTPadImageFilter ()
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

Static Public Member Functions
static int	DefaultSizeGreatestPrimeFactor ()
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...

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

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

Private Attributes
BoundaryConditionType	m_BoundaryCondition {itk::simple::FFTPadImageFilter::ZERO_FLUX_NEUMANN_PAD}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
int	m_SizeGreatestPrimeFactor {itk::simple::FFTPadImageFilter::DefaultSizeGreatestPrimeFactor()}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
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::FFTPadImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 104 of file sitkFFTPadImageFilter.h.

PixelIDTypeList

using itk::simple::FFTPadImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkFFTPadImageFilter.h.

Self

using itk::simple::FFTPadImageFilter::Self = FFTPadImageFilter

Definition at line 52 of file sitkFFTPadImageFilter.h.

Member Enumeration Documentation

BoundaryConditionType

enum itk::simple::FFTPadImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 65 of file sitkFFTPadImageFilter.h.

Constructor & Destructor Documentation

~FFTPadImageFilter()

virtual itk::simple::FFTPadImageFilter::~FFTPadImageFilter ( )

virtual

Destructor

FFTPadImageFilter()

itk::simple::FFTPadImageFilter::FFTPadImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

DefaultSizeGreatestPrimeFactor()

static int itk::simple::FFTPadImageFilter::DefaultSizeGreatestPrimeFactor ( )

static

The largest prime factor supported by underlying FFT implementation (FFTW or VNL).

Execute()

Image itk::simple::FFTPadImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetBoundaryCondition()

BoundaryConditionType itk::simple::FFTPadImageFilter::GetBoundaryCondition ( ) const

inline

Definition at line 73 of file sitkFFTPadImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkFFTPadImageFilter.h.

GetSizeGreatestPrimeFactor()

int itk::simple::FFTPadImageFilter::GetSizeGreatestPrimeFactor ( ) const

inline

Set/Get the greatest prime factor allowed on the size of the padded image. The filter increase the size of the image to reach a size with the greatest prime factor smaller or equal to the specified value. The default value is 5 for VNL, which is the greatest prime number for which the FFT are precomputed in FFTW, and thus gives very good performance. A greatest prime factor of 2 produce a size which is a power of 2, and thus is suitable for vnl base fft filters. A greatest prime factor of 1 or less - typically 0 - disable the extra padding.

Definition at line 83 of file sitkFFTPadImageFilter.h.

SetBoundaryCondition()

Self& itk::simple::FFTPadImageFilter::SetBoundaryCondition ( BoundaryConditionType  BoundaryCondition )

inline

Definition at line 69 of file sitkFFTPadImageFilter.h.

SetSizeGreatestPrimeFactor()

Self& itk::simple::FFTPadImageFilter::SetSizeGreatestPrimeFactor ( int  SizeGreatestPrimeFactor )

inline

Set/Get the greatest prime factor allowed on the size of the padded image. The filter increase the size of the image to reach a size with the greatest prime factor smaller or equal to the specified value. The default value is 5 for VNL, which is the greatest prime number for which the FFT are precomputed in FFTW, and thus gives very good performance. A greatest prime factor of 2 produce a size which is a power of 2, and thus is suitable for vnl base fft filters. A greatest prime factor of 1 or less - typically 0 - disable the extra padding.

Definition at line 78 of file sitkFFTPadImageFilter.h.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 108 of file sitkFFTPadImageFilter.h.

Member Data Documentation

m_BoundaryCondition

BoundaryConditionType itk::simple::FFTPadImageFilter::m_BoundaryCondition {itk::simple::FFTPadImageFilter::ZERO_FLUX_NEUMANN_PAD}

private

Definition at line 113 of file sitkFFTPadImageFilter.h.

m_MemberFactory

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

private

Definition at line 110 of file sitkFFTPadImageFilter.h.

m_SizeGreatestPrimeFactor

int itk::simple::FFTPadImageFilter::m_SizeGreatestPrimeFactor {itk::simple::FFTPadImageFilter::DefaultSizeGreatestPrimeFactor()}

private

Definition at line 115 of file sitkFFTPadImageFilter.h.

---

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

• sitkFFTPadImageFilter.h