ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator > Class Template Reference

#include <itkFrequencyBandImageFilter.h>

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 53 of file itkFrequencyBandImageFilter.h.

+ Inheritance diagram for itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >:
+ Collaboration diagram for itk::FrequencyBandImageFilter< 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 = 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 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 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 const FrequencyValueTypeGetLowFrequencyThreshold () const
 
const char * GetNameOfClass () const override
 
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 passLowThreshold, const bool passHighThreshold)
 
void SetStopBand (const bool passLowThreshold, const bool passHighThreshold)
 
virtual const FrequencyValueTypeGetHighFrequencyThreshold () 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 SetPassHighFrequencyThreshold (bool _arg)
 
virtual const bool & GetPassHighFrequencyThreshold () const
 
virtual void PassHighFrequencyThresholdOn ()
 
virtual void SetPassBand (bool _arg)
 
virtual const bool & GetPassBand () const
 
virtual void PassBandOn ()
 
virtual void SetRadialBand (bool _arg)
 
virtual const bool & GetRadialBand () const
 
virtual void RadialBandOn ()
 
virtual void SetPassNegativeLowFrequencyThreshold (bool _arg)
 
virtual const bool & GetPassNegativeLowFrequencyThreshold () const
 
virtual void PassNegativeLowFrequencyThresholdOn ()
 
virtual void SetPassNegativeHighFrequencyThreshold (bool _arg)
 
virtual const bool & GetPassNegativeHighFrequencyThreshold () const
 
virtual void PassNegativeHighFrequencyThresholdOn ()
 
- Public Member Functions inherited from itk::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
const char * GetNameOfClass () const override
 
void SetFunctor (const std::function< ConstRefFunctionType > &f)
 
void SetFunctor (ConstRefFunctionType *f)
 
virtual void SetActualXDimensionIsOdd (bool _arg)
 
virtual const bool & GetActualXDimensionIsOdd () const
 
virtual void ActualXDimensionIsOddOn ()
 
void SetFunctor (const std::function< ValueFunctionType > &f)
 
void SetFunctor (ValueFunctionType *funcPointer)
 
template<typename TFunctor >
void SetFunctor (const TFunctor &functor)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
virtual bool CanRunInPlace () const
 
const char * GetNameOfClass () const override
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (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 >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () 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 void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () 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 ThreadIdTypeGetNumberOfWorkUnits () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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::UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = 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 &freqIt)
 
 FrequencyBandImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyPreconditions () 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 >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
- 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 () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TImageType >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
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)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 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 &)
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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 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 ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< 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

◆ ConstPointer

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

Definition at line 62 of file itkFrequencyBandImageFilter.h.

◆ FrequencyIteratorType

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

Frequency Iterator types

Definition at line 83 of file itkFrequencyBandImageFilter.h.

◆ FrequencyValueType

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

Definition at line 84 of file itkFrequencyBandImageFilter.h.

◆ ImageConstPointer

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

Definition at line 73 of file itkFrequencyBandImageFilter.h.

◆ ImagePointer

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

Definition at line 72 of file itkFrequencyBandImageFilter.h.

◆ ImageRegionType

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 78 of file itkFrequencyBandImageFilter.h.

◆ ImageType

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

Typedef to images

Definition at line 71 of file itkFrequencyBandImageFilter.h.

◆ IndexType

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

Definition at line 74 of file itkFrequencyBandImageFilter.h.

◆ PixelType

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

Definition at line 75 of file itkFrequencyBandImageFilter.h.

◆ Pointer

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

Definition at line 61 of file itkFrequencyBandImageFilter.h.

◆ Self

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

Standard class type alias.

Definition at line 59 of file itkFrequencyBandImageFilter.h.

◆ Superclass

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

Definition at line 60 of file itkFrequencyBandImageFilter.h.

Constructor & Destructor Documentation

◆ FrequencyBandImageFilter()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::FrequencyBandImageFilter ( )
protected

Member Function Documentation

◆ BandPass()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::BandPass ( FrequencyIteratorType freqIt)
protected

◆ GetHighFrequencyThreshold()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
virtual const FrequencyValueType& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetHighFrequencyThreshold ( ) const
virtual

Band range: High threshold/boundary in Hertz

◆ GetLowFrequencyThreshold()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
virtual const FrequencyValueType& itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetLowFrequencyThreshold ( ) const
virtual

Band range: Low threshold/boundary in Hertz

◆ GetNameOfClass()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
const char* itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::GetNameOfClass ( ) const
overridevirtual

◆ GetPassBand()

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

◆ GetPassHighFrequencyThreshold()

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

◆ GetPassLowFrequencyThreshold()

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

