ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage > Class Template Reference

#include <itkConstNeighborhoodIteratorWithOnlyIndex.h>

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

Public Types

using ConstIterator = typename Superclass::ConstIterator
 
using DimensionValueType = unsigned int
 
using DummyNeighborhoodPixelType = char
 
using ImageType = TImage
 
using IndexType = Index< Self::Dimension >
 
using Iterator = typename Superclass::Iterator
 
using NeighborhoodType = Neighborhood< DummyNeighborhoodPixelType, Self::Dimension >
 
using NeighborIndexType = typename NeighborhoodType::NeighborIndexType
 
using OffsetType = typename Superclass::OffsetType
 
using RadiusType = typename Superclass::RadiusType
 
using RegionType = typename TImage::RegionType
 
using Self = ConstNeighborhoodIteratorWithOnlyIndex
 
using SizeType = typename Superclass::SizeType
 
using Superclass = Neighborhood< DummyNeighborhoodPixelType, Self::Dimension >
 
- Public Types inherited from itk::Neighborhood< char, TImage::ImageDimension >
using AllocatorType = NeighborhoodAllocator< char >
 
using ConstIterator = typename AllocatorType::const_iterator
 
using DimensionValueType = unsigned int
 
using Iterator = typename AllocatorType::iterator
 
using NeighborIndexType = SizeValueType
 
using OffsetType = Offset< VDimension >
 
using PixelType = char
 
using RadiusType = ::itk::Size< VDimension >
 
using Self = Neighborhood
 
using SizeType = ::itk::Size< VDimension >
 
using SizeValueType = typename SizeType::SizeValueType
 
using SliceIteratorType = SliceIterator< char, Self >
 

Public Member Functions

OffsetType ComputeInternalIndex (NeighborIndexType n) const
 
 ConstNeighborhoodIteratorWithOnlyIndex ()
 
 ConstNeighborhoodIteratorWithOnlyIndex (const ConstNeighborhoodIteratorWithOnlyIndex &)
 
 ConstNeighborhoodIteratorWithOnlyIndex (const SizeType &radius, const ImageType *ptr, const RegionType &region)
 
IndexType GetBeginIndex () const
 
IndexType GetBound () const
 
IndexValueType GetBound (NeighborIndexType n) const
 
RegionType GetBoundingBoxAsImageRegion () const
 
const ImageTypeGetImagePointer () const
 
ITK_ITERATOR_VIRTUAL IndexType GetIndex () const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL IndexType GetIndex (const OffsetType &o) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL IndexType GetIndex (NeighborIndexType i) const ITK_ITERATOR_FINAL
 
bool GetNeedToUseBoundaryCondition () const
 
RegionType GetRegion () const
 
ITK_ITERATOR_VIRTUAL void GoToBegin () ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void GoToEnd () ITK_ITERATOR_FINAL
 
bool InBounds () const
 
bool IndexInBounds (const NeighborIndexType n, OffsetType &internalIndex, OffsetType &offset) const
 
ITK_ITERATOR_VIRTUAL void Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL bool IsAtBegin () const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL bool IsAtEnd () const ITK_ITERATOR_FINAL
 
void NeedToUseBoundaryConditionOff ()
 
void NeedToUseBoundaryConditionOn ()
 
bool operator!= (const Self &it) const
 
Selfoperator++ ()
 
Selfoperator+= (const OffsetType &)
 
OffsetType operator- (const Self &b)
 
Selfoperator-- ()
 
Selfoperator-= (const OffsetType &)
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
Selfoperator= (const Self &orig)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
void PrintSelf (std::ostream &, Indent) const override
 
void SetLocation (const IndexType &position)
 
void SetNeedToUseBoundaryCondition (bool b)
 
 ~ConstNeighborhoodIteratorWithOnlyIndex () override=default
 
- Public Member Functions inherited from itk::Neighborhood< char, TImage::ImageDimension >
 itkTypeMacroNoParent (Neighborhood)
 
 Neighborhood ()
 
 Neighborhood (const Self &other)
 
 Neighborhood (Self &&)=default
 
virtual ~Neighborhood ()=default
 
Selfoperator= (const Self &other)
 
Selfoperator= (Self &&)=default
 
bool operator== (const Self &other) const
 
bool operator!= (const Self &other) const
 
const SizeType GetRadius () const
 
SizeValueType GetRadius (DimensionValueType n) const
 
SizeValueType GetSize (DimensionValueType n) const
 
SizeType GetSize () const
 
OffsetValueType GetStride (DimensionValueType axis) const
 
Iterator End ()
 
ConstIterator End () const
 
Iterator Begin ()
 
