Class FFTConvolutionImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.FFTConvolutionImageFilter
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://doi.org/10.54294/0iky0u
See:
ConvolutionImageFilter
InverseDeconvolutionImageFilter
IterativeDeconvolutionImageFilter
itk::simple::FFTConvolution for the procedural interface
itk::FFTConvolutionImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkFFTConvolutionImageFilter.h
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classstatic final class -
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn -
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::FFTConvolutionImageFilter::FFTConvolutionImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedFFTConvolutionImageFilter(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::FFTConvolutionImageFilter::~FFTConvolutionImageFilter() DestructorImage itk::simple::FFTConvolutionImageFilter::Execute(const Image &image, const Image &kernelImage) Execute the filter on the input imageprotected voidfinalize()BoundaryConditionType itk::simple::FFTConvolutionImageFilter::GetBoundaryCondition() constprotected static longgetName()std::string itk::simple::FFTConvolutionImageFilter::GetName() const Name of this classbooleanbool itk::simple::FFTConvolutionImageFilter::GetNormalize() constOutputRegionModeType itk::simple::FFTConvolutionImageFilter::GetOutputRegionMode() constvoidSelf& itk::simple::FFTConvolutionImageFilter::NormalizeOff()voidSelf& itk::simple::FFTConvolutionImageFilter::NormalizeOn() Set the value of Normalize to true or false respectfully.voidsetBoundaryCondition(FFTConvolutionImageFilter.BoundaryConditionType BoundaryCondition) Self& itk::simple::FFTConvolutionImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition)voidsetNormalize(boolean Normalize) Self& itk::simple::FFTConvolutionImageFilter::SetNormalize(bool Normalize) Normalize the output image by the sum of the kernel componentsvoidsetOutputRegionMode(FFTConvolutionImageFilter.OutputRegionModeType OutputRegionMode) Self& itk::simple::FFTConvolutionImageFilter::SetOutputRegionMode(OutputRegionModeType OutputRegionMode)protected static longtoString()std::string itk::simple::FFTConvolutionImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigReleaseMethods 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
-
FFTConvolutionImageFilter
protected FFTConvolutionImageFilter(long cPtr, boolean cMemoryOwn) -
FFTConvolutionImageFilter
public FFTConvolutionImageFilter()itk::simple::FFTConvolutionImageFilter::FFTConvolutionImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalizein classImageFilter
-
delete
public void delete()virtual itk::simple::FFTConvolutionImageFilter::~FFTConvolutionImageFilter() Destructor- Overrides:
deletein classImageFilter
-
setNormalize
public void setNormalize(boolean Normalize) Self& itk::simple::FFTConvolutionImageFilter::SetNormalize(bool Normalize) Normalize the output image by the sum of the kernel components -
normalizeOn
public void normalizeOn()Self& itk::simple::FFTConvolutionImageFilter::NormalizeOn() Set the value of Normalize to true or false respectfully. -
normalizeOff
public void normalizeOff()Self& itk::simple::FFTConvolutionImageFilter::NormalizeOff() -
getNormalize
public boolean getNormalize()bool itk::simple::FFTConvolutionImageFilter::GetNormalize() const -
setBoundaryCondition
Self& itk::simple::FFTConvolutionImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition) -
getBoundaryCondition
BoundaryConditionType itk::simple::FFTConvolutionImageFilter::GetBoundaryCondition() const -
setOutputRegionMode
Self& itk::simple::FFTConvolutionImageFilter::SetOutputRegionMode(OutputRegionModeType OutputRegionMode) -
getOutputRegionMode
OutputRegionModeType itk::simple::FFTConvolutionImageFilter::GetOutputRegionMode() const -
getName
std::string itk::simple::FFTConvolutionImageFilter::GetName() const Name of this class- Overrides:
getNamein classProcessObject
-
toString
std::string itk::simple::FFTConvolutionImageFilter::ToString() const Print ourselves out- Overrides:
toStringin classProcessObject
-
execute
-