◆ GetPassNegativeHighFrequencyThreshold()

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

◆ GetPassNegativeLowFrequencyThreshold()

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

◆ GetRadialBand()

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.

◆ New()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
static Pointer itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::New ( )
static

Method for creation through the object factory.

◆ PassBandOn()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::PassBandOn ( )
virtual

True: the band is a PassBand. False: StopBand

◆ PassHighFrequencyThresholdOn()

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

◆ PassLowFrequencyThresholdOn()

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

◆ PassNegativeHighFrequencyThresholdOn()

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

◆ PassNegativeLowFrequencyThresholdOn()

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

◆ PrintSelf()

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.

◆ RadialBandOn()

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.

◆ SetFrequencyThresholds()

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
freqLowin hertz.
freqHighin hertz.

◆ SetFrequencyThresholdsInRadians()

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
freqLowInRadianslow freq in radians.
freqHighInRadianshigh freq in radians.

◆ SetHighFrequencyThreshold()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetHighFrequencyThreshold ( FrequencyValueType  _arg)
virtual

Band range: High threshold/boundary in Hertz

◆ SetHighFrequencyThresholdInRadians()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetHighFrequencyThresholdInRadians ( const FrequencyValueType freqHighInRadians)

Band range: High threshold/boundary in Hertz

◆ SetLowFrequencyThreshold()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
virtual void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetLowFrequencyThreshold ( FrequencyValueType  _arg)
virtual

◆ SetLowFrequencyThresholdInRadians()

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
freqLowInRadianslow freq in radians.

◆ SetPassBand() [1/2]

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

◆ SetPassBand() [2/2]

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetPassBand ( const bool  passLowThreshold,
const bool  passHighThreshold 
)

Utility method equivalent to: SetPassBand(true) SetPassLowFrequencyThreshold(passLowThreshold) SetPassHighFrequencyThreshold(passHighThreshold)

Parameters
passLowThresholdflag to let pass or not low boundary
passHighThresholdflag to let pass or not high boundary

◆ SetPassHighFrequencyThreshold()

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

◆ SetPassLowFrequencyThreshold()

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

◆ SetPassNegativeHighFrequencyThreshold()

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

◆ SetPassNegativeLowFrequencyThreshold()

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

◆ SetRadialBand()

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.

◆ SetStopBand()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::SetStopBand ( const bool  passLowThreshold,
const bool  passHighThreshold 
)

Utility method equivalent to: SetPassBand(false) SetPassLowFrequencyThreshold(passLowThreshold) SetPassHighFrequencyThreshold(passHighThreshold)

Parameters
passLowThresholdflag to let pass or not low boundary
passHighThresholdflag to let pass or not high boundary

◆ VerifyPreconditions()

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
void itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::VerifyPreconditions ( ) const
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 m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ ImageDimension

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
constexpr unsigned int itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::ImageDimension = TImageType::ImageDimension
staticconstexpr

Definition at line 80 of file itkFrequencyBandImageFilter.h.

◆ m_DynamicThreadedGenerateDataFunction

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
std::function<void(const ImageRegionType &)> itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_DynamicThreadedGenerateDataFunction {}
private

Definition at line 207 of file itkFrequencyBandImageFilter.h.

◆ m_HighFrequencyThreshold

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
FrequencyValueType itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_HighFrequencyThreshold {}
private

Definition at line 210 of file itkFrequencyBandImageFilter.h.

◆ m_LowFrequencyThreshold

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
FrequencyValueType itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_LowFrequencyThreshold {}
private

Definition at line 209 of file itkFrequencyBandImageFilter.h.

◆ m_PassBand

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassBand { true }
private

Definition at line 212 of file itkFrequencyBandImageFilter.h.

◆ m_PassHighFrequencyThreshold

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassHighFrequencyThreshold { true }
private

Definition at line 214 of file itkFrequencyBandImageFilter.h.

◆ m_PassLowFrequencyThreshold

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassLowFrequencyThreshold { true }
private

Definition at line 213 of file itkFrequencyBandImageFilter.h.

◆ m_PassNegativeHighFrequencyThreshold

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassNegativeHighFrequencyThreshold { true }
private

Definition at line 217 of file itkFrequencyBandImageFilter.h.

◆ m_PassNegativeLowFrequencyThreshold

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_PassNegativeLowFrequencyThreshold { true }
private

Definition at line 216 of file itkFrequencyBandImageFilter.h.

◆ m_RadialBand

template<typename TImageType , typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType>>
bool itk::FrequencyBandImageFilter< TImageType, TFrequencyIterator >::m_RadialBand { true }
private

Definition at line 215 of file itkFrequencyBandImageFilter.h.


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