itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator > Class Template Reference

#include <itkFrequencyBandImageFilter.h>

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

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

Detailed Description

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

Performs a frequency band filtering on a frequency domain image.

The default filtering functor filters in the range LowFrequencyThreshold and HighFrequencyThreshold - pass band between threshold frequencies [0,0.5] Hz or [0, pi] radians, where both boundary values also pass (equivalent to SetPassBand(true,true)). A pass band sets to zero any value outside the defined range, and let pass without modification the input image inside the band.

Instead, a stop band can be set between the threshold values. In this case, the delimited band acts as a stop band, setting values to zero in this range, and does not modify input image values outside this range. Set a stop band using SetPassBand(false), but it is clearer to use SetStopBand(bool, bool) that also control behaviour at band boundaries.

The boundaries of the bands are controlled with SetPassLow(High)FrequencyThreshold(bool). The default is to let pass low and high boundaries. Also, SetPassBand(true, false), will let pass low boundary/threshold, and stop the high value.

This filter derives from UnaryFrequencyDomainFilter and implements its own custom functor. If a different functor is set, the normal functionality of this filter will be lost.

See Also

UnaryFrequencyDomainFilter

Definition at line 52 of file itkFrequencyBandImageFilter.h.

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 = FrequencyBandImageFilter
using	Superclass = UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
Public Types inherited from itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
using	ConstPointer = SmartPointer< const Self >
using	ConstRefFunctionType = double(const FrequencyIteratorType &)
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 >
using	ValueFunctionType = void(FrequencyIteratorType &)
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 FrequencyValueType &	GetLowFrequencyThreshold () const
virtual const char *	GetNameOfClass () const
void	SetFrequencyThresholds (const FrequencyValueType &freqLow, const FrequencyValueType &freqHigh)
void	SetFrequencyThresholdsInRadians (const FrequencyValueType &freqLowInRadians, const FrequencyValueType &freqHighInRadians)
virtual void	SetLowFrequencyThreshold (FrequencyValueType _arg)
void	SetLowFrequencyThresholdInRadians (const FrequencyValueType &freqLowInRadians)
void	SetPassBand (const bool pass_low_threshold, const bool pass_high_threshold)
void	SetStopBand (const bool pass_low_threshold, const bool pass_high_threshold)
virtual const FrequencyValueType &	GetHighFrequencyThreshold () const
virtual void	SetHighFrequencyThreshold (FrequencyValueType _arg)
void	SetHighFrequencyThresholdInRadians (const FrequencyValueType &freqHighInRadians)
virtual void	SetPassLowFrequencyThreshold (bool _arg)
virtual const bool &	GetPassLowFrequencyThreshold () const
virtual void	PassLowFrequencyThresholdOn ()
virtual void	PassLowFrequencyThresholdOff ()
virtual void	SetPassHighFrequencyThreshold (bool _arg)
virtual const bool &	GetPassHighFrequencyThreshold () const
virtual void	PassHighFrequencyThresholdOn ()
virtual void	PassHighFrequencyThresholdOff ()
virtual void	SetPassBand (bool _arg)
virtual const bool &	GetPassBand () const
virtual void	PassBandOn ()
virtual void	PassBandOff ()
virtual void	SetRadialBand (bool _arg)
virtual const bool &	GetRadialBand () const
virtual void	RadialBandOn ()
virtual void	RadialBandOff ()
virtual void	SetPassNegativeLowFrequencyThreshold (bool _arg)
virtual const bool &	GetPassNegativeLowFrequencyThreshold () const
virtual void	PassNegativeLowFrequencyThresholdOn ()
virtual void	PassNegativeLowFrequencyThresholdOff ()
virtual void	SetPassNegativeHighFrequencyThreshold (bool _arg)
virtual const bool &	GetPassNegativeHighFrequencyThreshold () const
virtual void	PassNegativeHighFrequencyThresholdOn ()
virtual void	PassNegativeHighFrequencyThresholdOff ()
Public Member Functions inherited from itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
virtual ::itk::LightObject::Pointer	CreateAnother () const
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)
virtual void	SetActualXDimensionIsOdd (bool _arg)
virtual const bool &	GetActualXDimensionIsOdd () const
virtual void	ActualXDimensionIsOddOn ()
virtual void	ActualXDimensionIsOddOff ()
Public Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
virtual bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
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 *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
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 (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
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 ()
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 const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
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 flag)
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
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride
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
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
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::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
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

Protected Member Functions
void	BandPass (FrequencyIteratorType &frequency)
	FrequencyBandImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyPreconditions () ITKv5_CONST override
