SimpleITK  1.2.4
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::FFTConvolutionImageFilter Class Reference

Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain. More...

#include <sitkFFTConvolutionImageFilter.h>

+ Inheritance diagram for itk::simple::FFTConvolutionImageFilter:
+ Collaboration diagram for itk::simple::FFTConvolutionImageFilter:

Public Types

enum  BoundaryConditionType {
  ZERO_PAD,
  ZERO_FLUX_NEUMANN_PAD,
  PERIODIC_PAD
}
 
enum  OutputRegionModeType {
  SAME,
  VALID
}
 
typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef FFTConvolutionImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image, const Image &kernelImage)
 
Image Execute (const Image &image, const Image &kernelImage, bool normalize, FFTConvolutionImageFilter::BoundaryConditionType boundaryCondition, FFTConvolutionImageFilter::OutputRegionModeType outputRegionMode)
 
 FFTConvolutionImageFilter ()
 
BoundaryConditionType GetBoundaryCondition () const
 
std::string GetName () const
 
bool GetNormalize () const
 
OutputRegionModeType GetOutputRegionMode () const
 
SelfNormalizeOff ()
 
SelfNormalizeOn ()
 
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
 
SelfSetNormalize (bool Normalize)
 
SelfSetOutputRegionMode (OutputRegionModeType OutputRegionMode)
 
std::string ToString () const
 
virtual ~FFTConvolutionImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 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 *image, const Image *kernelImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *kernelImage)
 

Private Attributes

BoundaryConditionType m_BoundaryCondition
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_Normalize
 
OutputRegionModeType m_OutputRegionMode
 

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

Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain.

This filter produces output equivalent to the output of the ConvolutionImageFilter . However, it takes advantage of the convolution theorem to accelerate the convolution computation when the kernel is large.

Warning
This filter ignores the spacing, origin, and orientation of the kernel image and treats them as identical to those in the input image.

This code was adapted from the Insight Journal contribution:

"FFT Based Convolution" by Gaetan Lehmann https://hdl.handle.net/10380/3154

See also
ConvolutionImageFilter
itk::simple::FFTConvolution for the procedural interface
itk::FFTConvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkFFTConvolutionImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::FFTConvolutionImageFilter::MemberFunctionType) (const Image *image, const Image *kernelImage)
private

Setup for member function dispatching

Definition at line 117 of file sitkFFTConvolutionImageFilter.h.

Define the pixels types supported by this filter

Definition at line 62 of file sitkFFTConvolutionImageFilter.h.

Definition at line 52 of file sitkFFTConvolutionImageFilter.h.

Member Enumeration Documentation

Enumerator
ZERO_PAD 
ZERO_FLUX_NEUMANN_PAD 
PERIODIC_PAD 

Definition at line 80 of file sitkFFTConvolutionImageFilter.h.

Enumerator
SAME 
VALID 

Definition at line 90 of file sitkFFTConvolutionImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::FFTConvolutionImageFilter::~FFTConvolutionImageFilter ( )
virtual

Destructor

itk::simple::FFTConvolutionImageFilter::FFTConvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::FFTConvolutionImageFilter::Execute ( const Image image,
const Image kernelImage 
)

Execute the filter on the input image

Image itk::simple::FFTConvolutionImageFilter::Execute ( const Image image,
const Image kernelImage,
bool  normalize,
FFTConvolutionImageFilter::BoundaryConditionType  boundaryCondition,
FFTConvolutionImageFilter::OutputRegionModeType  outputRegionMode 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::FFTConvolutionImageFilter::ExecuteInternal ( const Image image,
const Image kernelImage 
)
private
BoundaryConditionType itk::simple::FFTConvolutionImageFilter::GetBoundaryCondition ( ) const
inline

Definition at line 88 of file sitkFFTConvolutionImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkFFTConvolutionImageFilter.h.

bool itk::simple::FFTConvolutionImageFilter::GetNormalize ( ) const
inline

Definition at line 78 of file sitkFFTConvolutionImageFilter.h.

OutputRegionModeType itk::simple::FFTConvolutionImageFilter::GetOutputRegionMode ( ) const
inline

Definition at line 98 of file sitkFFTConvolutionImageFilter.h.

Self& itk::simple::FFTConvolutionImageFilter::NormalizeOff ( )
inline

Definition at line 74 of file sitkFFTConvolutionImageFilter.h.

Self& itk::simple::FFTConvolutionImageFilter::NormalizeOn ( )
inline

Set the value of Normalize to true or false respectfully.

Definition at line 73 of file sitkFFTConvolutionImageFilter.h.

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

Definition at line 84 of file sitkFFTConvolutionImageFilter.h.

Self& itk::simple::FFTConvolutionImageFilter::SetNormalize ( bool  Normalize)
inline

Normalize the output image by the sum of the kernel components

Definition at line 70 of file sitkFFTConvolutionImageFilter.h.

References itk::simple::Normalize().

Self& itk::simple::FFTConvolutionImageFilter::SetOutputRegionMode ( OutputRegionModeType  OutputRegionMode)
inline

Definition at line 94 of file sitkFFTConvolutionImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 121 of file sitkFFTConvolutionImageFilter.h.

Member Data Documentation

BoundaryConditionType itk::simple::FFTConvolutionImageFilter::m_BoundaryCondition
private

Definition at line 128 of file sitkFFTConvolutionImageFilter.h.

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

Definition at line 123 of file sitkFFTConvolutionImageFilter.h.

bool itk::simple::FFTConvolutionImageFilter::m_Normalize
private

Definition at line 127 of file sitkFFTConvolutionImageFilter.h.

OutputRegionModeType itk::simple::FFTConvolutionImageFilter::m_OutputRegionMode
private

Definition at line 129 of file sitkFFTConvolutionImageFilter.h.


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