ITK  5.1.0
Insight Toolkit
Classes | Public Types | Static Public Attributes | List of all members
itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference

#include <itkConstShapedNeighborhoodIterator.h>

+ Inheritance diagram for itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >:
+ Collaboration diagram for itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >:

Classes

struct  ConstIterator
 

Public Types

using BoundaryConditionType = TBoundaryCondition
 
using ImageBoundaryConditionPointerType = ImageBoundaryCondition< ImageType > *
 
using ImageType = TImage
 
using IndexListConstIterator = typename IndexListType::const_iterator
 
using IndexListIterator = typename IndexListType::iterator
 
using IndexListType = std::list< NeighborIndexType >
 
using IndexType = Index< Self::Dimension >
 
using IndexValueType = typename IndexType::IndexValueType
 
using InternalPixelType = typename TImage::InternalPixelType
 
using NeighborhoodType = Neighborhood< PixelType, Self::Dimension >
 
using NeighborIndexType = typename NeighborhoodType::NeighborIndexType
 
using OffsetType = typename Superclass::OffsetType
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelType = typename TImage::PixelType
 
using RadiusType = typename Superclass::RadiusType
 
using RegionType = typename TImage::RegionType
 
using Self = ConstShapedNeighborhoodIterator
 
using SizeType = typename Superclass::SizeType
 
using SizeValueType = typename SizeType::SizeValueType
 
using Superclass = NeighborhoodIterator< TImage, TBoundaryCondition >
 

Static Public Attributes

static constexpr unsigned int Dimension = TImage::ImageDimension
 
struct ConstIterator
 
bool m_CenterIsActive { false }
 
IndexListType m_ActiveIndexList
 
ConstIterator Begin () const
 
ConstIterator End () const
 
 ConstShapedNeighborhoodIterator ()=default
 
 ~ConstShapedNeighborhoodIterator () override=default
 
 ConstShapedNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
 
Selfoperator= (const Self &orig)
 
void PrintSelf (std::ostream &, Indent) const override
 
ITK_ITERATOR_VIRTUAL void ActivateOffset (const OffsetType &off) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void DeactivateOffset (const OffsetType &off) ITK_ITERATOR_FINAL
 
template<typename TOffsets >
void ActivateOffsets (const TOffsets &offsets)
 
ITK_ITERATOR_VIRTUAL void ClearActiveList () ITK_ITERATOR_FINAL
 
const IndexListTypeGetActiveIndexList () const
 
IndexListType::size_type GetActiveIndexListSize () const
 
void CreateActiveListFromNeighborhood (const NeighborhoodType &)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
Selfoperator+= (const OffsetType &)
 
Selfoperator-= (const OffsetType &)
 
const SizeType GetRadius () const
 
SizeValueType GetRadius (DimensionValueType n) const
 
virtual NeighborIndexType GetNeighborhoodIndex (const OffsetType &) const
 
NeighborIndexType GetCenterNeighborhoodIndex () const
 
OffsetType GetOffset (NeighborIndexType i) const
 
bool operator== (const Self &other) const
 
bool operator!= (const Self &other) const
 
TPixel & GetElement (NeighborIndexType i)
 
void Print (std::ostream &os) const
 
ITK_ITERATOR_VIRTUAL void ActivateIndex (NeighborIndexType) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void DeactivateIndex (NeighborIndexType) ITK_ITERATOR_FINAL
 
 ConstShapedNeighborhoodIterator (const ConstShapedNeighborhoodIterator &)=delete
 

Additional Inherited Members

- Private Types inherited from itk::NeighborhoodIterator< TImage, TBoundaryCondition >
using ConstIterator = typename Superclass::ConstIterator
 
using ImageBoundaryConditionPointerType = typename Superclass::ImageBoundaryConditionPointerType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using Iterator = typename Superclass::Iterator
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using OffsetType = typename Superclass::OffsetType
 
using PixelType = typename Superclass::PixelType
 
using RadiusType = typename Superclass::RadiusType
 
using RegionType = typename Superclass::RegionType
 
using Self = NeighborhoodIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ConstNeighborhoodIterator< TImage, TBoundaryCondition >
 
- Private Types inherited from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >
using BoundaryConditionType = TBoundaryCondition
 
using ConstIterator = typename Superclass::ConstIterator
 
using DimensionValueType = unsigned int
 