ConstIterator Begin () const
 
NeighborIndexType Size () const
 
char & operator[] (NeighborIndexType i)
 
const char & operator[] (NeighborIndexType i) const
 
char & operator[] (const OffsetType &o)
 
const char & operator[] (const OffsetType &o) const
 
char & GetElement (NeighborIndexType i)
 
char GetCenterValue () const
 
void SetRadius (const SizeType &)
 
void SetRadius (const SizeValueType *rad)
 
void SetRadius (const SizeValueType)
 
void Print (std::ostream &os) const
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 
OffsetType GetOffset (NeighborIndexType i) const
 
virtual NeighborIndexType GetNeighborhoodIndex (const OffsetType &) const
 
NeighborIndexType GetCenterNeighborhoodIndex () const
 
std::slice GetSlice (unsigned int) const
 

Static Public Attributes

static constexpr DimensionValueType Dimension = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::Neighborhood< char, TImage::ImageDimension >
static constexpr unsigned int NeighborhoodDimension
 

Protected Member Functions

ITK_ITERATOR_VIRTUAL void SetBeginIndex (const IndexType &start) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetBound (const SizeType &) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetEndIndex () ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetLoop (const IndexType &p) ITK_ITERATOR_FINAL
 
- Protected Member Functions inherited from itk::Neighborhood< char, TImage::ImageDimension >
void SetSize ()
 
virtual void Allocate (NeighborIndexType i)
 
virtual void ComputeNeighborhoodStrideTable ()
 
virtual void ComputeNeighborhoodOffsetTable ()
 

Protected Attributes

IndexType m_BeginIndex
 
IndexType m_Bound
 
ImageType::ConstPointer m_ConstImage
 
IndexType m_EndIndex
 
bool m_InBounds [Dimension]
 
IndexType m_InnerBoundsHigh
 
IndexType m_InnerBoundsLow
 
bool m_IsInBounds
 
bool m_IsInBoundsValid
 
IndexType m_Loop
 
bool m_NeedToUseBoundaryCondition
 
RegionType m_Region
 

Detailed Description

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

Index-only version of ConstNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of indices across an itk::Image or itk::ImageBase.

ConstNeighborhoodIteratorWithOnlyIndex implements the index-only methods of NeighborhoodIterator. No image data is accessed, so this iterator can be used with type itk::ImageBase. It serves as a base class from which other iterators can be derived. See NeighborhoodIterator for more complete information.

The parent class itk::Neighborhood is declared with 'char' as its first template parameter, because the pixel type is not used in this class.

Other index-only iterators:

See also
ImageConstIteratorWithOnlyIndex
ConstNeighborhoodIteratorWithOnlyIndex

Other iterators:

See also
ImageIterator
NeighborhoodIterator
Neighborhood

Definition at line 60 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstIterator = typename Superclass::ConstIterator

Definition at line 80 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ DimensionValueType

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DimensionValueType = unsigned int

Type used to refer to space dimensions

Definition at line 64 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ DummyNeighborhoodPixelType

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DummyNeighborhoodPixelType = char

Definition at line 69 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ ImageType

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ImageType = TImage

Typedef support for common objects

Definition at line 83 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ IndexType

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexType = Index<Self::Dimension>

Definition at line 85 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ Iterator

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Iterator = typename Superclass::Iterator

Definition at line 79 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ NeighborhoodType

Definition at line 86 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ NeighborIndexType

Type used to refer to the elements in the list of neighbor pixels.

Definition at line 89 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ OffsetType

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

Inherit type alias from superclass

Definition at line 76 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ RadiusType

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::RadiusType = typename Superclass::RadiusType

Definition at line 77 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ RegionType

template<typename TImage>
using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::RegionType = typename TImage::RegionType

Definition at line 84 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ Self

Standard class type aliases.

Definition at line 72 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ SizeType

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

Definition at line 78 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ Superclass

Definition at line 73 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

◆ ConstNeighborhoodIteratorWithOnlyIndex() [1/3]

Default constructor

◆ ~ConstNeighborhoodIteratorWithOnlyIndex()

template<typename TImage>
itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::~ConstNeighborhoodIteratorWithOnlyIndex ( )
overridedefault

Virtual destructor

◆ ConstNeighborhoodIteratorWithOnlyIndex() [2/3]

Copy constructor

◆ ConstNeighborhoodIteratorWithOnlyIndex() [3/3]

template<typename TImage>
itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstNeighborhoodIteratorWithOnlyIndex ( const SizeType radius,
const ImageType ptr,
const RegionType region 
)

Constructor which establishes the region size, neighborhood, and image over which to walk.

Member Function Documentation

