Package org.itk.simple
Class FFTPadImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.FFTPadImageFilter
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://www.insight-journal.org/browse/publication/717
Gaetan Lehmann
See:
FFTShiftImageFilter
itk::simple::FFTPad for the procedural interface
itk::FFTPadImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkFFTPadImageFilter.h
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::FFTPadImageFilter::FFTPadImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
FFTPadImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::FFTPadImageFilter::~FFTPadImageFilter() DestructorImage itk::simple::FFTPadImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
BoundaryConditionType itk::simple::FFTPadImageFilter::GetBoundaryCondition() constprotected static long
getCPtr
(FFTPadImageFilter obj) getName()
std::string itk::simple::FFTPadImageFilter::GetName() const Name of this classint
int itk::simple::FFTPadImageFilter::GetSizeGreatestPrimeFactor() const Set/Get the greatest prime factor allowed on the size of the padded image.void
setBoundaryCondition
(FFTPadImageFilter.BoundaryConditionType BoundaryCondition) Self& itk::simple::FFTPadImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition)void
setSizeGreatestPrimeFactor
(int SizeGreatestPrimeFactor) Self& itk::simple::FFTPadImageFilter::SetSizeGreatestPrimeFactor(int SizeGreatestPrimeFactor) Set/Get the greatest prime factor allowed on the size of the padded image.protected static long
toString()
std::string itk::simple::FFTPadImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
-
Constructor Details
-
FFTPadImageFilter
protected FFTPadImageFilter(long cPtr, boolean cMemoryOwn) -
FFTPadImageFilter
public FFTPadImageFilter()itk::simple::FFTPadImageFilter::FFTPadImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::FFTPadImageFilter::~FFTPadImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setBoundaryCondition
Self& itk::simple::FFTPadImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition) -
getBoundaryCondition
BoundaryConditionType itk::simple::FFTPadImageFilter::GetBoundaryCondition() const -
setSizeGreatestPrimeFactor
public void setSizeGreatestPrimeFactor(int SizeGreatestPrimeFactor) Self& itk::simple::FFTPadImageFilter::SetSizeGreatestPrimeFactor(int SizeGreatestPrimeFactor) 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. -
getSizeGreatestPrimeFactor
public int getSizeGreatestPrimeFactor()int itk::simple::FFTPadImageFilter::GetSizeGreatestPrimeFactor() const 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. -
getName
std::string itk::simple::FFTPadImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::FFTPadImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::FFTPadImageFilter::Execute(const Image &image1) Execute the filter on the input image
-