Protected Member Functions inherited from itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
void	PrintSelf (std::ostream &os, Indent indent) const override
	UnaryFrequencyDomainFilter ()
template<typename TFunctor >
void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const ImageRegionType &outputRegionForThread)
void	DynamicThreadedGenerateData (const ImageRegionType &outputRegionForThread) override
Protected Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
void	AllocateOutputs () override
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
void	ReleaseInputs () override
	~InPlaceImageFilter () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	GenerateInputRequestedRegion () override
	ImageToImageFilter ()
void	VerifyInputInformation () ITKv5_CONST override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TImageType >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
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	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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
	~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 idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 Attributes
std::function< void(const ImageRegionType &) >	m_DynamicThreadedGenerateDataFunction
FrequencyValueType	m_HighFrequencyThreshold
FrequencyValueType	m_LowFrequencyThreshold
bool	m_PassBand {true}
bool	m_PassHighFrequencyThreshold {true}
bool	m_PassLowFrequencyThreshold {true}
bool	m_PassNegativeHighFrequencyThreshold {true}
bool	m_PassNegativeLowFrequencyThreshold {true}
bool	m_RadialBand {true}

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 >
Static Protected Member Functions inherited from itk::ImageSource< TImageType >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::ImageSource< TImageType >
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

Member Typedef Documentation

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

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

Definition at line 61 of file itkFrequencyBandImageFilter.h.

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

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

Frequency Iterator types

Definition at line 82 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 83 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 72 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 71 of file itkFrequencyBandImageFilter.h.

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

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

Typedef to describe the image region type.

Definition at line 77 of file itkFrequencyBandImageFilter.h.

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

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

Typedef to images

Definition at line 70 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 73 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 74 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 60 of file itkFrequencyBandImageFilter.h.

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

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

Standard class type alias.

Definition at line 58 of file itkFrequencyBandImageFilter.h.

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

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

Definition at line 59 of file itkFrequencyBandImageFilter.h.

Constructor & Destructor Documentation

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

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

protected

Member Function Documentation

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::BandPass ( FrequencyIteratorType &  frequency )

protected

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

virtual::itk::LightObject::Pointer itk::FrequencyBandImageFilter< 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.

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

virtual const FrequencyValueType& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetHighFrequencyThreshold ( ) const

virtual

Band range: High threshold/boundary in Hertz

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

virtual const FrequencyValueType& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetLowFrequencyThreshold ( ) const

virtual

Band range: Low threshold/boundary in Hertz

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >.

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

virtual const bool& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetPassBand ( ) const

virtual

True: the band is a PassBand. False: StopBand

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

virtual const bool& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetPassHighFrequencyThreshold ( ) const

virtual

The pixel values that correspond to m_HighFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual const bool& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetPassLowFrequencyThreshold ( ) const

virtual

The pixel values that correspond to m_LowFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual const bool& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetPassNegativeHighFrequencyThreshold ( ) const

virtual

Control if negative frequencies with absolute value equal to high frequency threshold are passing. Only effective when RadialBand is false

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

virtual const bool& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetPassNegativeLowFrequencyThreshold ( ) const

virtual

Control if negative frequencies with absolute value equal to low frequency threshold are passing. Only effective when RadialBand is false

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

virtual const bool& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetRadialBand ( ) const

virtual

If true the frequency cut-off uses the radius of the frequency vector. If false, it uses the max absolute value of the frequency vector.

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

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

static

Method for creation through the object factory.

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassBandOff ( )

virtual

True: the band is a PassBand. False: StopBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassBandOn ( )

virtual

True: the band is a PassBand. False: StopBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassHighFrequencyThresholdOff ( )

virtual

The pixel values that correspond to m_HighFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassHighFrequencyThresholdOn ( )

virtual

The pixel values that correspond to m_HighFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassLowFrequencyThresholdOff ( )

virtual

The pixel values that correspond to m_LowFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassLowFrequencyThresholdOn ( )

virtual

The pixel values that correspond to m_LowFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassNegativeHighFrequencyThresholdOff ( )

virtual

Control if negative frequencies with absolute value equal to high frequency threshold are passing. Only effective when RadialBand is false

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassNegativeHighFrequencyThresholdOn ( )

virtual

Control if negative frequencies with absolute value equal to high frequency threshold are passing. Only effective when RadialBand is false

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassNegativeLowFrequencyThresholdOff ( )

virtual

Control if negative frequencies with absolute value equal to low frequency threshold are passing. Only effective when RadialBand is false

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassNegativeLowFrequencyThresholdOn ( )

virtual

Control if negative frequencies with absolute value equal to low frequency threshold are passing. Only effective when RadialBand is false

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

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

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.

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::RadialBandOff ( )

