itk::FrequencyImageRegionConstIteratorWithIndex< TImage > Class Template Reference

#include <itkFrequencyImageRegionConstIteratorWithIndex.h>

Detailed Description

template<typename TImage>
class itk::FrequencyImageRegionConstIteratorWithIndex< TImage >

A multi-dimensional iterator templated over image type that walks pixels within a region and is specialized to keep track of its image index location.

This class is a specialization of ImageRegionConstIteratorWithIndex, adding method GetFrequencyBins to give the frequency bins corresponding to image indices, and GetFrequency to get the frequency of the bin.

This iterator assumes that the image is already in the frequency domain, so GetFrequencyBin is a wrap around GetIndex(), and GetFrequency is a wrap around Get().

For a different layout, use other frequency iterator.

Please see ImageRegionConstIteratorWithIndex for more information.

See also

ForwardFFTImageFilter

MORE INFORMATION

For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from https://www.itk.org.

See also

ImageRegionIteratorWithIndex

ImageConstIterator

ConditionalConstIterator

ConstNeighborhoodIterator

ConstShapedNeighborhoodIterator

ConstSliceIterator

CorrespondenceDataStructureIterator

FloodFilledFunctionConditionalConstIterator

FloodFilledImageFunctionConditionalConstIterator

FloodFilledImageFunctionConditionalIterator

FloodFilledSpatialFunctionConditionalConstIterator

FloodFilledSpatialFunctionConditionalIterator

ImageConstIterator

ImageConstIteratorWithIndex

ImageIterator

ImageIteratorWithIndex

ImageLinearConstIteratorWithIndex

ImageLinearIteratorWithIndex

ImageRandomConstIteratorWithIndex

ImageRandomIteratorWithIndex

ImageRegionConstIterator

ImageRegionConstIteratorWithIndex

ImageRegionExclusionConstIteratorWithIndex

ImageRegionExclusionIteratorWithIndex

ImageRegionIterator

ImageRegionIteratorWithIndex

ImageRegionReverseConstIterator

ImageRegionReverseIterator

ImageReverseConstIterator

ImageReverseIterator

ImageSliceConstIteratorWithIndex

ImageSliceIteratorWithIndex

NeighborhoodIterator

PathConstIterator

PathIterator

ShapedNeighborhoodIterator

SliceIterator

ImageConstIteratorWithIndex

Definition at line 78 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

Inheritance diagram for itk::FrequencyImageRegionConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::FrequencyImageRegionConstIteratorWithIndex< TImage >:

Public Types
using	AccessorType = typename TImage::AccessorType
using	FrequencyType = typename ImageType::SpacingType
using	FrequencyValueType = typename ImageType::SpacingValueType
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	OffsetType = typename TImage::OffsetType
using	PixelContainer = typename TImage::PixelContainer
using	PixelContainerPointer = typename PixelContainer::Pointer
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	Self = FrequencyImageRegionConstIteratorWithIndex
using	SizeType = typename TImage::SizeType
using	Superclass = ImageRegionConstIteratorWithIndex< TImage >
Public Types inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
using	AccessorType = typename TImage::AccessorType
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	OffsetType = typename TImage::OffsetType
using	PixelContainer = typename TImage::PixelContainer
using	PixelContainerPointer = typename PixelContainer::Pointer
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	Self = ImageRegionConstIteratorWithIndex
using	SizeType = typename TImage::SizeType
using	Superclass = ImageConstIteratorWithIndex< TImage >
Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
using	AccessorFunctorType = typename TImage::AccessorFunctorType
using	AccessorType = typename TImage::AccessorType
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	IndexValueType = typename IndexType::IndexValueType
using	InternalPixelType = typename TImage::InternalPixelType
using	OffsetType = typename TImage::OffsetType
using	OffsetValueType = typename OffsetType::OffsetValueType
using	PixelContainer = typename TImage::PixelContainer
using	PixelContainerPointer = typename PixelContainer::Pointer
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	Self = ImageConstIteratorWithIndex
using	SizeType = typename TImage::SizeType
using	SizeValueType = typename SizeType::SizeValueType

Public Member Functions
	FrequencyImageRegionConstIteratorWithIndex ()
	FrequencyImageRegionConstIteratorWithIndex (const Superclass &it)
	FrequencyImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
FrequencyType	GetFrequency () const
IndexType	GetFrequencyBin () const
FrequencyValueType	GetFrequencyModuloSquare () const
virtual const FrequencyType &	GetFrequencyOrigin () const
virtual const FrequencyType &	GetFrequencySpacing () const
Public Member Functions inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
	ImageRegionConstIteratorWithIndex ()
	ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
	ImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
Self &	operator++ ()
Self &	operator-- ()
Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get () const
const IndexType &	GetIndex () const
const RegionType &	GetRegion () const
void	GoToBegin ()
void	GoToReverseBegin ()
	ImageConstIteratorWithIndex ()=default
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
bool	IsAtEnd () const
bool	IsAtReverseEnd () const
	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
