#include <itkUnaryFrequencyDomainFilter.h>

Inheritance diagram for itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >:

Collaboration diagram for itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FrequencyIteratorType = TFrequencyIterator

using	FrequencyValueType = typename FrequencyIteratorType::FrequencyValueType

using	ImageConstPointer = typename ImageType::ConstPointer

using	ImagePointer = typename ImageType::Pointer

using	ImageRegionType = typename TImageType::RegionType

using	ImageType = TImageType

using	IndexType = typename TImageType::IndexType

using	PixelType = typename TImageType::PixelType

using	Pointer = SmartPointer< Self >

using	Self = UnaryFrequencyDomainFilter

using	Superclass = InPlaceImageFilter< TImageType, TImageType >

Public Types inherited from itk::InPlaceImageFilter< TImageType, TImageType >
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 = TImageType

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImagePointer = typename Superclass::OutputImagePointer

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = typename Superclass::OutputImageType

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TImageType, TImageType >

Public Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
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 = TImageType

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TImageType >

Public Types inherited from itk::ImageSource< TImageType >
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 = TImageType

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual bool	CanRunInPlace () const

Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
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 TImageType *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< TImageType >
OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

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)

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< TImageType, TImageType >
static void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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 = TImageType::ImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TImageType, TImageType >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TImageType, TImageType >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TImageType >
static constexpr unsigned int	OutputImageDimension

using	ConstRefFunctionType = double(const FrequencyIteratorType &)

using	ValueFunctionType = void(FrequencyIteratorType &)

std::function< void(const ImageRegionType &)>	m_DynamicThreadedGenerateDataFunction

bool	m_ActualXDimensionIsOdd { false }

virtual void	SetActualXDimensionIsOdd (bool _arg)

virtual const bool &	GetActualXDimensionIsOdd () const

virtual void	ActualXDimensionIsOddOn ()

virtual void	ActualXDimensionIsOddOff ()

void	SetFunctor (const std::function< ConstRefFunctionType > &f)

void	SetFunctor (const std::function< ValueFunctionType > &f)

void	SetFunctor (ConstRefFunctionType *f)

void	SetFunctor (ValueFunctionType *funcPointer)

template<typename TFunctor >
void	SetFunctor (const TFunctor &functor)

	UnaryFrequencyDomainFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

template<typename TFunctor >
void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const ImageRegionType &outputRegionForThread)

void	DynamicThreadedGenerateData (const ImageRegionType &outputRegionForThread) override

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
	InPlaceImageFilter ()=default

	~InPlaceImageFilter () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

void	AllocateOutputs () override

void	ReleaseInputs () override

virtual bool	GetRunningInPlace () const

Protected Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

	ImageToImageFilter ()

	~ImageToImageFilter () override=default

void	VerifyInputInformation () ITKv5_CONST override

void	GenerateInputRequestedRegion () override

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

Protected Member Functions inherited from itk::ImageSource< TImageType >
	ImageSource ()

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 ()

Static Protected Member Functions inherited from itk::ImageSource< TImageType >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TImageType >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TImageType, typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
class itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >

Performs a unary operation on a frequency domain image.

A frequency filtering functor needs to be supplied via one of SetFunctor() overloads. The functor should take FrequencyIteratorType reference as its only parameter. If functor configurability is required, those parameters should be passed directly to the functor at the place of definition.

Filters in the module ITKImageFrequency work with input images in the frequency domain. This filter is templated over a TFrequencyIterator depending on the frequency layout of the input image.

Images in the dual space can be acquired experimentally, from scattering experiments or other techniques. In that case use FrequencyImageRegionIteratorWithIndex because the layout of dual space images is the same as spatial domain images.

Frequency-domain images can be computed from any spatial-domain applying a Fourier Transform. If ForwardFFTImageFilter was used, template this filter with the FrequencyFFTLayoutImageRegionIteratorWithIndex. Please note that FrequencyFFTLayoutImageRegionIteratorWithIndex requires a full FFT, and is not compatible with the Hermitian optimization.

To use this filter with Hermitian (halved-frequency) FFTs, use FrequencyHalfHermitianFFTLayoutImageRegionIteratorWithIndex or its const version.