virtual

If true the frequency cut-off uses the radius of the frequency vector. If false, it uses the max absolute value of the frequency vector.

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::RadialBandOn ( )

virtual

If true the frequency cut-off uses the radius of the frequency vector. If false, it uses the max absolute value of the frequency vector.

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetFrequencyThresholds	(	const FrequencyValueType &	freqLow,
		const FrequencyValueType &	freqHigh
	)

Set LowFrequencyThreshold and HighFrequencyThreshold at the same time, input frequencies in Hertz.

Parameters

freqLow	in hertz.
freqHigh	in hertz.

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetFrequencyThresholdsInRadians	(	const FrequencyValueType &	freqLowInRadians,
		const FrequencyValueType &	freqHighInRadians
	)

Set LowFrequencyThreshold and HighFrequencyThreshold at the same time, input frequencies in Radians. 1Hz = (1/2pi) rad

Parameters

freqLowInRadians	low freq in radians.
freqHighInRadians	high freq in radians.

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetHighFrequencyThreshold ( FrequencyValueType  _arg )

virtual

Band range: High threshold/boundary in Hertz

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetHighFrequencyThresholdInRadians

(

const FrequencyValueType &

freqHighInRadians

)

Band range: High threshold/boundary in Hertz

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetLowFrequencyThreshold ( FrequencyValueType  _arg )

virtual

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetLowFrequencyThresholdInRadians

(

const FrequencyValueType &

freqLowInRadians

)

Set low frequency threshold when input frequency is in radians.

Parameters

freqLowInRadians

low freq in radians.

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassBand ( bool  _arg )

virtual

True: the band is a PassBand. False: StopBand

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassBand	(	const bool	pass_low_threshold,
		const bool	pass_high_threshold
	)

Utility method equivalent to: SetPassBand(true) SetPassLowFrequencyThreshold(pass_low_threshold) SetPassHighFrequencyThreshold(pass_high_threshold)

Parameters

pass_low_threshold	flag to let pass or not low boundary
pass_high_threshold	flag to let pass or not high boundary

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassHighFrequencyThreshold ( bool  _arg )

virtual

The pixel values that correspond to m_HighFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassLowFrequencyThreshold ( bool  _arg )

virtual

The pixel values that correspond to m_LowFrequencyThreshold are passed to the output image, independent of m_PassBand

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassNegativeHighFrequencyThreshold ( bool  _arg )

virtual

Control if negative frequencies with absolute value equal to high frequency threshold are passing. Only effective when RadialBand is false

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassNegativeLowFrequencyThreshold ( bool  _arg )

virtual

Control if negative frequencies with absolute value equal to low frequency threshold are passing. Only effective when RadialBand is false

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

virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetRadialBand ( bool  _arg )

virtual

If true the frequency cut-off uses the radius of the frequency vector. If false, it uses the max absolute value of the frequency vector.

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetStopBand	(	const bool	pass_low_threshold,
		const bool	pass_high_threshold
	)

Utility method equivalent to: SetPassBand(false) SetPassLowFrequencyThreshold(pass_low_threshold) SetPassHighFrequencyThreshold(pass_high_threshold)

Parameters

pass_low_threshold	flag to let pass or not low boundary
pass_high_threshold	flag to let pass or not high boundary

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

void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::VerifyPreconditions ( )

overrideprotectedvirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation is propagated to the inputs.

The ProcessObject's implementation verifies that the NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

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

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

static

Definition at line 79 of file itkFrequencyBandImageFilter.h.

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

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

private

Definition at line 197 of file itkFrequencyBandImageFilter.h.

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

FrequencyValueType itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_HighFrequencyThreshold

private

Definition at line 200 of file itkFrequencyBandImageFilter.h.

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

FrequencyValueType itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_LowFrequencyThreshold

private

Definition at line 199 of file itkFrequencyBandImageFilter.h.

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

bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassBand {true}

private

Definition at line 202 of file itkFrequencyBandImageFilter.h.

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

bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassHighFrequencyThreshold {true}

private

Definition at line 204 of file itkFrequencyBandImageFilter.h.

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

bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassLowFrequencyThreshold {true}

private

Definition at line 203 of file itkFrequencyBandImageFilter.h.

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

bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassNegativeHighFrequencyThreshold {true}

private

Definition at line 207 of file itkFrequencyBandImageFilter.h.

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

bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassNegativeLowFrequencyThreshold {true}

private

Definition at line 206 of file itkFrequencyBandImageFilter.h.

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

bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_RadialBand {true}

private

Definition at line 205 of file itkFrequencyBandImageFilter.h.

---

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

• itkFrequencyBandImageFilter.h