ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::FrequencyImageRegionIteratorWithIndex< TImage > Class Template Reference

#include <itkFrequencyImageRegionIteratorWithIndex.h>

+ Inheritance diagram for itk::FrequencyImageRegionIteratorWithIndex< TImage >:
+ Collaboration diagram for itk::FrequencyImageRegionIteratorWithIndex< TImage >:

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 = FrequencyImageRegionIteratorWithIndex
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageRegionIteratorWithIndex< TImage >
 
- Public Types inherited from itk::FrequencyImageRegionConstIteratorWithIndex< TImage >
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

 FrequencyImageRegionIteratorWithIndex ()
 
 FrequencyImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 
 FrequencyImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::FrequencyImageRegionConstIteratorWithIndex< TImage >
 FrequencyImageRegionConstIteratorWithIndex ()
 
 FrequencyImageRegionConstIteratorWithIndex (const Superclass &it)
 
 FrequencyImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
FrequencyType GetFrequency () const
 
IndexType GetFrequencyBin () const
 
FrequencyValueType GetFrequencyModuloSquare () const
 
virtual const FrequencyTypeGetFrequencyOrigin () const
 
virtual const FrequencyTypeGetFrequencySpacing () const
 
- Public Member Functions inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
 ImageRegionConstIteratorWithIndex ()
 
 ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
 ImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () const
 
 ImageConstIteratorWithIndex ()
 
 ImageConstIteratorWithIndex (const Self &it)
 
 ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
bool operator!= (const Self &it) const
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
virtual ~ImageConstIteratorWithIndex ()=default
 
void SetIndex (const IndexType &ind)
 
PixelType Get () const
 
const PixelTypeValue () const
 
void GoToBegin ()
 
void GoToReverseBegin ()
 
bool IsAtReverseEnd () const
 
bool IsAtEnd () const
 
bool Remaining ()
 

Protected Member Functions

 FrequencyImageRegionIteratorWithIndex (const FrequencyImageRegionConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const FrequencyImageRegionConstIteratorWithIndex< TImage > &it)
 

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 >
TImage::ConstWeakPointer m_Image
 
IndexType m_PositionIndex
 
IndexType m_BeginIndex
 
IndexType m_EndIndex
 
RegionType m_Region
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
const InternalPixelTypem_Position
 
const InternalPixelTypem_Begin
 
const InternalPixelTypem_End
 
bool m_Remaining
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

Detailed Description

template<typename TImage>
class itk::FrequencyImageRegionIteratorWithIndex< 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 FrequencyImageRegionConstIteratorWithIndex.

See also
FrequencyImageRegionConstIteratorWithIndex
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 itkFrequencyImageRegionIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 81 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ FrequencyType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::FrequencyType = typename ImageType::SpacingType

Definition at line 83 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ FrequencyValueType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::FrequencyValueType = typename ImageType::SpacingValueType

Definition at line 84 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ ImageType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::ImageType = typename Superclass::ImageType

Definition at line 76 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ IndexType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::IndexType = typename Superclass::IndexType

Types inherited from the Superclass

Definition at line 72 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ InternalPixelType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 79 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ OffsetType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 74 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ PixelContainer

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 77 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ PixelContainerPointer

Definition at line 78 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ PixelType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::PixelType = typename Superclass::PixelType

Definition at line 80 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ RegionType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::RegionType = typename Superclass::RegionType

Definition at line 75 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ Self

Standard class type alias.

Definition at line 68 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ SizeType

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::SizeType = typename Superclass::SizeType

Definition at line 73 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ Superclass

template<typename TImage >
using itk::FrequencyImageRegionIteratorWithIndex< TImage >::Superclass = ImageRegionIteratorWithIndex<TImage>

Definition at line 69 of file itkFrequencyImageRegionIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ FrequencyImageRegionIteratorWithIndex() [1/4]

Default constructor. Needed since we provide a cast constructor.

Definition at line 86 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ FrequencyImageRegionIteratorWithIndex() [2/4]

template<typename TImage >
itk::FrequencyImageRegionIteratorWithIndex< TImage >::FrequencyImageRegionIteratorWithIndex ( 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 92 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ FrequencyImageRegionIteratorWithIndex() [3/4]

template<typename TImage >
itk::FrequencyImageRegionIteratorWithIndex< TImage >::FrequencyImageRegionIteratorWithIndex ( 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 102 of file itkFrequencyImageRegionIteratorWithIndex.h.

◆ FrequencyImageRegionIteratorWithIndex() [4/4]

template<typename TImage >
itk::FrequencyImageRegionIteratorWithIndex< TImage >::FrequencyImageRegionIteratorWithIndex ( const FrequencyImageRegionConstIteratorWithIndex< TImage > &  it)
inlineprotected

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

Definition at line 125 of file itkFrequencyImageRegionIteratorWithIndex.h.

Member Function Documentation

◆ operator=()

template<typename TImage >
Self& itk::FrequencyImageRegionIteratorWithIndex< TImage >::operator= ( const FrequencyImageRegionConstIteratorWithIndex< TImage > &  it)
inlineprotected

◆ Set()

template<typename TImage >
void itk::FrequencyImageRegionIteratorWithIndex< TImage >::Set ( const PixelType value) const
inline

◆ Value()

template<typename TImage >
PixelType& itk::FrequencyImageRegionIteratorWithIndex< TImage >::Value ( )
inline

Return a reference to the pixel. This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 117 of file itkFrequencyImageRegionIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.


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