If the output of the FFT is shifted, for example after applying FFTShiftImageFilter, use FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.

See also: UnaryGeneratorImageFilter

Definition at line 61 of file itkUnaryFrequencyDomainFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ConstPointer = SmartPointer<const Self>

Definition at line 70 of file itkUnaryFrequencyDomainFilter.h.

◆ ConstRefFunctionType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ConstRefFunctionType = double(const FrequencyIteratorType &)

Returns factor with which the current frequency should be multiplied.

Definition at line 109 of file itkUnaryFrequencyDomainFilter.h.

◆ FrequencyIteratorType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::FrequencyIteratorType = TFrequencyIterator

Frequency Iterator types

Definition at line 95 of file itkUnaryFrequencyDomainFilter.h.

◆ FrequencyValueType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::FrequencyValueType = typename FrequencyIteratorType::FrequencyValueType

Definition at line 96 of file itkUnaryFrequencyDomainFilter.h.

◆ ImageConstPointer

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ImageConstPointer = typename ImageType::ConstPointer

Definition at line 81 of file itkUnaryFrequencyDomainFilter.h.

◆ ImagePointer

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ImagePointer = typename ImageType::Pointer

Definition at line 80 of file itkUnaryFrequencyDomainFilter.h.

◆ ImageRegionType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ImageRegionType = typename TImageType::RegionType

Typedef to describe the image region type.

Definition at line 86 of file itkUnaryFrequencyDomainFilter.h.

◆ ImageType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ImageType = TImageType

Typedef to images

Definition at line 79 of file itkUnaryFrequencyDomainFilter.h.

◆ IndexType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::IndexType = typename TImageType::IndexType

Definition at line 82 of file itkUnaryFrequencyDomainFilter.h.

◆ PixelType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::PixelType = typename TImageType::PixelType

Definition at line 83 of file itkUnaryFrequencyDomainFilter.h.

◆ Pointer

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::Pointer = SmartPointer<Self>

Definition at line 69 of file itkUnaryFrequencyDomainFilter.h.

◆ Self

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::Self = UnaryFrequencyDomainFilter

Standard class type alias.

Definition at line 67 of file itkUnaryFrequencyDomainFilter.h.

◆ Superclass

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::Superclass = InPlaceImageFilter<TImageType, TImageType>

Definition at line 68 of file itkUnaryFrequencyDomainFilter.h.

◆ ValueFunctionType

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

using itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ValueFunctionType = void(FrequencyIteratorType &)

Directly modifies the frequency as needed.

Definition at line 112 of file itkUnaryFrequencyDomainFilter.h.

Constructor & Destructor Documentation

◆ UnaryFrequencyDomainFilter()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::UnaryFrequencyDomainFilter ( )

protected

Returns factor with which the current frequency should be multiplied.

Member Function Documentation

◆ ActualXDimensionIsOddOff()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

virtual void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ActualXDimensionIsOddOff ( )

virtual

Returns factor with which the current frequency should be multiplied.

◆ ActualXDimensionIsOddOn()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

virtual void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ActualXDimensionIsOddOn ( )

virtual

Returns factor with which the current frequency should be multiplied.

◆ CreateAnother()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

virtual::itk::LightObject::Pointer itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ DynamicThreadedGenerateData()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateData ( const ImageRegionType & outputRegionForThread )

overrideprotected

Returns factor with which the current frequency should be multiplied.

◆ DynamicThreadedGenerateDataWithFunctor()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

template<typename TFunctor >

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateDataWithFunctor	(	const TFunctor &	,
		const ImageRegionType &	outputRegionForThread
	)

protected

UnaryFrequencyDomainFilter is implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread.

The template method is instantiated by the SetFunctor method, and the generated code is run during the update.

See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Referenced by itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor().

◆ GetActualXDimensionIsOdd()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

virtual const bool& itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::GetActualXDimensionIsOdd ( ) const

virtual

Returns factor with which the current frequency should be multiplied.

◆ GetNameOfClass()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

virtual const char* itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TImageType, TImageType >.

Reimplemented in itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >.

◆ New()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

static Pointer itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Returns factor with which the current frequency should be multiplied.

