ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference

#include <itkConstNeighborhoodIterator.h>

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

Detailed Description

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
class itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >

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

ConstNeighborhoodIterator implements the read-only methods of NeighborhoodIterator. It serves as a base class from which other iterators are derived. See NeighborhoodIterator for more complete information.

See Also
Neighborhood
ImageIterator
NeighborhoodIterator
Wiki Examples:
Examples:
itkVectorImageTest.cxx.

Definition at line 51 of file itkConstNeighborhoodIterator.h.

Public Types

typedef TBoundaryCondition BoundaryConditionType
 
typedef Superclass::ConstIterator ConstIterator
 
typedef unsigned int DimensionValueType
 
typedef ImageBoundaryCondition
< ImageType > const * 
ImageBoundaryConditionConstPointerType
 
typedef ImageBoundaryCondition
< ImageType > * 
ImageBoundaryConditionPointerType
 
typedef TImage::InternalPixelType InternalPixelType
 
typedef Superclass::Iterator Iterator
 
typedef
ImageType::NeighborhoodAccessorFunctorType 
NeighborhoodAccessorFunctorType
 
typedef
NeighborhoodType::NeighborIndexType 
NeighborIndexType
 
typedef Superclass::OffsetType OffsetType
 
typedef TImage::PixelType PixelType
 
typedef Superclass::RadiusType RadiusType
 
typedef ConstNeighborhoodIterator Self
 
typedef Superclass::SizeType SizeType
 
typedef Neighborhood
< InternalPixelType
*, itkGetStaticConstMacro(Dimension) > 
Superclass
 
typedef TImage ImageType
 
typedef TImage::RegionType RegionType
 
typedef Index
< itkGetStaticConstMacro(Dimension) > 
IndexType
 
typedef Neighborhood
< PixelType,
itkGetStaticConstMacro(Dimension) > 
NeighborhoodType
 
- Public Types inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
typedef NeighborhoodAllocator
< TImage::InternalPixelType * > 
AllocatorType
 
typedef
AllocatorType::const_iterator 
ConstIterator
 
typedef unsigned int DimensionValueType
 
typedef AllocatorType::iterator Iterator
 
typedef SizeValueType NeighborIndexType
 
typedef Offset< VDimension > OffsetType
 
typedef TImage::InternalPixelType * PixelType
 
typedef Neighborhood Self
 
typedef SizeType::SizeValueType SizeValueType
 
typedef SliceIterator
< TImage::InternalPixelType
*, Self
SliceIteratorType
 

Public Member Functions

OffsetType ComputeInternalIndex (NeighborIndexType n) const
 
 ConstNeighborhoodIterator ()
 
 ConstNeighborhoodIterator (const ConstNeighborhoodIterator &)
 
IndexType GetBeginIndex () const
 
IndexType GetBound () const
 
IndexValueType GetBound (NeighborIndexType n) const
 
ImageBoundaryConditionPointerType GetBoundaryCondition () const
 
RegionType GetBoundingBoxAsImageRegion () const
 
PixelType GetCenterPixel () const
 
const InternalPixelTypeGetCenterPointer () const
 
const ImageTypeGetImagePointer (void) const
 
virtual IndexType GetIndex (void) const
 
virtual IndexType GetIndex (const OffsetType &o) const
 
virtual IndexType GetIndex (NeighborIndexType i) const
 
bool GetNeedToUseBoundaryCondition () const
 
virtual NeighborhoodType GetNeighborhood () const
 
virtual PixelType GetNext (const unsigned axis, NeighborIndexType i) const
 
virtual PixelType GetNext (const unsigned axis) const
 
virtual PixelType GetPixel (NeighborIndexType i, bool &IsInBounds) const
 
virtual PixelType GetPixel (const OffsetType &o) const
 
virtual PixelType GetPixel (const OffsetType &o, bool &IsInBounds) const
 
virtual PixelType GetPrevious (const unsigned axis, NeighborIndexType i) const
 
virtual PixelType GetPrevious (const unsigned axis) const
 
RegionType GetRegion () const
 
OffsetType GetWrapOffset () const
 
OffsetValueType GetWrapOffset (NeighborIndexType n) const
 
virtual void GoToBegin ()
 
virtual void GoToEnd ()
 
bool InBounds () const
 
bool IndexInBounds (NeighborIndexType n, OffsetType &internalIndex, OffsetType &offset) const
 
virtual void Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)
 
virtual bool IsAtBegin () const
 
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
 
virtual void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
 
virtual void PrintSelf (std::ostream &, Indent) const
 
virtual void ResetBoundaryCondition ()
 
void SetBoundaryCondition (const TBoundaryCondition &c)
 
