Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference
[Image Iterators]

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

#include <itkConstNeighborhoodIterator.h>

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

[legend]Collaboration diagram for itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >:

[legend]List of all members.


Public Types
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::PixelType	PixelType
typedef ConstNeighborhoodIterator	Self
typedef Neighborhood< InternalPixelType *, itkGetStaticConstMacro(Dimension)	Superclass )
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef Superclass::RadiusType	RadiusType
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef Superclass::Iterator	Iterator
typedef Superclass::ConstIterator	ConstIterator
typedef ImageType::NeighborhoodAccessorFunctorType	NeighborhoodAccessorFunctorType
typedef TBoundaryCondition	BoundaryConditionType
typedef ImageBoundaryCondition< ImageType > *	ImageBoundaryConditionPointerType
typedef ImageBoundaryCondition< ImageType > const *	ImageBoundaryConditionConstPointerType

typedef TImage	ImageType
typedef TImage::RegionType	RegionType
typedef Index< itkGetStaticConstMacro(Dimension)	IndexType )
typedef IndexType::IndexValueType	IndexValueType
typedef Neighborhood< PixelType, itkGetStaticConstMacro(Dimension)	NeighborhoodType )
Public Member Functions
	itkStaticConstMacro (Dimension, unsigned int, TImage::ImageDimension)
	ConstNeighborhoodIterator ()
virtual	~ConstNeighborhoodIterator ()
	ConstNeighborhoodIterator (const ConstNeighborhoodIterator &)
Self &	operator= (const Self &orig)
virtual void	PrintSelf (std::ostream &, Indent) const
OffsetType	ComputeInternalIndex (unsigned int n) const
IndexType	GetBound () const
long	GetBound (unsigned int n) const
const InternalPixelType *	GetCenterPointer () const
PixelType	GetCenterPixel () const
const ImageType *	GetImagePointer (void) const
virtual IndexType	GetIndex (void) const
virtual NeighborhoodType	GetNeighborhood () const
virtual PixelType	GetPixel (const unsigned i, bool &IsInBounds) const
virtual PixelType	GetPixel (const OffsetType &o) const
virtual PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const
virtual PixelType	GetNext (const unsigned axis, const unsigned i) const
virtual PixelType	GetNext (const unsigned axis) const
virtual PixelType	GetPrevious (const unsigned axis, const unsigned i) const
virtual PixelType	GetPrevious (const unsigned axis) const
virtual IndexType	GetIndex (const OffsetType &o) const
virtual IndexType	GetIndex (const unsigned i) const
RegionType	GetRegion () const
IndexType	GetBeginIndex () const
RegionType	GetBoundingBoxAsImageRegion () const
OffsetType	GetWrapOffset () const
OffsetValueType	GetWrapOffset (unsigned int n) const
virtual void	GoToBegin ()
virtual void	GoToEnd ()
virtual void	Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual bool	IsAtBegin () const
Self &	operator++ ()
Self &	operator-- ()
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
Self &	operator+= (const OffsetType &)
Self &	operator-= (const OffsetType &)
OffsetType	operator- (const Self &b)
bool	InBounds () const
virtual void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
virtual void	ResetBoundaryCondition ()
void	SetBoundaryCondition (const TBoundaryCondition &c)
const BoundaryConditionType *	GetBoundaryCondition () const

	ConstNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)

virtual PixelType	GetPixel (const unsigned i) const

virtual bool	IsAtEnd () const

void	SetLocation (const IndexType &position)

void	NeedToUseBoundaryConditionOn ()
void	NeedToUseBoundaryConditionOff ()
void	SetNeedToUseBoundaryCondition (bool b)
bool	GetNeedToUseBoundaryCondition () const
Protected Member Functions
virtual void	SetLoop (const IndexType &p)
virtual void	SetBound (const SizeType &)
virtual void	SetPixelPointers (const IndexType &)
virtual void	SetBeginIndex (const IndexType &start)
virtual void	SetEndIndex ()
Protected Attributes
IndexType	m_BeginIndex
IndexType	m_Bound
const InternalPixelType *	m_Begin
ImageType::ConstWeakPointer	m_ConstImage
const InternalPixelType *	m_End
IndexType	m_EndIndex
IndexType	m_Loop
RegionType	m_Region
OffsetType	m_WrapOffset
ImageBoundaryConditionPointerType	m_BoundaryCondition
bool	m_InBounds [Dimension]
bool	m_IsInBounds
bool	m_IsInBoundsValid
IndexType	m_InnerBoundsLow
IndexType	m_InnerBoundsHigh
TBoundaryCondition	m_InternalBoundaryCondition
bool	m_NeedToUseBoundaryCondition
NeighborhoodAccessorFunctorType	m_NeighborhoodAccessorFunctor

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

Definition at line 52 of file itkConstNeighborhoodIterator.h.

Member Typedef Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TBoundaryCondition itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType

Typedef for boundary condition type.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 91 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::ConstIterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 75 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef ImageBoundaryCondition<ImageType> const* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionConstPointerType

Definition at line 95 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
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 94 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType

Typedef support for common objects
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 78 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
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 80 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef IndexType::IndexValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IndexValueType

