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

Public Types

enum  BoundaryConditionType {
  ZERO_PAD,
  ZERO_FLUX_NEUMANN_PAD,
  PERIODIC_PAD
}
 
typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef FFTPadImageFilter 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, FFTPadImageFilter::BoundaryConditionType boundaryCondition, int sizeGreatestPrimeFactor)
 
 FFTPadImageFilter ()
 
BoundaryConditionType GetBoundaryCondition () const
 
std::string GetName () const
 
int GetSizeGreatestPrimeFactor () const
 
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
 
SelfSetSizeGreatestPrimeFactor (int SizeGreatestPrimeFactor)
 
std::string ToString () const
 
 ~FFTPadImageFilter ()
 
- 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

BoundaryConditionType m_BoundaryCondition
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
int m_SizeGreatestPrimeFactor
 

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::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) throw ()
 
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::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

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://hdl.handle.net/10380/3154

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.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 104 of file sitkFFTPadImageFilter.h.

Define the pixels types supported by this filter

Definition at line 62 of file sitkFFTPadImageFilter.h.

Definition at line 52 of file sitkFFTPadImageFilter.h.

Member Enumeration Documentation

Enumerator
ZERO_PAD 
ZERO_FLUX_NEUMANN_PAD 
PERIODIC_PAD 

Definition at line 66 of file sitkFFTPadImageFilter.h.

Constructor & Destructor Documentation

itk::simple::FFTPadImageFilter::FFTPadImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

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

Destructor

Member Function Documentation

Image itk::simple::FFTPadImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::FFTPadImageFilter::Execute ( const Image image1,
FFTPadImageFilter::BoundaryConditionType  boundaryCondition,
int  sizeGreatestPrimeFactor 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::FFTPadImageFilter::ExecuteInternal ( const Image image1)
private
BoundaryConditionType itk::simple::FFTPadImageFilter::GetBoundaryCondition ( ) const
inline

Definition at line 74 of file sitkFFTPadImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkFFTPadImageFilter.h.

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 13, 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 84 of file sitkFFTPadImageFilter.h.

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

Definition at line 70 of file sitkFFTPadImageFilter.h.

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 13, 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 79 of file sitkFFTPadImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 109 of file sitkFFTPadImageFilter.h.

Member Data Documentation

BoundaryConditionType itk::simple::FFTPadImageFilter::m_BoundaryCondition
private

Definition at line 114 of file sitkFFTPadImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::FFTPadImageFilter::m_MemberFactory
private

Definition at line 111 of file sitkFFTPadImageFilter.h.

int itk::simple::FFTPadImageFilter::m_SizeGreatestPrimeFactor
private

Definition at line 115 of file sitkFFTPadImageFilter.h.


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