◆ ComputeInternalIndex()

template<typename TImage>
OffsetType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ComputeInternalIndex ( NeighborIndexType  n) const

Computes the internal, N-d offset of a pixel array position n from (0,0, ..., 0) in the "upper-left" corner of the neighborhood.

◆ GetBeginIndex()

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBeginIndex ( ) const
inline

Returns the N-dimensional starting index of the iterator's position on the image.

Definition at line 173 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetBound() [1/2]

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBound ( ) const
inline

Returns the array of upper loop bounds used during iteration.

Definition at line 119 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetBound() [2/2]

template<typename TImage>
IndexValueType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBound ( NeighborIndexType  n) const
inline

Returns the loop bound used to define the edge of a single dimension in the itk::Image region.

Definition at line 127 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetBoundingBoxAsImageRegion()

template<typename TImage>
RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBoundingBoxAsImageRegion ( ) const

Returns a bounding box for the region spanned by this neighborhood represented by an itk::ImageRegion

◆ GetImagePointer()

template<typename TImage>
const ImageType* itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetImagePointer ( ) const
inline

Returns a smartpointer to the image on which this iterator operates.

Definition at line 134 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetIndex() [1/3]

template<typename TImage>
ITK_ITERATOR_VIRTUAL IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex ( ) const
inline

Returns the N-dimensional index of the iterator's position in the image.

Definition at line 142 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator!=().

◆ GetIndex() [2/3]

template<typename TImage>
ITK_ITERATOR_VIRTUAL IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex ( const OffsetType o) const
inline

Returns the image index for neighbor pixel at offset o from the center of the neighborhood.

Definition at line 150 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetIndex() [3/3]

template<typename TImage>
ITK_ITERATOR_VIRTUAL IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex ( NeighborIndexType  i) const
inline

Returns the image index for neighbor pixel at index i in the neighborhood.

Definition at line 158 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetNeedToUseBoundaryCondition()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetNeedToUseBoundaryCondition ( ) const
inline

Definition at line 343 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetRegion()

template<typename TImage>
RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetRegion ( ) const
inline

Returns the region of iteration.

Definition at line 165 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GoToBegin()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GoToBegin ( )

Method for rewinding the iterator to its beginning image index.

◆ GoToEnd()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GoToEnd ( )

Method for sending the iterator to one past the last index in its region.

◆ InBounds()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::InBounds ( ) const

Returns false if the iterator overlaps region boundaries, true otherwise. Also updates an internal boolean array indicating which of the iterator's faces are out of bounds.

◆ IndexInBounds()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexInBounds ( const NeighborIndexType  n,
OffsetType internalIndex,
OffsetType offset 
) const

Returns true if the neighborhood index is within region boundaries, false otherwise. If false, then internalIndex and offset are calculated. Otherwise their values are left unchanged. Also updates an internal boolean array indicating which of the iterator's faces are out of bounds.

Parameters
n- linear neighborhood index.
internalIndex- calculated for index n only when the neighborhood is not completely within region boundaries.
offset- per-dimension offsets for index n to nearest boundary index, calculate only when the neighborhood is not completely within region boundaries.

◆ Initialize()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Initialize ( const SizeType radius,
const ImageType ptr,
const RegionType region 
)

Initializes the iterator to walk a particular image and a particular region of that image.

◆ IsAtBegin()

template<typename TImage>
ITK_ITERATOR_VIRTUAL bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IsAtBegin ( ) const
inline

Virtual method for determining whether the iterator is at the beginning of its iteration region.

Definition at line 200 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ IsAtEnd()

template<typename TImage>
ITK_ITERATOR_VIRTUAL bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IsAtEnd ( ) const

Virtual method for determining whether the iterator has reached the end of its iteration region.

◆ NeedToUseBoundaryConditionOff()

template<typename TImage>
void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeedToUseBoundaryConditionOff ( )
inline

Definition at line 331 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ NeedToUseBoundaryConditionOn()

template<typename TImage>
void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeedToUseBoundaryConditionOn ( )
inline

Definition at line 325 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ operator!=()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator!= ( const Self it) const
inline

Returns a boolean != comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored.

Definition at line 237 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

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

◆ operator++()

template<typename TImage>
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator++ ( )

Increments the pointers in the ConstNeighborhoodIteratorWithOnlyIndex, wraps across boundaries automatically, accounting for the disparity in the buffer size and the region size of the image.

◆ operator+=()

template<typename TImage>
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator+= ( const OffsetType )

Addition of an itk::Offset. Note that this method does not do any bounds checking. Adding an offset that moves the iterator out of its assigned region will produce undefined results.