using ImageBoundaryConditionConstPointerType = const ImageBoundaryCondition< ImageType, OutputImageType > *
 
using ImageBoundaryConditionPointerType = ImageBoundaryCondition< ImageType, OutputImageType > *
 
using ImageType = TImage
 
using IndexType = Index< Self::Dimension >
 
using InternalPixelType = typename TImage::InternalPixelType
 
using Iterator = typename Superclass::Iterator
 
using NeighborhoodAccessorFunctorType = typename ImageType::NeighborhoodAccessorFunctorType
 
using NeighborhoodType = Neighborhood< PixelType, Self::Dimension >
 
using NeighborIndexType = typename NeighborhoodType::NeighborIndexType
 
using OffsetType = typename Superclass::OffsetType
 
using OutputImageType = typename BoundaryConditionType::OutputImageType
 
using PixelType = typename TImage::PixelType
 
using RadiusType = typename Superclass::RadiusType
 
using RegionType = typename TImage::RegionType
 
using Self = ConstNeighborhoodIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = Neighborhood< InternalPixelType *, Self::Dimension >
 
- Private Types inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
using AllocatorType = NeighborhoodAllocator< TImage::InternalPixelType * >
 
using ConstIterator = typename AllocatorType::const_iterator
 
using DimensionValueType = unsigned int
 
using Iterator = typename AllocatorType::iterator
 
using NeighborIndexType = SizeValueType
 
using OffsetType = Offset< VDimension >
 
using PixelType = TImage::InternalPixelType *
 
using RadiusType = ::itk::Size< VDimension >
 
using Self = Neighborhood
 
using SizeType = ::itk::Size< VDimension >
 
using SizeValueType = typename SizeType::SizeValueType
 
using SliceIteratorType = SliceIterator< TImage::InternalPixelType *, Self >
 
- Private Member Functions inherited from itk::NeighborhoodIterator< TImage, TBoundaryCondition >
 NeighborhoodIterator ()
 
 NeighborhoodIterator (const NeighborhoodIterator &n)
 
Selfoperator= (const Self &orig)
 
 NeighborhoodIterator (const SizeType &radius, ImageType *ptr, const RegionType &region)
 
void PrintSelf (std::ostream &, Indent) const
 
InternalPixelTypeGetCenterPointer ()
 
ITK_ITERATOR_VIRTUAL void SetCenterPixel (const PixelType &p) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetNeighborhood (const NeighborhoodType &) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetPixel (const unsigned i, const PixelType &v, bool &status) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetPixel (const unsigned i, const PixelType &v) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetPixel (const OffsetType o, const PixelType &v) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetNext (const unsigned axis, const unsigned i, const PixelType &v) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetNext (const unsigned axis, const PixelType &v) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetPrevious (const unsigned axis, const unsigned i, const PixelType &v) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetPrevious (const unsigned axis, const PixelType &v) ITK_ITERATOR_FINAL
 
- Private Member Functions inherited from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >
 ConstNeighborhoodIterator ()
 
 ConstNeighborhoodIterator (const ConstNeighborhoodIterator &)
 
 ~ConstNeighborhoodIterator () override=default
 
 ConstNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
 
Selfoperator= (const Self &orig)
 
OffsetType ComputeInternalIndex (const NeighborIndexType n) const
 
IndexType GetBound () const
 
IndexValueType GetBound (NeighborIndexType n) const
 
const InternalPixelTypeGetCenterPointer () const
 
PixelType GetCenterPixel () const
 
const ImageTypeGetImagePointer () const
 
ITK_ITERATOR_VIRTUAL IndexType GetIndex () const ITK_ITERATOR_FINAL
 
IndexType GetFastIndexPlusOffset (const OffsetType &o) const
 
ITK_ITERATOR_VIRTUAL NeighborhoodType GetNeighborhood () const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetPixel (const NeighborIndexType i) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetPixel (NeighborIndexType i, bool &IsInBounds) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetPixel (const OffsetType &o) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetPixel (const OffsetType &o, bool &IsInBounds) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetNext (const unsigned axis, NeighborIndexType i) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetNext (const unsigned axis) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetPrevious (const unsigned axis, NeighborIndexType i) const ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL PixelType GetPrevious (const unsigned axis) 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
 
RegionType GetRegion () const
 
IndexType GetBeginIndex () const
 
RegionType GetBoundingBoxAsImageRegion () const
 
