#include <itkFrequencyImageRegionConstIteratorWithIndex.h>

Inheritance diagram for itk::FrequencyImageRegionConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::FrequencyImageRegionConstIteratorWithIndex< TImage >:

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 75 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

Public Types
using	AccessorType = typename Superclass::AccessorType

using	FrequencyType = typename ImageType::SpacingType

using	FrequencyValueType = typename ImageType::SpacingValueType

using	ImageType = typename Superclass::ImageType

using	IndexType = typename Superclass::IndexType

using	InternalPixelType = typename Superclass::InternalPixelType

using	OffsetType = typename Superclass::OffsetType

using	PixelContainer = typename Superclass::PixelContainer

using	PixelContainerPointer = typename Superclass::PixelContainerPointer

using	PixelType = typename Superclass::PixelType

using	RegionType = typename Superclass::RegionType

using	Self = FrequencyImageRegionConstIteratorWithIndex

using	SizeType = typename Superclass::SizeType

using	Superclass = ImageRegionConstIteratorWithIndex< TImage >

Public Types inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
using	AccessorType = typename Superclass::AccessorType

using	ImageType = typename Superclass::ImageType

using	IndexType = typename Superclass::IndexType

using	InternalPixelType = typename Superclass::InternalPixelType

using	OffsetType = typename Superclass::OffsetType

using	PixelContainer = typename Superclass::PixelContainer

using	PixelContainerPointer = typename Superclass::PixelContainerPointer

using	PixelType = typename Superclass::PixelType

using	RegionType = typename Superclass::RegionType

using	Self = ImageRegionConstIteratorWithIndex

using	SizeType = typename Superclass::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 TImage *ptr, const RegionType &region)

	FrequencyImageRegionConstIteratorWithIndex (const Superclass &it)

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 TImage *ptr, const RegionType &region)

	ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

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

	ImageConstIteratorWithIndex (const Self &it)

	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)

bool	IsAtEnd () const

bool	IsAtReverseEnd () const

bool	operator!= (const Self &it) const

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

IndexType	m_BeginIndex

const InternalPixelType *	m_End

IndexType	m_EndIndex

TImage::ConstWeakPointer	m_Image

OffsetValueType	m_OffsetTable [ImageDimension+1]

AccessorType	m_PixelAccessor

AccessorFunctorType	m_PixelAccessorFunctor

const InternalPixelType *	m_Position

IndexType	m_PositionIndex

RegionType	m_Region

bool	m_Remaining

Member Typedef Documentation

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 93 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 95 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 96 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::ImageType = typename Superclass::ImageType

Definition at line 88 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::IndexType = typename Superclass::IndexType

Types inherited from the Superclass

Definition at line 84 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 91 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 86 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 89 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 90 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::PixelType = typename Superclass::PixelType

Definition at line 92 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::RegionType = typename Superclass::RegionType

Definition at line 87 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

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

Standard class type alias.

Definition at line 80 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

using itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::SizeType = typename Superclass::SizeType

Definition at line 85 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 81 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage>

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

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 98 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::Init().

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 106 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::Init().

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 118 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::Init().

Member Function Documentation

template<typename TImage>

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

inline

Definition at line 135 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequencyBin(), itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::m_FrequencyOrigin, and itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::m_FrequencySpacing.

Referenced by itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequencyModuloSquare().

template<typename TImage>

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

inline

Definition at line 127 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::GetIndex().

Referenced by itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequency().

template<typename TImage>

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

inline

Definition at line 148 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::GetFrequency().

template<typename TImage>

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

virtual

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

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.

template<typename TImage>

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

inlineprivate

Set the frequency metadata. Called by constructors.

Definition at line 170 of file itkFrequencyImageRegionConstIteratorWithIndex.h.

References itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::m_FrequencyOrigin, itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::m_FrequencySpacing, and itk::ImageConstIteratorWithIndex< TImage >::m_Image.

Referenced by itk::FrequencyImageRegionConstIteratorWithIndex< TImage >::FrequencyImageRegionConstIteratorWithIndex().