◆ operator-()

template<typename TImage>
OffsetType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator- ( const Self b)
inline

Distance between two iterators

Definition at line 298 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Loop.

◆ operator--()

template<typename TImage>
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-- ( )

Decrements the pointers in the ConstNeighborhoodIteratorWithOnlyIndex, wraps across boundaries automatically, accounting for the disparity in the buffer size and the region size of the image.

◆ operator-=()

template<typename TImage>
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-= ( const OffsetType )

Subtraction of an itk::Offset. Note that this method does not do any bounds checking. Subtracting an offset that moves the iterator out of its assigned region will produce undefined results.

◆ operator<()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator< ( const Self it) const

Returns a boolean < comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

◆ operator<=()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator<= ( const Self it) const

Returns a boolean <= comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

◆ operator=()

template<typename TImage>
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator= ( const Self orig)

Assignment operator

◆ operator==()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator== ( const Self it) const
inline

Returns a boolean == comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored.

Definition at line 228 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ operator>()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator> ( const Self it) const

Returns a boolean > comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

◆ operator>=()

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator>= ( const Self it) const

Returns a boolean >= comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

◆ PrintSelf()

template<typename TImage>
void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::PrintSelf ( std::ostream &  ,
Indent   
) const
overridevirtual

Standard itk print method

Reimplemented from itk::Neighborhood< char, TImage::ImageDimension >.

◆ SetBeginIndex()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetBeginIndex ( const IndexType start)
inlineprotected

Default method for setting the first index of the iteration region.

Definition at line 367 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ SetBound()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetBound ( const SizeType )
protected

Virtual method for setting internal loop boundaries. This method must be defined in each subclass because each subclass may handle loop boundaries differently.

◆ SetEndIndex()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetEndIndex ( )
protected

Default method for setting the last index of the iteration region.

◆ SetLocation()

template<typename TImage>
void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLocation ( const IndexType position)
inline

This method positions the iterator at an indexed location in the image. SetLocation should NOT be used to update the position of the iterator during iteration, only for initializing it to a position prior to iteration. This method is not optimized for speed.

Definition at line 279 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ SetLoop()

template<typename TImage>
ITK_ITERATOR_VIRTUAL void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLoop ( const IndexType p)
inlineprotected

Default method for setting the coordinate location of the iterator. Loop indices correspond to the actual Image region index.

Definition at line 352 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ SetNeedToUseBoundaryCondition()

template<typename TImage>
void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetNeedToUseBoundaryCondition ( bool  b)
inline

Definition at line 337 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Member Data Documentation

◆ Dimension

template<typename TImage>
constexpr DimensionValueType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Dimension = TImage::ImageDimension
staticconstexpr

Save the image dimension.

Definition at line 67 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_BeginIndex

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_BeginIndex
protected

The starting index for iteration within the itk::Image region on which this ConstNeighborhoodIteratorWithOnlyIndex is defined.

Definition at line 379 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_Bound

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Bound
protected

An array of upper looping boundaries used during iteration.

Definition at line 382 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_ConstImage

template<typename TImage>
ImageType::ConstPointer itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_ConstImage
protected

The image on which iteration is defined.

Definition at line 385 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_EndIndex

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_EndIndex
protected

The end index for iteration within the itk::Image region on which this ConstNeighborhoodIteratorWithOnlyIndex is defined.

Definition at line 389 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_InBounds

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_InBounds[Dimension]
mutableprotected

Denotes which of the iterators dimensional sides spill outside region of interest boundaries.

Definition at line 399 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_InnerBoundsHigh

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_InnerBoundsHigh
protected

Upper threshold of in-bounds loop counter values.

Definition at line 413 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_InnerBoundsLow

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_InnerBoundsLow
protected

Lower threshold of in-bounds loop counter values.

Definition at line 410 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_IsInBounds

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_IsInBounds
mutableprotected

Denotes if iterator is entirely within bounds

Definition at line 402 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_IsInBoundsValid

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_IsInBoundsValid
mutableprotected

Is the m_InBounds and m_IsInBounds variables up to date? Set to false whenever the iterator is repositioned. Set to true within InBounds().

Definition at line 407 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_Loop

template<typename TImage>
IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Loop
protected

Array of loop counters used during iteration.

Definition at line 392 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-().

◆ m_NeedToUseBoundaryCondition

template<typename TImage>
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_NeedToUseBoundaryCondition
protected

Does the specified region need to worry about boundary conditions?

Definition at line 416 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ m_Region

template<typename TImage>
RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Region
protected

The region over which iteration is defined.

Definition at line 395 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.


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