OffsetType GetWrapOffset () const
 
OffsetValueType GetWrapOffset (NeighborIndexType n) const
 
ITK_ITERATOR_VIRTUAL void GoToBegin () ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void GoToEnd () ITK_ITERATOR_FINAL
 
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
 
Selfoperator++ ()
 
Selfoperator-- ()
 
bool operator== (const Self &it) const
 
bool operator!= (const Self &it) const
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
void SetLocation (const IndexType &position)
 
Selfoperator+= (const OffsetType &)
 
Selfoperator-= (const OffsetType &)
 
OffsetType operator- (const Self &b)
 
bool InBounds () const
 
bool IndexInBounds (const NeighborIndexType n, OffsetType &internalIndex, OffsetType &offset) const
 
bool IndexInBounds (const NeighborIndexType n) const
 
ITK_ITERATOR_VIRTUAL void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void ResetBoundaryCondition () ITK_ITERATOR_FINAL
 
void SetBoundaryCondition (const TBoundaryCondition &c)
 
ImageBoundaryConditionPointerType GetBoundaryCondition () const
 
void NeedToUseBoundaryConditionOn ()
 
void NeedToUseBoundaryConditionOff ()
 
void SetNeedToUseBoundaryCondition (bool b)
 
bool GetNeedToUseBoundaryCondition () const
 
ITK_ITERATOR_VIRTUAL void SetRegion (const RegionType &region) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetLoop (const IndexType &p) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetBound (const SizeType &) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetPixelPointers (const IndexType &) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetBeginIndex (const IndexType &start) ITK_ITERATOR_FINAL
 
ITK_ITERATOR_VIRTUAL void SetEndIndex () ITK_ITERATOR_FINAL
 
- Private Member Functions inherited from itk::Neighborhood< TImage::InternalPixelType *, 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
 
TImage::InternalPixelType * & operator[] (NeighborIndexType i)
 
const TImage::InternalPixelType * & operator[] (NeighborIndexType i) const
 
TImage::InternalPixelType * & operator[] (const OffsetType &o)
 
const TImage::InternalPixelType * & operator[] (const OffsetType &o) const
 
TImage::InternalPixelType * & GetElement (NeighborIndexType i)
 
TImage::InternalPixelType * 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
 
void SetSize ()
 
virtual void Allocate (NeighborIndexType i)
 
virtual void ComputeNeighborhoodStrideTable ()
 
virtual void ComputeNeighborhoodOffsetTable ()
 
- Private Attributes inherited from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >
IndexType m_BeginIndex
 
IndexType m_Bound
 
const InternalPixelTypem_Begin
 
ImageType::ConstWeakPointer m_ConstImage
 
const InternalPixelTypem_End
 
IndexType m_EndIndex
 
IndexType m_Loop
 
RegionType m_Region
 
OffsetType m_WrapOffset
 
ImageBoundaryConditionPointerType m_BoundaryCondition
 
bool m_InBounds [Dimension]
 
bool m_IsInBounds { false }
 
bool m_IsInBoundsValid { false }
 
IndexType m_InnerBoundsLow
 
IndexType m_InnerBoundsHigh
 
TBoundaryCondition m_InternalBoundaryCondition
 
bool m_NeedToUseBoundaryCondition { false }
 
NeighborhoodAccessorFunctorType m_NeighborhoodAccessorFunctor
 
- Static Private Attributes inherited from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >
static constexpr DimensionValueType Dimension = TImage::ImageDimension
 
- Static Private Attributes inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
static constexpr unsigned int NeighborhoodDimension
 

Detailed Description

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
class itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >

Const version of ShapedNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image.

ConstShapedNeighborhoodIterator implements the read-only methods of ShapedNeighborhoodIterator. A "shaped" neighborhood iterator is one that allows you to specify which neighbor elements are active and which are inactive. See ShapedNeighborhoodIterator for more information.

See also
Neighborhood
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
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
Examples
Examples/Iterators/ShapedNeighborhoodIterators1.cxx, and Examples/Iterators/ShapedNeighborhoodIterators2.cxx.

Definition at line 71 of file itkConstShapedNeighborhoodIterator.h.

Member Typedef Documentation

◆ BoundaryConditionType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType = TBoundaryCondition

Typedef for boundary condition type.

Definition at line 109 of file itkConstShapedNeighborhoodIterator.h.

