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://doi.org/10.54294/0iky0u
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 SummaryNested Classes
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::FFTPadImageFilter::FFTPadImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedFFTPadImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionstatic intvoiddelete()virtual itk::simple::FFTPadImageFilter::~FFTPadImageFilter() DestructorImage itk::simple::FFTPadImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected voidfinalize()BoundaryConditionType itk::simple::FFTPadImageFilter::GetBoundaryCondition() constprotected static longgetCPtr(FFTPadImageFilter obj) getName()std::string itk::simple::FFTPadImageFilter::GetName() const Name of this classintint itk::simple::FFTPadImageFilter::GetSizeGreatestPrimeFactor() const Set/Get the greatest prime factor allowed on the size of the padded image.voidsetBoundaryCondition(FFTPadImageFilter.BoundaryConditionType BoundaryCondition) Self& itk::simple::FFTPadImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition)voidsetSizeGreatestPrimeFactor(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 longtoString()std::string itk::simple::FFTPadImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFiltergetCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObjectabort, 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- 
FFTPadImageFilterprotected FFTPadImageFilter(long cPtr, boolean cMemoryOwn) 
- 
FFTPadImageFilterpublic FFTPadImageFilter()itk::simple::FFTPadImageFilter::FFTPadImageFilter() Default Constructor that takes no arguments and initializes default parameters
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalizeprotected void finalize()- Overrides:
- finalizein class- ImageFilter
 
- 
deletepublic void delete()virtual itk::simple::FFTPadImageFilter::~FFTPadImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setBoundaryConditionSelf& itk::simple::FFTPadImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
- 
getBoundaryConditionBoundaryConditionType itk::simple::FFTPadImageFilter::GetBoundaryCondition() const
- 
setSizeGreatestPrimeFactorpublic 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 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.
- 
getSizeGreatestPrimeFactorpublic 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 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.
- 
getNamestd::string itk::simple::FFTPadImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::FFTPadImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
- 
defaultSizeGreatestPrimeFactorpublic static int defaultSizeGreatestPrimeFactor()
 
-