bool	operator< (const Self &it) const
bool	operator<= (const Self &it) const
Self &	operator= (const Self &it)
bool	operator== (const Self &it) const
bool	operator> (const Self &it) const
bool	operator>= (const Self &it) const
bool	Remaining ()
const PixelType &	Value () const
virtual	~ImageConstIteratorWithIndex ()=default
void	SetIndex (const IndexType &ind)

Private Member Functions
void	Init ()

Private Attributes
FrequencyType	m_FrequencyOrigin
FrequencyType	m_FrequencySpacing

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	GetImageDimension ()
Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	ImageDimension = TImage::ImageDimension
Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
const InternalPixelType *	m_Begin { nullptr }
IndexType	m_BeginIndex { { 0 } }
const InternalPixelType *	m_End { nullptr }
IndexType	m_EndIndex { { 0 } }
TImage::ConstWeakPointer	m_Image {}
OffsetValueType	m_OffsetTable [ImageDimension+1] {}
AccessorType	m_PixelAccessor {}
AccessorFunctorType	m_PixelAccessorFunctor {}
const InternalPixelType *	m_Position { nullptr }
IndexType	m_PositionIndex { { 0 } }
RegionType	m_Region {}
bool	m_Remaining { false }

Member Typedef Documentation

AccessorType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::AccessorType = typename TImage::AccessorType

Accessor type that converts data between internal and external representations.

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

FrequencyType

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::FrequencyType = typename ImageType::SpacingType

Definition at line 98 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

FrequencyValueType

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::FrequencyValueType = typename ImageType::SpacingValueType

Definition at line 99 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

ImageType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::ImageType = TImage

Image type alias support

Definition at line 116 of file itkImageConstIteratorWithIndex.h.

IndexType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 105 of file itkImageConstIteratorWithIndex.h.

InternalPixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 125 of file itkImageConstIteratorWithIndex.h.

OffsetType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::OffsetType = typename TImage::OffsetType

Type of the Offset taken from the image

Definition at line 136 of file itkImageConstIteratorWithIndex.h.

PixelContainer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainer = typename TImage::PixelContainer

PixelContainer type alias support Used to refer to the container for the pixel data. While this was already typedef'ed in the superclass, it needs to be redone here for this subclass to compile properly with gcc.

Definition at line 121 of file itkImageConstIteratorWithIndex.h.

PixelContainerPointer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 122 of file itkImageConstIteratorWithIndex.h.

PixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 128 of file itkImageConstIteratorWithIndex.h.

RegionType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 113 of file itkImageConstIteratorWithIndex.h.

Self

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::Self = FrequencyImageRegionConstIteratorWithIndex

Standard class type alias.

Definition at line 83 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

SizeType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 109 of file itkImageConstIteratorWithIndex.h.

Superclass

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::Superclass = ImageRegionConstIteratorWithIndex<TImage>

Definition at line 84 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

Constructor & Destructor Documentation

FrequencyImageRegionConstIteratorWithIndex() [1/3]

template<typename TImage>

itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::FrequencyImageRegionConstIteratorWithIndex ( )

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 101 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

FrequencyImageRegionConstIteratorWithIndex() [2/3]

template<typename TImage>

itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::FrequencyImageRegionConstIteratorWithIndex ( const TImage *  ptr, const RegionType &  region  )

inline

Constructor establishes an iterator to walk a particular image and a particular region of that image.

Definition at line 109 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

FrequencyImageRegionConstIteratorWithIndex() [3/3]

template<typename TImage>

itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::FrequencyImageRegionConstIteratorWithIndex ( const Superclass &  it )

inlineexplicit

Constructor that can be used to cast from an ImageIterator to an ImageRegionIteratorWithIndex. Many routines return an ImageIterator, but for a particular task, you may want an ImageRegionIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionIteratorWithIndex.

Definition at line 121 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

Member Function Documentation

GetFrequency()

template<typename TImage>

FrequencyType itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequency ( ) const

inline

Definition at line 140 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

GetFrequencyBin()

template<typename TImage>

IndexType itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequencyBin ( ) const

inline

Definition at line 131 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

GetFrequencyModuloSquare()

template<typename TImage>

FrequencyValueType itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequencyModuloSquare ( ) const

inline

Definition at line 153 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

GetFrequencyOrigin()

template<typename TImage>

virtual const FrequencyType& itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequencyOrigin ( ) const

virtual

Origin of frequencies is set to be equal to m_Image->GetOrigin().

GetFrequencySpacing()

template<typename TImage>

virtual const FrequencyType& itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequencySpacing ( ) const

virtual

This is the pixel width, or the bin size of the frequency in physical or world coordinates. In this case, frequency spacing is the same than the image spacing.

Init()

template<typename TImage>

void itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::Init ( )

inlineprivate

Set the frequency metadata. Called by constructors.

Definition at line 176 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

Member Data Documentation

m_FrequencyOrigin

template<typename TImage>

FrequencyType itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::m_FrequencyOrigin

private

Definition at line 186 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

m_FrequencySpacing

template<typename TImage>

FrequencyType itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::m_FrequencySpacing

private

Definition at line 187 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

---

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

• itkFrequencyImageRegionConstIteratorWithIndex.h