itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkFFTWInverse1DFFTImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>
class itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >

only do FFT along one dimension using FFTW as a backend.

Definition at line 41 of file itkFFTWInverse1DFFTImageFilter.h.

Inheritance diagram for itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	FFTW1DProxyType = typename fftw::ComplexToComplexProxy< typename TOutputImage::PixelType >
using	InputImageType = typename Superclass::InputImageType
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = typename Superclass::OutputImageType
using	PlanArrayType = typename std::vector< typename FFTW1DProxyType::PlanType >
using	PlanBufferPointerType = typename std::vector< typename FFTW1DProxyType::ComplexType * >
using	Pointer = SmartPointer< Self >
using	Self = FFTWInverse1DFFTImageFilter
using	Superclass = Inverse1DFFTImageFilter< TInputImage, TOutputImage >
Public Types inherited from itk::Inverse1DFFTImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >
using	InputImageType = TInputImage
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer< Self >
using	Self = Inverse1DFFTImageFilter
using	Superclass = ImageToImageFilter< InputImageType, OutputImageType >
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage
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

Public Member Functions
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::Inverse1DFFTImageFilter< TInputImage, TOutputImage >
virtual unsigned int	GetDirection () const
const char *	GetNameOfClass () const override
virtual SizeValueType	GetSizeGreatestPrimeFactor () const
	itkFactoryOnlyNewMacro (Self)
virtual void	SetDirection (unsigned int _arg)
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual float	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
void	IncrementProgress (float increment)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
virtual void	SetReleaseDataFlag (bool val)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 ()

Protected Member Functions
void	BeforeThreadedGenerateData () override
	FFTWInverse1DFFTImageFilter ()
const ImageRegionSplitterBase *	GetImageRegionSplitter () const override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadID) override
	~FFTWInverse1DFFTImageFilter () override
Protected Member Functions inherited from itk::Inverse1DFFTImageFilter< TInputImage, TOutputImage >
void	EnlargeOutputRequestedRegion (DataObject *output) override
void	GenerateInputRequestedRegion () override
	Inverse1DFFTImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~Inverse1DFFTImageFilter () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
void	VerifyInputInformation () const override
	~ImageToImageFilter () override=default
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	SetPrimaryInput (DataObject *object)
virtual void	SetPrimaryOutput (DataObject *object)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions () const
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType i)
const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	DestroyPlans ()

Private Attributes
ImageRegionSplitterDirection::Pointer	m_ImageRegionSplitter {}
PlanBufferPointerType	m_InputBufferArray {}
unsigned int	m_LastImageSize { 0 }
PlanBufferPointerType	m_OutputBufferArray {}
PlanArrayType	m_PlanArray {}
bool	m_PlanComputed { false }

Additional Inherited Members
Static Public Attributes inherited from itk::Inverse1DFFTImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = InputImageType::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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::Inverse1DFFTImageFilter< TInputImage, TOutputImage >
unsigned int	m_Direction { 0 }
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}
bool	m_Updating {}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 49 of file itkFFTWInverse1DFFTImageFilter.h.

FFTW1DProxyType

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::FFTW1DProxyType = typename fftw::ComplexToComplexProxy<typename TOutputImage::PixelType>

the proxy type is a wrapper for the fftw API since the proxy is only defined over double and float, trying to use any other pixel type is inoperative, as is trying to use double if only the float FFTW1D version is configured in, or float if only double is configured.

Definition at line 63 of file itkFFTWInverse1DFFTImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::InputImageType = typename Superclass::InputImageType

Standard class type alias.

Definition at line 52 of file itkFFTWInverse1DFFTImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 54 of file itkFFTWInverse1DFFTImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::OutputImageType = typename Superclass::OutputImageType

Definition at line 53 of file itkFFTWInverse1DFFTImageFilter.h.

PlanArrayType

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::PlanArrayType = typename std::vector<typename FFTW1DProxyType::PlanType>

Definition at line 64 of file itkFFTWInverse1DFFTImageFilter.h.

PlanBufferPointerType

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::PlanBufferPointerType = typename std::vector<typename FFTW1DProxyType::ComplexType *>

Definition at line 65 of file itkFFTWInverse1DFFTImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 48 of file itkFFTWInverse1DFFTImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::Self = FFTWInverse1DFFTImageFilter

Definition at line 46 of file itkFFTWInverse1DFFTImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

using itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::Superclass = Inverse1DFFTImageFilter<TInputImage, TOutputImage>

Definition at line 47 of file itkFFTWInverse1DFFTImageFilter.h.

Constructor & Destructor Documentation

FFTWInverse1DFFTImageFilter()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::FFTWInverse1DFFTImageFilter ( )

protected

~FFTWInverse1DFFTImageFilter()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::~FFTWInverse1DFFTImageFilter ( )

overrideprotected

Member Function Documentation

BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

void itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

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< TOutputImage >.

DestroyPlans()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

void itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::DestroyPlans ( )

private

Destroy FFTW Plans and associated buffers.

GetImageRegionSplitter()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

const ImageRegionSplitterBase* itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::GetImageRegionSplitter ( ) const

overrideprotectedvirtual

Override to return a splitter that does not split along the direction we are performing the transform.

Reimplemented from itk::ImageSource< TOutputImage >.

GetNameOfClass()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

const char* itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

New()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

static Pointer itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

void itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  region, ThreadIdType  threadId  )

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.

See also

GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

Member Data Documentation

m_ImageRegionSplitter

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

ImageRegionSplitterDirection::Pointer itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::m_ImageRegionSplitter {}

private

Definition at line 89 of file itkFFTWInverse1DFFTImageFilter.h.

m_InputBufferArray

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

PlanBufferPointerType itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::m_InputBufferArray {}

private

Definition at line 98 of file itkFFTWInverse1DFFTImageFilter.h.

m_LastImageSize

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

unsigned int itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::m_LastImageSize { 0 }

private

Definition at line 97 of file itkFFTWInverse1DFFTImageFilter.h.

m_OutputBufferArray

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

PlanBufferPointerType itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::m_OutputBufferArray {}

private

Definition at line 99 of file itkFFTWInverse1DFFTImageFilter.h.

m_PlanArray

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

PlanArrayType itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::m_PlanArray {}

private

Definition at line 96 of file itkFFTWInverse1DFFTImageFilter.h.

m_PlanComputed

template<typename TInputImage , typename TOutputImage = Image<typename NumericTraits<typename TInputImage::PixelType>::ValueType, TInputImage::ImageDimension>>

bool itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >::m_PlanComputed { false }

private

Definition at line 95 of file itkFFTWInverse1DFFTImageFilter.h.

---

The documentation for this class was generated from the following file:

• itkFFTWInverse1DFFTImageFilter.h