◆ ImageBoundaryConditionPointerType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType = ImageBoundaryCondition<ImageType> *

Typedef for generic boundary condition pointer

Definition at line 112 of file itkConstShapedNeighborhoodIterator.h.

◆ ImageType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType = TImage

Typedef support for common objects

Definition at line 93 of file itkConstShapedNeighborhoodIterator.h.

◆ IndexListConstIterator

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListConstIterator = typename IndexListType::const_iterator

Definition at line 106 of file itkConstShapedNeighborhoodIterator.h.

◆ IndexListIterator

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListIterator = typename IndexListType::iterator

Definition at line 105 of file itkConstShapedNeighborhoodIterator.h.

◆ IndexListType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListType = std::list<NeighborIndexType>

An stl storage container type that can be sorted. The type used for the list of active offsets in the neighborhood.

Definition at line 103 of file itkConstShapedNeighborhoodIterator.h.

◆ IndexType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType = Index<Self::Dimension>

Definition at line 95 of file itkConstShapedNeighborhoodIterator.h.

◆ IndexValueType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexValueType = typename IndexType::IndexValueType

Definition at line 96 of file itkConstShapedNeighborhoodIterator.h.

◆ InternalPixelType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType = typename TImage::InternalPixelType

Extract image type information.

Definition at line 75 of file itkConstShapedNeighborhoodIterator.h.

◆ NeighborhoodType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType = Neighborhood<PixelType, Self::Dimension>

Definition at line 97 of file itkConstShapedNeighborhoodIterator.h.

◆ NeighborIndexType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborIndexType = typename NeighborhoodType::NeighborIndexType

Definition at line 99 of file itkConstShapedNeighborhoodIterator.h.

◆ OffsetType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType = typename Superclass::OffsetType

Inherit type alias from superclass

Definition at line 86 of file itkConstShapedNeighborhoodIterator.h.

◆ OffsetValueType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 87 of file itkConstShapedNeighborhoodIterator.h.

◆ PixelType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType = typename TImage::PixelType

Definition at line 76 of file itkConstShapedNeighborhoodIterator.h.

◆ RadiusType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType = typename Superclass::RadiusType

Definition at line 88 of file itkConstShapedNeighborhoodIterator.h.

◆ RegionType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType = typename TImage::RegionType

Definition at line 94 of file itkConstShapedNeighborhoodIterator.h.

◆ Self

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Self = ConstShapedNeighborhoodIterator

Standard class type aliases.

Definition at line 82 of file itkConstShapedNeighborhoodIterator.h.

◆ SizeType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType = typename Superclass::SizeType

Definition at line 89 of file itkConstShapedNeighborhoodIterator.h.

◆ SizeValueType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType = typename SizeType::SizeValueType

Definition at line 90 of file itkConstShapedNeighborhoodIterator.h.

◆ Superclass

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass = NeighborhoodIterator<TImage, TBoundaryCondition>

Definition at line 83 of file itkConstShapedNeighborhoodIterator.h.

Constructor & Destructor Documentation

