ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkConstNeighborhoodIterator.h>
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.
Definition at line 51 of file itkConstNeighborhoodIterator.h.
typedef TBoundaryCondition itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType |
Typedef for boundary condition type.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 96 of file itkConstNeighborhoodIterator.h.
typedef Superclass::ConstIterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator |
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.
Definition at line 76 of file itkConstNeighborhoodIterator.h.
typedef unsigned int itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::DimensionValueType |
Type used to refer to space dimensions
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Definition at line 64 of file itkConstNeighborhoodIterator.h.
typedef ImageBoundaryCondition< ImageType > const* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionConstPointerType |
Definition at line 101 of file itkConstNeighborhoodIterator.h.
typedef ImageBoundaryCondition< ImageType >* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType |
Typedef for generic boundary condition pointer
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 99 of file itkConstNeighborhoodIterator.h.
typedef TImage itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType |
Typedef support for common objects
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 79 of file itkConstNeighborhoodIterator.h.
typedef Index< itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType |
Typedef support for common objects
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 81 of file itkConstNeighborhoodIterator.h.
typedef TImage::InternalPixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType |
Extract image type information.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 57 of file itkConstNeighborhoodIterator.h.
typedef Superclass::Iterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Iterator |
Iterator typedef support. Note the naming is intentional, i.e., AllocatorType::iterator and AllocatorType::const_iterator, because the allocator may be a vnl object or other type, which uses this form.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 75 of file itkConstNeighborhoodIterator.h.
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.
typedef Neighborhood< PixelType, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType |
Typedef support for common objects
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 83 of file itkConstNeighborhoodIterator.h.
typedef NeighborhoodType::NeighborIndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborIndexType |
Type used to refer to the elements in the list of neighbor pixels.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 87 of file itkConstNeighborhoodIterator.h.
typedef Superclass::OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType |
Inherit typedefs from superclass
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 72 of file itkConstNeighborhoodIterator.h.
typedef TImage::PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType |
External support for pixel type.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 58 of file itkConstNeighborhoodIterator.h.
typedef Superclass::RadiusType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType |
Radius typedef support.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 73 of file itkConstNeighborhoodIterator.h.
typedef TImage::RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType |
Typedef support for common objects
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 80 of file itkConstNeighborhoodIterator.h.
typedef ConstNeighborhoodIterator itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Self |
Standard class typedefs.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 67 of file itkConstNeighborhoodIterator.h.
typedef Superclass::SizeType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType |
Size and value typedef support.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 74 of file itkConstNeighborhoodIterator.h.
typedef Neighborhood< InternalPixelType *, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass |
Reimplemented in itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 69 of file itkConstNeighborhoodIterator.h.
itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstNeighborhoodIterator | ( | ) |
Default constructor
virtual itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstNeighborhoodIterator | ( | ) | [inline, virtual] |
Virtual destructor
Definition at line 107 of file itkConstNeighborhoodIterator.h.
itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ConstNeighborhoodIterator | ( | const ConstNeighborhoodIterator< TImage, TBoundaryCondition > & | ) |
Copy constructor
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.
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.
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.
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.
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.
ImageBoundaryConditionPointerType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundaryCondition | ( | ) | const [inline] |
Definition at line 411 of file itkConstNeighborhoodIterator.h.
RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundingBoxAsImageRegion | ( | ) | const |
Returns a bounding box for the region spanned by this neighborhood represented by an itk::ImageRegion
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.
const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer | ( | ) | const [inline] |
Returns the pointer to the center pixel of the neighborhood.
Definition at line 147 of file itkConstNeighborhoodIterator.h.
Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::operator!=(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator<(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator<=(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator==(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator>(), and itk::ConstNeighborhoodIterator< TSparseImageType >::operator>=().
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.
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 161 of file itkConstNeighborhoodIterator.h.
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 243 of file itkConstNeighborhoodIterator.h.
Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetIndex().
virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex | ( | NeighborIndexType | i | ) | const [inline, virtual] |
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().
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeedToUseBoundaryCondition | ( | ) | const [inline] |
Definition at line 430 of file itkConstNeighborhoodIterator.h.
virtual NeighborhoodType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood | ( | ) | const [virtual] |
Virtual function that "dereferences" a ConstNeighborhoodIterator, returning a Neighborhood of pixel values.
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext | ( | const unsigned | axis, |
NeighborIndexType | 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 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().
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 217 of file itkConstNeighborhoodIterator.h.
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel | ( | NeighborIndexType | i | ) | const [inline, virtual] |
Returns the pixel value located at a linear array location i.
Definition at line 169 of file itkConstNeighborhoodIterator.h.
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.
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel | ( | const OffsetType & | o | ) | const [inline, virtual] |
Returns the pixel value located at the itk::Offset o from the center of the neighborhood.
Definition at line 189 of file itkConstNeighborhoodIterator.h.
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 201 of file itkConstNeighborhoodIterator.h.
Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetPixel().
virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious | ( | const unsigned | axis, |
NeighborIndexType | 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 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().
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 235 of file itkConstNeighborhoodIterator.h.
RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetRegion | ( | ) | const [inline] |
Returns the region of iteration.
Definition at line 252 of file itkConstNeighborhoodIterator.h.
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.
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.
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::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >::operator=().
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToEnd | ( | ) | [virtual] |
Virtual method for sending the iterator to one past the last pixel in its region.
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.
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.
virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtBegin | ( | ) | const [inline, virtual] |
Virtual method for determining whether the iterator is at the beginning of its iteration region.
Definition at line 292 of file itkConstNeighborhoodIterator.h.
virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd | ( | ) | const [inline, virtual] |
Virtual method for determining whether the iterator has reached the end of its iteration region.
Definition at line 297 of file itkConstNeighborhoodIterator.h.
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOff | ( | ) | [inline] |
Definition at line 420 of file itkConstNeighborhoodIterator.h.
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOn | ( | ) | [inline] |
Definition at line 415 of file itkConstNeighborhoodIterator.h.
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.
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 >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
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 >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator- | ( | const Self & | b | ) | [inline] |
Distance between two iterators
Definition at line 384 of file itkConstNeighborhoodIterator.h.
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 >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
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 >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
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.
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.
Self& itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator= | ( | const Self & | orig | ) |
Assignment operator
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.
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.
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.
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.
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 397 of file itkConstNeighborhoodIterator.h.
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf | ( | std::ostream & | , |
Indent | |||
) | const [virtual] |
Standard itk print method
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.
Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.
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 403 of file itkConstNeighborhoodIterator.h.
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 455 of file itkConstNeighborhoodIterator.h.
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.
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBoundaryCondition | ( | const TBoundaryCondition & | c | ) | [inline] |
Sets the internal, default boundary condition.
Definition at line 407 of file itkConstNeighborhoodIterator.h.
virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetEndIndex | ( | ) | [protected, virtual] |
Default method for setting the index of the first pixel in the iteration region.
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.
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 439 of file itkConstNeighborhoodIterator.h.
void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetNeedToUseBoundaryCondition | ( | bool | b | ) | [inline] |
Definition at line 425 of file itkConstNeighborhoodIterator.h.
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.
const unsigned int itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Dimension = TImage::ImageDimension [static] |
Save the image dimension.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.
Definition at line 61 of file itkConstNeighborhoodIterator.h.
const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Begin [protected] |
A pointer to the first pixel in the iteration region.
Definition at line 470 of file itkConstNeighborhoodIterator.h.
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 464 of file itkConstNeighborhoodIterator.h.
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Bound [protected] |
An array of upper looping boundaries used during iteration.
Definition at line 467 of file itkConstNeighborhoodIterator.h.
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 499 of file itkConstNeighborhoodIterator.h.
ImageType::ConstWeakPointer itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstImage [protected] |
The image on which iteration is defined.
Definition at line 473 of file itkConstNeighborhoodIterator.h.
const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_End [protected] |
A pointer to one past the last pixel in the iteration region.
Definition at line 476 of file itkConstNeighborhoodIterator.h.
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 480 of file itkConstNeighborhoodIterator.h.
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 503 of file itkConstNeighborhoodIterator.h.
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InnerBoundsHigh [protected] |
Upper threshold of in-bounds loop counter values.
Definition at line 517 of file itkConstNeighborhoodIterator.h.
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InnerBoundsLow [protected] |
Lower threshold of in-bounds loop counter values.
Definition at line 514 of file itkConstNeighborhoodIterator.h.
TBoundaryCondition itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InternalBoundaryCondition [protected] |
Default boundary condition.
Definition at line 520 of file itkConstNeighborhoodIterator.h.
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_IsInBounds [mutable, protected] |
Denotes if iterator is entirely within bounds
Definition at line 506 of file itkConstNeighborhoodIterator.h.
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 511 of file itkConstNeighborhoodIterator.h.
IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Loop [protected] |
Array of loop counters used during iteration.
Definition at line 483 of file itkConstNeighborhoodIterator.h.
Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::operator-().
bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_NeedToUseBoundaryCondition [protected] |
Does the specified region need to worry about boundary conditions?
Definition at line 523 of file itkConstNeighborhoodIterator.h.
NeighborhoodAccessorFunctorType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_NeighborhoodAccessorFunctor [protected] |
Functor type used to access neighborhoods of pixel pointers
Definition at line 526 of file itkConstNeighborhoodIterator.h.
RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Region [protected] |
The region over which iteration is defined.
Definition at line 486 of file itkConstNeighborhoodIterator.h.
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 493 of file itkConstNeighborhoodIterator.h.