#include <itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h>

Detailed Description

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

Iterator providing method GetFrequency() to retrieve the frequency associated to an index. This value is related to the specific layout of frequencies from an image in the dual (frequency) space. In this case, the layout corresponds to the output of a FastFourierTransform from FFTW library. This class is a non-const version of FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex.

See also: FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex; 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 64 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

Inheritance diagram for itk::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >:

Collaboration diagram for itk::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< 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 = FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex

using	SizeType = typename TImage::SizeType

using	Superclass = FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage >

Public Types inherited from itk::FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage >
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 = FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex

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

	FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)

	FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)

void	Set (const PixelType &value) const

PixelType &	Value ()

Public Member Functions inherited from itk::FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage >
	FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex ()

	FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex (const Superclass &it)

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

IndexType	GetFrequencyBin () const

FrequencyValueType	GetFrequencyModuloSquare () const

virtual const FrequencyType &	GetFrequencyOrigin () const

virtual const FrequencyType &	GetFrequencySpacing () const

virtual const IndexType &	GetZeroFrequencyIndex () const

FrequencyType	GetFrequency () const

void	SetActualXDimensionIsOdd (bool value)

virtual bool	GetActualXDimensionIsOdd ()

virtual void	ActualXDimensionIsOddOn ()

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)

Protected Member Functions
	FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex (const FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage > &it)

Self &	operator= (const FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage > &it)

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::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::FrequencyType = typename ImageType::SpacingType

Definition at line 84 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyValueType

template<typename TImage >

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

Definition at line 85 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.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::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::Self = FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex

Standard class type alias.

Definition at line 69 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.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::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::Superclass = FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex<TImage>

Definition at line 70 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex() [1/4]

template<typename TImage >

itk::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex ( )

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 87 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex() [2/4]

template<typename TImage >

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

inline

Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes the iterator at the begin of the region.

Definition at line 93 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex() [3/4]

template<typename TImage >

itk::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex ( const ImageIteratorWithIndex< TImage > & it )

inline

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 103 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex() [4/4]

template<typename TImage >

itk::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex ( const FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage > & it )

inlineprotected

The construction from a const iterator is declared protected in order to enforce const correctness.

Definition at line 126 of file itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h.

Member Function Documentation

◆ operator=()

template<typename TImage >

Self& itk::FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex< TImage >::operator= ( const FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex< TImage > & it )