void SetNeedToUseBoundaryCondition (bool b)
 
virtual void SetRegion (const RegionType &region)
 
virtual ~ConstNeighborhoodIterator ()
 
 ConstNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
 
virtual PixelType GetPixel (NeighborIndexType i) const
 
virtual bool IsAtEnd () const
 
void SetLocation (const IndexType &position)
 
- Public Member Functions inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
NeighborIndexType GetCenterNeighborhoodIndex () const
 
TImage::InternalPixelType * GetCenterValue () const
 
virtual NeighborIndexType GetNeighborhoodIndex (const OffsetType &) const
 
OffsetType GetOffset (NeighborIndexType i) const
 
const SizeType GetRadius () const
 
SizeValueType GetRadius (DimensionValueType n) const
 
SizeValueType GetSize (DimensionValueType n) const
 
SizeType GetSize () const
 
std::slice GetSlice (unsigned int) const
 
OffsetValueType GetStride (DimensionValueType axis) const
 
 Neighborhood (const Self &other)
 
bool operator!= (const Self &other) const
 
Selfoperator= (const Self &other)
 
bool operator== (const Self &other) const
 
void Print (std::ostream &os) const
 
void SetRadius (const SizeType &)
 
void SetRadius (const SizeValueType *rad)
 
void SetRadius (const SizeValueType)
 
NeighborIndexType Size () const
 
virtual ~Neighborhood ()
 
 Neighborhood ()
 
Iterator End ()
 
ConstIterator End () const
 
Iterator Begin ()
 
ConstIterator Begin () const
 
TImage::InternalPixelType *& operator[] (NeighborIndexType i)
 
const TImage::InternalPixelType *& operator[] (NeighborIndexType i) const
 
TImage::InternalPixelType *& GetElement (NeighborIndexType i)
 
TImage::InternalPixelType *& operator[] (const OffsetType &o)
 
const TImage::InternalPixelType *& operator[] (const OffsetType &o) const
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 

Static Public Attributes

static const unsigned int Dimension = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
static const unsigned int NeighborhoodDimension
 

Protected Member Functions

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

Protected Attributes

const InternalPixelTypem_Begin
 
IndexType m_BeginIndex
 
IndexType m_Bound
 
ImageBoundaryConditionPointerType m_BoundaryCondition
 
ImageType::ConstWeakPointer m_ConstImage
 
const InternalPixelTypem_End
 
IndexType m_EndIndex
 
bool m_InBounds [Dimension]
 
IndexType m_InnerBoundsHigh
 
IndexType m_InnerBoundsLow
 
TBoundaryCondition m_InternalBoundaryCondition
 
bool m_IsInBounds
 
bool m_IsInBoundsValid
 
IndexType m_Loop
 
bool m_NeedToUseBoundaryCondition
 
NeighborhoodAccessorFunctorType m_NeighborhoodAccessorFunctor
 
RegionType m_Region
 
OffsetType m_WrapOffset
 

Additional Inherited Members

- Public Attributes inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
typedef::itk::Size< VDimension > RadiusType
 
typedef::itk::Size< VDimension > SizeType
 

Member Typedef Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef TBoundaryCondition itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType

Typedef for boundary condition type.

Definition at line 96 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Superclass::ConstIterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator

Definition at line 76 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef unsigned int itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::DimensionValueType

Type used to refer to space dimensions

Definition at line 64 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef ImageBoundaryCondition< ImageType > const* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionConstPointerType

Definition at line 101 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef ImageBoundaryCondition< ImageType >* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType

Typedef for generic boundary condition pointer

Definition at line 99 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef TImage itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType

Typedef support for common objects

Definition at line 79 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Index< itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType

Typedef support for common objects

Definition at line 81 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef TImage::InternalPixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType

Extract image type information.

Definition at line 57 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Superclass::Iterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Iterator

Definition at line 75 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef ImageType::NeighborhoodAccessorFunctorType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodAccessorFunctorType

Typedef for the functor used to access neighborhoods of pixel pointers. This is obtained as a trait from the image and is different for Image and VectorImage.

Definition at line 93 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Neighborhood< PixelType, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType

Typedef support for common objects

Definition at line 83 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef NeighborhoodType::NeighborIndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborIndexType

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

Definition at line 87 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Superclass::OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType

Inherit typedefs from superclass

Definition at line 72 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef TImage::PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType

Definition at line 58 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Superclass::RadiusType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType

Definition at line 73 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef TImage::RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType

Typedef support for common objects

Definition at line 80 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef ConstNeighborhoodIterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Self

Standard class typedefs.

Definition at line 67 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Superclass::SizeType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType

Definition at line 74 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
typedef Neighborhood< InternalPixelType *, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass

Definition at line 69 of file itkConstNeighborhoodIterator.h.

Constructor & Destructor Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstNeighborhoodIterator ( )

Default constructor

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstNeighborhoodIterator ( )
inlinevirtual

Virtual destructor

Definition at line 107 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstNeighborhoodIterator ( const ConstNeighborhoodIterator< TImage, TBoundaryCondition > &  )

Copy constructor

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstNeighborhoodIterator ( 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 114 of file itkConstNeighborhoodIterator.h.

Member Function Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::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.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBeginIndex ( ) const
inline

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

Definition at line 257 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBound ( ) const
inline

Returns the array of upper loop bounds used during iteration.

Definition at line 138 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::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 143 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
ImageBoundaryConditionPointerType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundaryCondition ( ) const
inline

Definition at line 424 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundingBoxAsImageRegion ( ) const

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPixel ( ) const
inline

Returns the pixel referenced at the center of the ConstNeighborhoodIterator.

Definition at line 152 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer ( ) const
inline
template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
const ImageType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetImagePointer ( void  ) const
inline

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

Definition at line 156 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( void  ) const
inlinevirtual

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

Definition at line 161 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( const OffsetType o) const
inlinevirtual

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

Definition at line 243 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetIndex().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( NeighborIndexType  i) const
inlinevirtual

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

Definition at line 248 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetIndex().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeedToUseBoundaryCondition ( ) const
inline

Definition at line 443 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual NeighborhoodType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood ( ) const
virtual

Virtual function that "dereferences" a ConstNeighborhoodIterator, returning a Neighborhood of pixel values.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext ( const unsigned  axis,
NeighborIndexType  i 
) const
inlinevirtual

Returns the pixel value located i pixels distant from the neighborhood center in the positive specified ``axis'' direction. No bounds checking is done on the size of the neighborhood.

Definition at line 208 of file itkConstNeighborhoodIterator.h.

Referenced by itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D(), and itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext ( const unsigned  axis) const
inlinevirtual

Returns the pixel value located one pixel distant from the neighborhood center in the specifed positive axis direction. No bounds checking is done on the size of the neighborhood.

Definition at line 217 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( NeighborIndexType  i) const
inlinevirtual

Returns the pixel value located at a linear array location i.

Definition at line 169 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( NeighborIndexType  i,
bool &  IsInBounds 
) const
virtual

Return the pixel value located at a linear array location i. Sets "IsInBounds" to true if the location is inside the image and the pixel value returned is an actual pixel in the image. Sets "IsInBounds" to false if the location is outside the image and the pixel value returned is a boundary condition.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( const OffsetType o) const
inlinevirtual

Returns the pixel value located at the itk::Offset o from the center of the neighborhood.

Definition at line 189 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( const OffsetType o,
bool &  IsInBounds 
) const
inlinevirtual

Returns the pixel value located at the itk::Offset o from the center of the neighborhood. Sets "IsInBounds" to true if the offset is inside the image and the pixel value returned is an actual pixel in the image. Sets "IsInBounds" to false if the offset is outside the image and the pixel value returned is a boundary condition.

Definition at line 201 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetPixel().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious ( const unsigned  axis,
NeighborIndexType  i 
) const
inlinevirtual

Returns the pixel value located i pixels distant from the neighborhood center in the negative specified ``axis'' direction. No bounds checking is done on the size of the neighborhood.

Definition at line 226 of file itkConstNeighborhoodIterator.h.

Referenced by itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D(), and itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious ( const unsigned  axis) const
inlinevirtual

Returns the pixel value located one pixel distant from the neighborhood center in the specifed negative axis direction. No bounds checking is done on the size of the neighborhood.

Definition at line 235 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetRegion ( ) const
inline

Returns the region of iteration.

Definition at line 252 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetWrapOffset ( ) const
inline

Returns the offsets used to wrap across dimensional boundaries.

Definition at line 265 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
OffsetValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetWrapOffset ( NeighborIndexType  n) const
inline

Returns the internal offset associated with wrapping around a single dimension's region boundary in the itk::Image. An offset for each dimension is necessary to shift pointers when wrapping around region edges because region memory is not necessarily contiguous within the buffer.

Definition at line 273 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToBegin ( )
virtual

Virtual method for rewinding the iterator to its beginning pixel. This is useful for writing functions which take neighborhood iterators of arbitrary type and must use virtual functions.

Referenced by itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >::Begin(), and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToEnd ( )
virtual

Virtual method for sending the iterator to one past the last pixel in its region.

Referenced by itk::Statistics::ImageToNeighborhoodSampleAdaptor< TImage, TBoundaryCondition >::End().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::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.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IndexInBounds ( 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.
template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Initialize ( const SizeType radius,
const ImageType ptr,
const RegionType region 
)
virtual

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtBegin ( ) const
inlinevirtual

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

Definition at line 292 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd ( ) const
inlinevirtual

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

Definition at line 297 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOff ( )
inline

Definition at line 433 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOn ( )
inline

Definition at line 428 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator!= ( const Self it) const
inline

Returns a boolean != comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 335 of file itkConstNeighborhoodIterator.h.

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

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
Self& itk::ConstNeighborhoodIterator< 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.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator- ( const Self b)
inline

Distance between two iterators

Definition at line 384 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
Self& itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator-- ( )

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
Self& itk::ConstNeighborhoodIterator< 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.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator< ( const Self it) const
inline

Returns a boolean < comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 341 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator<= ( const Self it) const
inline

Returns a boolean < comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 347 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
Self& itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator= ( const Self orig)

Assignment operator

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator== ( const Self it) const
inline

Returns a boolean == comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 329 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator> ( const Self it) const
inline

Returns a boolean > comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 353 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator>= ( const Self it) const
inline

Returns a boolean >= comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 359 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OverrideBoundaryCondition ( const ImageBoundaryConditionPointerType  i)
inlinevirtual

Allows a user to override the internal boundary condition. Care should be taken to ensure that the overriding boundary condition is a persistent object during the time it is referenced. The overriding condition can be of a different type than the default type as long as it is a subclass of ImageBoundaryCondition.

Definition at line 410 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf ( std::ostream &  ,
Indent   
) const
virtual
template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ResetBoundaryCondition ( )
inlinevirtual

Resets the boundary condition to the internal, default conditions specified by the template parameter.

Definition at line 416 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBeginIndex ( const IndexType start)
inlineprotectedvirtual

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

Definition at line 471 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBound ( const SizeType )
protectedvirtual

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBoundaryCondition ( const TBoundaryCondition &  c)
inline

Sets the internal, default boundary condition.

Definition at line 420 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetEndIndex ( )
protectedvirtual

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::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 366 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetLoop ( const IndexType p)
inlineprotectedvirtual

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

Definition at line 455 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetNeedToUseBoundaryCondition ( bool  b)
inline

Definition at line 438 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetPixelPointers ( const IndexType )
protectedvirtual

Default method for setting the values of the internal pointers to itk::Image memory buffer locations. This method should generally only be called when the iterator is initialized.

See Also
SetLocation
template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetRegion ( const RegionType region)
virtual

Set the region to iterate over.

Member Data Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
const unsigned int itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Dimension = TImage::ImageDimension
static

Save the image dimension.

Definition at line 61 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Begin
protected

A pointer to the first pixel in the iteration region.

Definition at line 486 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_BeginIndex
protected

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

Definition at line 480 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Bound
protected

An array of upper looping boundaries used during iteration.

Definition at line 483 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
ImageBoundaryConditionPointerType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_BoundaryCondition
protected

Pointer to the actual boundary condition that will be used. By default this points to m_BoundaryCondition, but OverrideBoundaryCondition allows a user to point this variable an external boundary condition.

Definition at line 515 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
ImageType::ConstWeakPointer itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstImage
protected

The image on which iteration is defined.

Definition at line 489 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_End
protected

A pointer to one past the last pixel in the iteration region.

Definition at line 492 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_EndIndex
protected

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

Definition at line 496 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InBounds[Dimension]
mutableprotected

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

Definition at line 519 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InnerBoundsHigh
protected

Upper threshold of in-bounds loop counter values.

Definition at line 533 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InnerBoundsLow
protected

Lower threshold of in-bounds loop counter values.

Definition at line 530 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
TBoundaryCondition itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InternalBoundaryCondition
protected

Default boundary condition.

Definition at line 536 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_IsInBounds
mutableprotected

Denotes if iterator is entirely within bounds

Definition at line 522 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::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 527 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Loop
protected

Array of loop counters used during iteration.

Definition at line 499 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::operator-().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_NeedToUseBoundaryCondition
protected

Does the specified region need to worry about boundary conditions?

Definition at line 539 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
NeighborhoodAccessorFunctorType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_NeighborhoodAccessorFunctor
protected

Functor type used to access neighborhoods of pixel pointers

Definition at line 542 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Region
protected

The region over which iteration is defined.

Definition at line 502 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_WrapOffset
protected

The internal array of offsets that provide support for regions of interest. An offset for each dimension is necessary to shift pointers when wrapping around region edges because region memory is not necessarily contiguous within the buffer.

Definition at line 509 of file itkConstNeighborhoodIterator.h.


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