Typedef support for common objects
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
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.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 58 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::Iterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Iterator

Iterator typedef support. Note the naming is intentional, i.e., ::iterator and ::const_iterator, because the allocator may be a vnl object or other type, which uses this form.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 74 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 88 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
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 82 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType

Inherit typedefs from superclass
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 69 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef OffsetType::OffsetValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType

Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 70 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage::PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType

External support for pixel type.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 59 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::RadiusType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType

Radius typedef support.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 71 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage::RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType

Typedef support for common objects
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 79 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef ConstNeighborhoodIterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Self

Standard class typedefs.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 65 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::SizeType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType

Size and value typedef support.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 72 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::SizeValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 73 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

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

Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 66 of file itkConstNeighborhoodIterator.h.

Constructor & Destructor Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstNeighborhoodIterator ( ) [inline, virtual]

Virtual destructor
Definition at line 101 of file itkConstNeighborhoodIterator.h.

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 108 of file itkConstNeighborhoodIterator.h.

Member Function Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ComputeInternalIndex ( unsigned int 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 239 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

long itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBound ( unsigned int n ) const [inline]

Returns the loop bound used to define the edge of a single dimension in the itk::Image region.
Definition at line 138 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 133 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const BoundaryConditionType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundaryCondition ( ) const [inline]

Definition at line 393 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 146 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer ( ) const [inline]

Returns the pointer to the center pixel of the neighborhood.
Definition at line 142 of file itkConstNeighborhoodIterator.h.

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 150 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( const unsigned i ) const [inline, virtual]

Returns the image index for neighbor pixel at index i in the neighborhood.
Definition at line 230 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( const OffsetType & o ) const [inline, virtual]

Returns the image index for neighbor pixel at offset o from the center of the neighborhood.
Definition at line 225 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( void ) const [inline, virtual]

Returns the N-dimensional index of the iterator's position in the image.
Definition at line 155 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeedToUseBoundaryCondition ( ) const [inline]

Definition at line 409 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 ) const [inline, virtual]

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 205 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext ( const unsigned axis,

const unsigned i

) const [inline, virtual]

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 198 of file itkConstNeighborhoodIterator.h.
Referenced by itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( const OffsetType & o,

bool & IsInBounds

) const [inline, virtual]

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 191 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( const unsigned 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 >::GetPrevious ( const unsigned axis ) const [inline, virtual]

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 219 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious ( const unsigned axis,

const unsigned i

) const [inline, virtual]

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 212 of file itkConstNeighborhoodIterator.h.
Referenced by itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetRegion ( ) const [inline]

Returns the region of iteration.
Definition at line 234 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetWrapOffset ( unsigned int 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 255 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 247 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.

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>>

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 ( void ) const [inline, virtual]

Virtual method for determining whether the the iterator is at the beginning of its iteration region.
Definition at line 274 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd ( ) const [inline, virtual]

Virtual method for determining whether the the iterator has reached the end of its iteration region.
Definition at line 279 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::itkStaticConstMacro ( Dimension ,

unsigned int,

TImage::ImageDimension

)

Save the image dimension.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOff ( ) [inline]

Definition at line 401 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOn ( ) [inline]

Definition at line 397 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.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Definition at line 317 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.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

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.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator- ( const Self & b ) [inline]

Distance between two iterators
Definition at line 367 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.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

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.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

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 323 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 329 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

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

Assignment operator
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

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.
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Definition at line 311 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>>

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>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OverrideBoundaryCondition ( const ImageBoundaryConditionPointerType i ) [inline, virtual]

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 380 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf ( std::ostream & ,

Indent

) const [virtual]

Standard itk print method
Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ResetBoundaryCondition ( ) [inline, virtual]

Resets the boundary condition to the internal, default conditions specified by the template parameter.
Definition at line 385 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBeginIndex ( const IndexType & start ) [inline, protected, virtual]

Default method for setting the index of the first pixel in the iteration region.
Definition at line 436 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBound ( const SizeType & ) [protected, virtual]

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 389 of file itkConstNeighborhoodIterator.h.

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 348 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetLoop ( const IndexType & p ) [inline, protected, virtual]

Default method for setting the coordinate location of the iterator. Loop indicies correspond to the actual Image region index.
Definition at line 420 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetPixelPointers ( const IndexType & ) [protected, virtual]

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

Member Data Documentation

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 451 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 445 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 448 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 481 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 454 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_End [protected]

Definition at line 459 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 463 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InBounds[Dimension] [mutable, protected]

Denotes which of the iterators dimensional sides spill outside region of interest boundaries.
Definition at line 485 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 499 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 496 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 502 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_IsInBounds [mutable, protected]

Denotes if iterator is entirely within bounds
Definition at line 488 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_IsInBoundsValid [mutable, protected]

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 493 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 466 of file itkConstNeighborhoodIterator.h.

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 505 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 508 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 469 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 475 of file itkConstNeighborhoodIterator.h.

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

itkConstNeighborhoodIterator.h

Generated at Thu May 25 00:41:32 2006 for ITK by

itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference [Image Iterators]

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes