ITK  5.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::FrequencyFFTLayoutImageRegionIteratorWithIndex< TImage > Class Template Reference

#include <itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h>

+ Inheritance diagram for itk::FrequencyFFTLayoutImageRegionIteratorWithIndex< TImage >:
+ Collaboration diagram for itk::FrequencyFFTLayoutImageRegionIteratorWithIndex< 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 = FrequencyFFTLayoutImageRegionIteratorWithIndex
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageRegionIteratorWithIndex< TImage >
 
- Public Types inherited from itk::FrequencyFFTLayoutImageRegionConstIteratorWithIndex< 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 = FrequencyFFTLayoutImageRegionConstIteratorWithIndex
 
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

 FrequencyFFTLayoutImageRegionIteratorWithIndex ()
 
 FrequencyFFTLayoutImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 
 FrequencyFFTLayoutImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::FrequencyFFTLayoutImageRegionConstIteratorWithIndex< TImage >
 FrequencyFFTLayoutImageRegionConstIteratorWithIndex ()
 
 FrequencyFFTLayoutImageRegionConstIteratorWithIndex (const Superclass &it)
 
 FrequencyFFTLayoutImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
IndexType GetFrequencyBin () const
 
FrequencyType GetFrequency () const
 
FrequencyValueType GetFrequencyModuloSquare () const
 
virtual const IndexTypeGetLargestPositiveFrequencyIndex () const
 
virtual const IndexTypeGetMinIndex () const
 
virtual const IndexTypeGetMaxIndex () const
 
virtual const FrequencyTypeGetFrequencyOrigin () const
 
virtual const FrequencyTypeGetFrequencySpacing () const
 
void SetActualXDimensionIsOdd (bool value)
 
virtual bool GetActualXDimensionIsOdd ()
 
virtual void ActualXDimensionIsOddOn ()
 
virtual void ActualXDimensionIsOddOff ()
 
- 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

 FrequencyFFTLayoutImageRegionIteratorWithIndex (const FrequencyFFTLayoutImageRegionConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const FrequencyFFTLayoutImageRegionConstIteratorWithIndex< 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::FrequencyFFTLayoutImageRegionIteratorWithIndex< 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 FrequencyFFTLayoutImageRegionConstIteratorWithIndex.

See also
FrequencyFFTLayoutImageRegionConstIteratorWithIndex
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 63 of file itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

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

◆ FrequencyType

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

◆ FrequencyValueType

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

◆ ImageType

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

◆ IndexType

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

Types inherited from the Superclass

Definition at line 72 of file itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

◆ InternalPixelType

◆ OffsetType

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

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

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

◆ RegionType

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

◆ Self

Standard class type alias.

Definition at line 68 of file itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

◆ SizeType

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

◆ Superclass

Constructor & Destructor Documentation

◆ FrequencyFFTLayoutImageRegionIteratorWithIndex() [1/4]

Default constructor. Needed since we provide a cast constructor.

Definition at line 86 of file itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyFFTLayoutImageRegionIteratorWithIndex() [2/4]

template<typename TImage >
itk::FrequencyFFTLayoutImageRegionIteratorWithIndex< TImage >::FrequencyFFTLayoutImageRegionIteratorWithIndex ( 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 itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyFFTLayoutImageRegionIteratorWithIndex() [3/4]

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 itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

◆ FrequencyFFTLayoutImageRegionIteratorWithIndex() [4/4]

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

Definition at line 125 of file itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

Member Function Documentation

◆ operator=()

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

◆ Set()

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

◆ Value()

template<typename TImage >
PixelType& itk::FrequencyFFTLayoutImageRegionIteratorWithIndex< 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 itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h.

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


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