ITK
6.0.0
Insight Toolkit
|
#include <itkFFTConvolutionImageFilter.h>
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.
This code was adapted from the Insight Journal contribution:
"FFT Based Convolution" by Gaetan Lehmann https://doi.org/10.54294/0iky0u
Definition at line 60 of file itkFFTConvolutionImageFilter.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageType = TInputImage |
using | InputIndexType = typename InputImageType::IndexType |
using | InputPixelType = typename InputImageType::PixelType |
using | InputRegionType = typename InputImageType::RegionType |
using | InputSizeType = typename InputImageType::SizeType |
using | InternalComplexImagePointerType = typename InternalComplexImageType::Pointer |
using | InternalComplexImageType = Image< InternalComplexType, TInputImage::ImageDimension > |
using | InternalComplexType = std::complex< TInternalPrecision > |
using | InternalImagePointerType = typename InternalImageType::Pointer |
using | InternalImageType = Image< TInternalPrecision, TInputImage::ImageDimension > |
using | InternalIndexType = typename InternalImageType::IndexType |
using | InternalRegionType = typename InternalImageType::RegionType |
using | InternalSizeType = typename InternalImageType::SizeType |
using | KernelImageType = TKernelImage |
using | KernelIndexType = typename KernelImageType::IndexType |
using | KernelPixelType = typename KernelImageType::PixelType |
using | KernelRegionType = typename KernelImageType::RegionType |
using | KernelSizeType = typename KernelImageType::SizeType |
using | OutputImageType = TOutputImage |
using | OutputIndexType = typename OutputImageType::IndexType |
using | OutputPixelType = typename OutputImageType::PixelType |
using | OutputRegionType = typename OutputImageType::RegionType |
using | OutputSizeType = typename OutputImageType::SizeType |
using | Pointer = SmartPointer< Self > |
using | Self = FFTConvolutionImageFilter |
using | SizeValueType = typename InputSizeType::SizeValueType |
using | Superclass = ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > |
Public Types inherited from itk::ConvolutionImageFilterBase< TInputImage, TInputImage, TInputImage > | |
using | BoundaryConditionType = ImageBoundaryCondition< TInputImage > |
using | ConstPointer = SmartPointer< const Self > |
using | DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage > |
using | InputImageType = TInputImage |
using | InputIndexType = typename InputImageType::IndexType |
using | InputPixelType = typename InputImageType::PixelType |
using | InputRegionType = typename InputImageType::RegionType |
using | InputSizeType = typename InputImageType::SizeType |
using | KernelImageType = TInputImage |
using | KernelIndexType = typename KernelImageType::IndexType |
using | KernelPixelType = typename KernelImageType::PixelType |
using | KernelRegionType = typename KernelImageType::RegionType |
using | KernelSizeType = typename KernelImageType::SizeType |
using | OutputImageType = TInputImage |
using | OutputIndexType = typename OutputImageType::IndexType |
using | OutputPixelType = typename OutputImageType::PixelType |
using | OutputRegionModeEnum = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion |
using | OutputRegionType = typename OutputImageType::RegionType |
using | OutputSizeType = typename OutputImageType::SizeType |
using | Pointer = SmartPointer< Self > |
using | Self = ConvolutionImageFilterBase |
using | SizeValueType = typename InputSizeType::SizeValueType |
using | Superclass = ImageToImageFilter< TInputImage, TInputImage > |
Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TInputImage |
using | Pointer = SmartPointer< Self > |
using | Self = ImageToImageFilter |
using | Superclass = ImageSource< TInputImage > |
Public Types inherited from itk::ImageSource< TInputImage > | |
using | ConstPointer = SmartPointer< const Self > |
using | DataObjectIdentifierType = Superclass::DataObjectIdentifierType |
using | DataObjectPointer = DataObject::Pointer |
using | DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType |
using | OutputImagePixelType = typename OutputImageType::PixelType |
using | OutputImagePointer = typename OutputImageType::Pointer |
using | OutputImageRegionType = typename OutputImageType::RegionType |
using | OutputImageType = TInputImage |
using | Pointer = SmartPointer< Self > |
using | Self = ImageSource |
using | Superclass = ProcessObject |
Public Types inherited from itk::ProcessObject | |
using | ConstPointer = SmartPointer< const Self > |
using | DataObjectIdentifierType = DataObject::DataObjectIdentifierType |
using | DataObjectPointer = DataObject::Pointer |
using | DataObjectPointerArray = std::vector< DataObjectPointer > |
using | DataObjectPointerArraySizeType = DataObjectPointerArray::size_type |
using | MultiThreaderType = MultiThreaderBase |
using | NameArray = std::vector< DataObjectIdentifierType > |
using | Pointer = SmartPointer< Self > |
using | Self = ProcessObject |
using | Superclass = Object |
Public Types inherited from itk::Object | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = Object |
using | Superclass = LightObject |
Public Types inherited from itk::LightObject | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = LightObject |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
static double | GetGlobalDefaultCoordinateTolerance () |
static double | GetGlobalDefaultDirectionTolerance () |
static void | SetGlobalDefaultCoordinateTolerance (double) |
static void | SetGlobalDefaultDirectionTolerance (double) |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static constexpr unsigned int | ImageDimension = TInputImage::ImageDimension |
Static Public Attributes inherited from itk::ConvolutionImageFilterBase< TInputImage, TInputImage, TInputImage > | |
static constexpr unsigned int | ImageDimension |
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
static constexpr unsigned int | InputImageDimension |
static constexpr unsigned int | OutputImageDimension |
Static Public Attributes inherited from itk::ImageSource< TInputImage > | |
static constexpr unsigned int | OutputImageDimension |
Protected Types | |
using | FFTFilterType = RealToHalfHermitianForwardFFTImageFilter< InternalImageType, InternalComplexImageType > |
using | IFFTFilterType = HalfHermitianToRealInverseFFTImageFilter< InternalComplexImageType, InternalImageType > |
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
using | InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension > |
using | OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension > |
Private Attributes | |
InternalSizeType | m_FFTPadSize { { 0 } } |
InternalRegionType | m_PaddedInputRegion {} |
SizeValueType | m_SizeGreatestPrimeFactor {} |
Additional Inherited Members | |
Static Protected Member Functions inherited from itk::ImageSource< TInputImage > | |
static const ImageRegionSplitterBase * | GetGlobalDefaultSplitter () |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
Static Protected Member Functions inherited from itk::ProcessObject | |
template<typename TSourceObject > | |
static void | MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs) |
static constexpr float | progressFixedToFloat (uint32_t fixed) |
static uint32_t | progressFloatToFixed (float f) |
Protected Attributes inherited from itk::ImageSource< TInputImage > | |
bool | m_DynamicMultiThreading |
Protected Attributes inherited from itk::ProcessObject | |
TimeStamp | m_OutputInformationMTime {} |
bool | m_Updating {} |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ConstPointer = SmartPointer<const Self> |
Definition at line 70 of file itkFFTConvolutionImageFilter.h.
|
protected |
Because the inputs are real, we can use the specialized filters for real-to-complex Fourier transforms.
Definition at line 120 of file itkFFTConvolutionImageFilter.h.
|
protected |
Definition at line 121 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputImageType = TInputImage |
Definition at line 81 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputIndexType = typename InputImageType::IndexType |
Definition at line 87 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputPixelType = typename InputImageType::PixelType |
Definition at line 84 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputRegionType = typename InputImageType::RegionType |
Definition at line 94 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputSizeType = typename InputImageType::SizeType |
Definition at line 90 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImagePointerType = typename InternalComplexImageType::Pointer |
Definition at line 106 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImageType = Image<InternalComplexType, TInputImage::ImageDimension> |
Definition at line 105 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexType = std::complex<TInternalPrecision> |
Definition at line 104 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImagePointerType = typename InternalImageType::Pointer |
Definition at line 103 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImageType = Image<TInternalPrecision, TInputImage::ImageDimension> |
Internal types used by the FFT filters.
Definition at line 99 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalIndexType = typename InternalImageType::IndexType |
Definition at line 102 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalRegionType = typename InternalImageType::RegionType |
Definition at line 100 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalSizeType = typename InternalImageType::SizeType |
Definition at line 101 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelImageType = TKernelImage |
Definition at line 83 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelIndexType = typename KernelImageType::IndexType |
Definition at line 89 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelPixelType = typename KernelImageType::PixelType |
Definition at line 86 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelRegionType = typename KernelImageType::RegionType |
Definition at line 96 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelSizeType = typename KernelImageType::SizeType |
Definition at line 92 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputImageType = TOutputImage |
Definition at line 82 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputIndexType = typename OutputImageType::IndexType |
Definition at line 88 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputPixelType = typename OutputImageType::PixelType |
Definition at line 85 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputRegionType = typename OutputImageType::RegionType |
Definition at line 95 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputSizeType = typename OutputImageType::SizeType |
Definition at line 91 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Pointer = SmartPointer<Self> |
Definition at line 69 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Self = FFTConvolutionImageFilter |
Definition at line 67 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::SizeValueType = typename InputSizeType::SizeValueType |
Definition at line 93 of file itkFFTConvolutionImageFilter.h.
using itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Superclass = ConvolutionImageFilterBase<TInputImage, TKernelImage, TOutputImage> |
Definition at line 68 of file itkFFTConvolutionImageFilter.h.
|
protected |
|
overrideprotecteddefault |
|
protected |
Crop the padded version of the output.
|
overrideprotectedvirtual |
This filter uses a minipipeline to compute the output.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::InverseDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::IterativeDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, and itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TInputImage >.
|
overrideprotectedvirtual |
Convolution uses a spatial region equivalent to the output region padded by the kernel radius on all sides. The input requested region is expanded by the kernel radius within the bounds of the input largest possible region.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::IterativeDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, and itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TInputImage >.
|
protected |
Get padding around the region of interest that results from FFT factoring requirements. FFT typically requires that image side lengths are factorable only by a fixed set of prime numbers (often 2, 3, and 5). After the input image is padded for the kernel width and cropped to the region of interest the result is then padded for FFT execution. This value is reused for kernel padding and output cropping.
|
protected |
Get the radius of the kernel image. Used to pad the input image for convolution.
|
overridevirtual |
Reimplemented from itk::ProcessObject.
Reimplemented in itk::InverseDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::IterativeDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TInputImage >, itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, and itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double > >.
|
virtual |
|
protected |
Get whether the X dimension has an odd size.
|
static |
Method for creation through the object factory.
|
protected |
Pad the input image.
|
protected |
Prepare the input image. This includes padding the image and taking the Fourier transform of the padded image.
|
protected |
Prepare the input images for operations in the Fourier domain. This includes resizing the input and kernel images, normalizing the kernel if requested, shifting the kernel, and taking the Fourier transform of the padded inputs.
|
protected |
Prepare the kernel. This includes resizing the input and kernel images, normalizing the kernel if requested, shifting the kernel, and taking the Fourier transform of the padded kernel.
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::InverseDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::IterativeDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TInputImage >, and itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >.
|
protected |
Produce output from the final Fourier domain image.
|
virtual |
|
protected |
Take the Fourier transform of the padded input.
|
staticconstexpr |
Dimensionality of input and output data is assumed to be the same.
Definition at line 79 of file itkFFTConvolutionImageFilter.h.
|
private |
Definition at line 210 of file itkFFTConvolutionImageFilter.h.
|
private |
Definition at line 211 of file itkFFTConvolutionImageFilter.h.
|
private |
Definition at line 209 of file itkFFTConvolutionImageFilter.h.