◆ ConstShapedNeighborhoodIterator() [1/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( )
default

Default constructor

◆ ~ConstShapedNeighborhoodIterator()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstShapedNeighborhoodIterator ( )
overridedefault

Virtual destructor

◆ ConstShapedNeighborhoodIterator() [2/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( const SizeType radius,
const ImageType ptr,
const RegionType region 
)
inline

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

Definition at line 264 of file itkConstShapedNeighborhoodIterator.h.

◆ ConstShapedNeighborhoodIterator() [3/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( const ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > &  )
privatedelete

Copy constructor

Member Function Documentation

◆ ActivateIndex()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ITK_ITERATOR_VIRTUAL void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateIndex ( NeighborIndexType  )
protected

Class is protected here so that it is not publicly accessible, but can be accessed by subclasses.. Add/Remove a neighborhood index to/from the active. Locations in the active list are the only accessible elements in the neighborhood. The argument is an index location calculated as an offset into a linear array which represents the image region defined by the radius of this iterator, with the smallest dimension as the fastest increasing index.

◆ ActivateOffset()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ITK_ITERATOR_VIRTUAL void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffset ( const OffsetType off)
inline

Add/Remove a neighborhood offset (from the center of the neighborhood) to/from the active list. Active list offsets are the only locations updated and accessible through the iterator.

Definition at line 328 of file itkConstShapedNeighborhoodIterator.h.

◆ ActivateOffsets()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
template<typename TOffsets >
void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffsets ( const TOffsets &  offsets)
inline

Activates a whole range of offsets, for example, an std::vector<OffsetType>, which could be from Experimental::GenerateImageNeighborhoodOffsets(shape).

Definition at line 343 of file itkConstShapedNeighborhoodIterator.h.

◆ Begin()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Begin ( ) const
inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 243 of file itkConstShapedNeighborhoodIterator.h.

◆ ClearActiveList()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ITK_ITERATOR_VIRTUAL void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ClearActiveList ( )
inline

Removes all active pixels from this neighborhood.

Definition at line 354 of file itkConstShapedNeighborhoodIterator.h.

◆ CreateActiveListFromNeighborhood()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::CreateActiveListFromNeighborhood ( const NeighborhoodType )

Add non-zero neighborhood offsets to the active list. The radius of the neighborhood must match the radius of the shaped iterator

◆ DeactivateIndex()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ITK_ITERATOR_VIRTUAL void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateIndex ( NeighborIndexType  )
protected

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

◆ DeactivateOffset()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ITK_ITERATOR_VIRTUAL void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateOffset ( const OffsetType off)
inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 333 of file itkConstShapedNeighborhoodIterator.h.

◆ End()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::End ( ) const
inline

Returns a const iterator for the neighborhood which points to the last pixel in the neighborhood.

Definition at line 251 of file itkConstShapedNeighborhoodIterator.h.

◆ GetActiveIndexList()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
const IndexListType& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexList ( ) const
inline

Returns the list of active indices in the neighborhood

Definition at line 363 of file itkConstShapedNeighborhoodIterator.h.

◆ GetActiveIndexListSize()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
IndexListType::size_type itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexListSize ( ) const
inline

Returns the size of the list of active neighborhood indices.

Definition at line 370 of file itkConstShapedNeighborhoodIterator.h.

◆ GetCenterNeighborhoodIndex()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterNeighborhoodIndex
inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 286 of file itkNeighborhood.h.

◆ GetElement()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetElement
inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 214 of file itkNeighborhood.h.

◆ GetNeighborhoodIndex()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
virtual NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetNeighborhoodIndex

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

◆ GetOffset()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
OffsetType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetOffset
inline

Returns the itk::Offset from the center of the Neighborhood to the requested neighbor index.

Definition at line 277 of file itkNeighborhood.h.

◆ GetRadius() [1/2]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
const SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius
inline

Returns the radius of the neighborhood.

Definition at line 143 of file itkNeighborhood.h.

◆ GetRadius() [2/2]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius
inline

Returns the radius of the neighborhood along a specified dimension.

Definition at line 151 of file itkNeighborhood.h.

◆ operator!=()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator!=
inline

Not Equal operator.

Definition at line 136 of file itkNeighborhood.h.

◆ operator++()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator++ ( )

Reimplements the operator++ method so that only active pixel locations are updated.

◆ operator+=()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::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, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator-- ( )

Reimplements the operator-- method so that only active pixel locations are updated.

◆ operator-=()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::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, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator= ( const Self orig)
inline

Assignment operator

Definition at line 308 of file itkConstShapedNeighborhoodIterator.h.

◆ operator==()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator==
inline

Comparison operator.

Definition at line 129 of file itkNeighborhood.h.

◆ Print()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::Print
inline

Standard itk object method.

Definition at line 251 of file itkNeighborhood.h.

◆ PrintSelf()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf ( std::ostream &  ,
Indent   
) const
overridevirtual

Friends And Related Function Documentation

◆ ConstIterator

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
friend struct ConstIterator
friend

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 407 of file itkConstShapedNeighborhoodIterator.h.

Member Data Documentation

◆ Dimension

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
constexpr unsigned int itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Dimension = TImage::ImageDimension
staticconstexpr

Save the image dimension.

Definition at line 79 of file itkConstShapedNeighborhoodIterator.h.

◆ m_ActiveIndexList

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
IndexListType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ActiveIndexList
protected

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 425 of file itkConstShapedNeighborhoodIterator.h.

◆ m_CenterIsActive

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
bool itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive { false }
protected

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 424 of file itkConstShapedNeighborhoodIterator.h.


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