Reimplemented from itk::ProcessObject.

◆ SetActualXDimensionIsOdd()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

virtual void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetActualXDimensionIsOdd ( bool _arg )

virtual

Set to true when the you are dealing with images in the frequency domain that have been computed using RealToHalfHermitianFFT, and the original image in the spatial domain was odd. Only needed when using HermitianFrequencyIterator and the original image was odd.

◆ SetFunctor() [1/5]

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor ( const std::function< ConstRefFunctionType > & f )

inline

The functor returns factor with which the current frequency should be multiplied.

Definition at line 117 of file itkUnaryFrequencyDomainFilter.h.

References itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateDataWithFunctor(), itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction, and itk::Object::Modified().

◆ SetFunctor() [2/5]

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor ( const std::function< ValueFunctionType > & f )

inline

The functor directly modifies the frequency as needed.

Definition at line 130 of file itkUnaryFrequencyDomainFilter.h.

References itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateDataWithFunctor(), itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction, and itk::Object::Modified().

◆ SetFunctor() [3/5]

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

template<typename TFunctor >

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor ( const TFunctor & functor )

inline

Set the frequency functor by a "Functor Object"

The functor defines an operation done per scalar frequency. A single copy
of the argument is created an used for all threads, so the functor
must be concurrent thread-safe. The functor must a have an
operator() method which accept arguments of FrequencyIteratorType&.

Definition at line 176 of file itkUnaryFrequencyDomainFilter.h.

References itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateDataWithFunctor(), itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction, and itk::Object::Modified().

◆ SetFunctor() [4/5]

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor ( ConstRefFunctionType * f )

inline

The functor returns factor with which the current frequency should be multiplied.

Definition at line 143 of file itkUnaryFrequencyDomainFilter.h.

References itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateDataWithFunctor(), itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction, and itk::Object::Modified().

◆ SetFunctor() [5/5]

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

void itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor ( ValueFunctionType * funcPointer )

inline

The functor directly modifies the frequency as needed.

Definition at line 156 of file itkUnaryFrequencyDomainFilter.h.

References itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::DynamicThreadedGenerateDataWithFunctor(), itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction, and itk::Object::Modified().

Member Data Documentation

◆ ImageDimension

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

constexpr unsigned int itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::ImageDimension = TImageType::ImageDimension

staticconstexpr

Definition at line 88 of file itkUnaryFrequencyDomainFilter.h.

◆ m_ActualXDimensionIsOdd

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

bool itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_ActualXDimensionIsOdd { false }

private

Returns factor with which the current frequency should be multiplied.

Definition at line 211 of file itkUnaryFrequencyDomainFilter.h.

◆ m_DynamicThreadedGenerateDataFunction

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>

std::function<void(const ImageRegionType &)> itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction

private

Returns factor with which the current frequency should be multiplied.

Definition at line 209 of file itkUnaryFrequencyDomainFilter.h.

Referenced by itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >::SetFunctor().

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

itkUnaryFrequencyDomainFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<typename TImageType, typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>> class itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >

Member Typedef Documentation

◆ ConstPointer

◆ ConstRefFunctionType

◆ FrequencyIteratorType

◆ FrequencyValueType

◆ ImageConstPointer

◆ ImagePointer

◆ ImageRegionType

◆ ImageType

◆ IndexType

◆ PixelType

◆ Pointer

◆ Self

◆ Superclass

◆ ValueFunctionType

Constructor & Destructor Documentation

◆ UnaryFrequencyDomainFilter()

Member Function Documentation

◆ ActualXDimensionIsOddOff()

◆ ActualXDimensionIsOddOn()

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ DynamicThreadedGenerateDataWithFunctor()

◆ GetActualXDimensionIsOdd()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetActualXDimensionIsOdd()

◆ SetFunctor() [1/5]

◆ SetFunctor() [2/5]

◆ SetFunctor() [3/5]

◆ SetFunctor() [4/5]

◆ SetFunctor() [5/5]

Member Data Documentation

◆ ImageDimension

◆ m_ActualXDimensionIsOdd

◆ m_DynamicThreadedGenerateDataFunction

template<typename TImageType, typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
class itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >