ITK
6.0.0
Insight Toolkit
|
#include <itkFFTWComplexToComplexFFTImageFilter.h>
Implements an API to enable the Fourier transform or the inverse Fourier transform of images with complex valued voxels to be computed using either FFTW from MIT or the FFTW interface in Intel MKL.
This filter is multithreaded and supports input images with sizes which are not a power of two.
This code was contributed in the Insight Journal paper: "FFT Complex to Complex filters and helper classes" by Warfield S. https://doi.org/10.54294/h4j7t7
Definition at line 59 of file itkFFTWComplexToComplexFFTImageFilter.h.
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 = ImageType::ImageDimension |
Static Public Attributes inherited from itk::ComplexToComplexFFTImageFilter< 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 |
Private Attributes | |
bool | m_CanUseDestructiveAlgorithm {} |
int | m_PlanRigor {} |
Additional Inherited Members | |
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
using | InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension > |
using | OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension > |
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::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 69 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::FFTWProxyType = typename fftw::Proxy<typename PixelType::value_type> |
Definition at line 83 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::ImageSizeType = typename ImageType::SizeType |
Image type alias support
Definition at line 94 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType |
Definition at line 75 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::PixelType = typename ImageType::PixelType |
Definition at line 72 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self> |
Definition at line 68 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::Self = FFTWComplexToComplexFFTImageFilter |
Standard class type aliases.
Definition at line 66 of file itkFFTWComplexToComplexFFTImageFilter.h.
using itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::Superclass = ComplexToComplexFFTImageFilter<TInputImage, TOutputImage> |
Definition at line 67 of file itkFFTWComplexToComplexFFTImageFilter.h.
|
protected |
|
overrideprotecteddefault |
|
overrideprotectedvirtual |
If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.
Reimplemented from itk::ImageSource< TInputImage >.
|
overrideprotectedvirtual |
If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).
DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.
Reimplemented from itk::ImageSource< TInputImage >.
|
overridevirtual |
Reimplemented from itk::ProcessObject.
|
virtual |
Set/Get the behavior of wisdom plan creation. The default is provided by FFTWGlobalConfiguration::GetPlanRigor().
The parameter is one of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE provided by FFTWGlobalConfiguration.
This is not used when ITK_USE_CUFFTW is enabled.
|
static |
Method for creation through the object factory.
|
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.
|
inlinevirtual |
Set/Get the behavior of wisdom plan creation. The default is provided by FFTWGlobalConfiguration::GetPlanRigor().
The parameter is one of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE provided by FFTWGlobalConfiguration.
This is not used when ITK_USE_CUFFTW is enabled.
Definition at line 108 of file itkFFTWComplexToComplexFFTImageFilter.h.
References itk::FFTWGlobalConfiguration::GetPlanRigorName().
|
inline |
Set/Get the behavior of wisdom plan creation. The default is provided by FFTWGlobalConfiguration::GetPlanRigor().
The parameter is one of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE provided by FFTWGlobalConfiguration.
This is not used when ITK_USE_CUFFTW is enabled.
Definition at line 122 of file itkFFTWComplexToComplexFFTImageFilter.h.
References itk::FFTWGlobalConfiguration::GetPlanRigorValue().
|
overrideprotectedvirtual |
Actually generate new output
Reimplemented from itk::ProcessObject.
|
staticconstexpr |
Definition at line 91 of file itkFFTWComplexToComplexFFTImageFilter.h.
|
private |
Definition at line 147 of file itkFFTWComplexToComplexFFTImageFilter.h.
|
private |
Definition at line 149 of file itkFFTWComplexToComplexFFTImageFilter.h.