ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkConstNeighborhoodIteratorWithOnlyIndex.h>
Index-only version of ConstNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of indecies across an itk::Image or itk::ImageBase.
ConstNeighborhoodIteratorWithOnlyIndex implements the index-only methods of NeighborhoodIterator. No image data is accessed, so this iterator can be used with type itk::ImageBase. It serves as a base class from which other iterators can be derived. See NeighborhoodIterator for more complete information.
The parent class itk::Neighborhood is declared with 'char' as its first template parameter, because the pixel type is not used in this class.
Other index-only iterators:
Other iterators:
Definition at line 60 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Static Public Attributes | |
static const DimensionValueType | Dimension = TImage::ImageDimension |
Static Public Attributes inherited from itk::Neighborhood< char, 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) |
Protected Member Functions inherited from itk::Neighborhood< char, TImage::ImageDimension > | |
virtual void | Allocate (NeighborIndexType i) |
virtual void | ComputeNeighborhoodOffsetTable () |
virtual void | ComputeNeighborhoodStrideTable () |
void | SetSize () |
Protected Attributes | |
IndexType | m_BeginIndex |
IndexType | m_Bound |
ImageType::ConstPointer | m_ConstImage |
IndexType | m_EndIndex |
bool | m_InBounds [Dimension] |
IndexType | m_InnerBoundsHigh |
IndexType | m_InnerBoundsLow |
bool | m_IsInBounds |
bool | m_IsInBoundsValid |
IndexType | m_Loop |
bool | m_NeedToUseBoundaryCondition |
RegionType | m_Region |
Additional Inherited Members | |
Public Attributes inherited from itk::Neighborhood< char, TImage::ImageDimension > | |
typedef::itk::Size< VDimension > | RadiusType |
typedef::itk::Size< VDimension > | SizeType |
typedef Superclass::ConstIterator itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstIterator |
Definition at line 82 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef unsigned int itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DimensionValueType |
Type used to refer to space dimensions
Definition at line 66 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef char itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DummyNeighborhoodPixelType |
Definition at line 71 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef TImage itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ImageType |
Typedef support for common objects
Definition at line 85 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Index< itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexType |
Typedef support for common objects
Definition at line 87 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Superclass::Iterator itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Iterator |
Definition at line 81 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Neighborhood< DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeighborhoodType |
Typedef support for common objects
Definition at line 88 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef NeighborhoodType::NeighborIndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeighborIndexType |
Type used to refer to the elements in the list of neighbor pixels.
Definition at line 92 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Superclass::OffsetType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::OffsetType |
Inherit typedefs from superclass
Definition at line 78 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Superclass::RadiusType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::RadiusType |
Definition at line 79 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef TImage::RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::RegionType |
Typedef support for common objects
Definition at line 86 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef ConstNeighborhoodIteratorWithOnlyIndex itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Self |
Standard class typedefs.
Definition at line 74 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Superclass::SizeType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SizeType |
Definition at line 80 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
typedef Neighborhood< DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Superclass |
Definition at line 75 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstNeighborhoodIteratorWithOnlyIndex | ( | ) |
Default constructor
|
inlinevirtual |
Virtual destructor
Definition at line 98 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstNeighborhoodIteratorWithOnlyIndex | ( | const ConstNeighborhoodIteratorWithOnlyIndex< TImage > & | ) |
Copy constructor
itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstNeighborhoodIteratorWithOnlyIndex | ( | const SizeType & | radius, |
const ImageType * | ptr, | ||
const RegionType & | region | ||
) |
Constructor which establishes the region size, neighborhood, and image over which to walk.
OffsetType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ComputeInternalIndex | ( | NeighborIndexType | n | ) | const |
Computes the internal, N-d offset of a pixel array position n from (0,0, ..., 0) in the "upper-left" corner of the neighborhood.
|
inline |
Returns the N-dimensional starting index of the iterator's position on the image.
Definition at line 165 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_BeginIndex.
|
inline |
Returns the array of upper loop bounds used during iteration.
Definition at line 118 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Bound.
|
inline |
Returns the loop bound used to define the edge of a single dimension in the itk::Image region.
Definition at line 125 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Bound.
RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBoundingBoxAsImageRegion | ( | ) | const |
Returns a bounding box for the region spanned by this neighborhood represented by an itk::ImageRegion
|
inline |
Returns a smartpointer to the image on which this iterator operates.
Definition at line 131 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_ConstImage.
|
inlinevirtual |
Returns the N-dimensional index of the iterator's position in the image.
Definition at line 138 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Loop.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex(), itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IsAtBegin(), itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator!=(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator==().
|
inlinevirtual |
Returns the image index for neighbor pixel at offset o from the center of the neighborhood.
Definition at line 145 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex().
|
inlinevirtual |
Returns the image index for neighbor pixel at index i in the neighborhood.
Definition at line 152 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex(), and itk::Neighborhood< char, TImage::ImageDimension >::GetOffset().
|
inline |
Definition at line 313 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_NeedToUseBoundaryCondition.
|
inline |
Returns the region of iteration.
Definition at line 158 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Region.
|
virtual |
Virtual method for rewinding the iterator to its beginning image index. This is useful for writing functions which take neighborhood iterators of arbitrary type and must use virtual functions.
|
virtual |
Virtual method for sending the iterator to one past the last index in its region.
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::InBounds | ( | ) | const |
Returns false if the iterator overlaps region boundaries, true otherwise. Also updates an internal boolean array indicating which of the iterator's faces are out of bounds.
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::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.
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. |
|
virtual |
Initializes the iterator to walk a particular image and a particular region of that image.
|
inlinevirtual |
Virtual method for determining whether the iterator is at the beginning of its iteration region.
Definition at line 189 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_BeginIndex.
|
virtual |
Virtual method for determining whether the iterator has reached the end of its iteration region.
|
inline |
Definition at line 303 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetNeedToUseBoundaryCondition().
|
inline |
Definition at line 298 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetNeedToUseBoundaryCondition().
|
inline |
Returns a boolean != comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored.
Definition at line 221 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex().
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator++ | ( | ) |
Increments the pointers in the ConstNeighborhoodIteratorWithOnlyIndex, wraps across boundaries automatically, accounting for the disparity in the buffer size and the region size of the image.
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator+= | ( | const OffsetType & | ) |
Addition of an itk::Offset. Note that this method does not do any bounds checking. Adding an offset that moves the iterator out of its assigned region will produce undefined results.
|
inline |
Distance between two iterators
Definition at line 274 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Loop.
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-- | ( | ) |
Decrements the pointers in the ConstNeighborhoodIteratorWithOnlyIndex, wraps across boundaries automatically, accounting for the disparity in the buffer size and the region size of the image.
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-= | ( | const OffsetType & | ) |
Subtraction of an itk::Offset. Note that this method does not do any bounds checking. Subtracting an offset that moves the iterator out of its assigned region will produce undefined results.
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator< | ( | const Self & | it | ) | const |
Returns a boolean < comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator<= | ( | const Self & | it | ) | const |
Returns a boolean <= comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.
Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator= | ( | const Self & | orig | ) |
Assignment operator
|
inline |
Returns a boolean == comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored.
Definition at line 213 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex().
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator> | ( | const Self & | it | ) | const |
Returns a boolean > comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.
bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator>= | ( | const Self & | it | ) | const |
Returns a boolean >= comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.
|
virtual |
Standard itk print method
Reimplemented from itk::Neighborhood< char, TImage::ImageDimension >.
|
inlineprotectedvirtual |
Default method for setting the first index of the iteration region.
Definition at line 334 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_BeginIndex.
|
protectedvirtual |
Virtual method for setting internal loop boundaries. This method must be defined in each subclass because each subclass may handle loop boundaries differently.
|
protectedvirtual |
Default method for setting the last index of the iteration region.
|
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 258 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLoop().
|
inlineprotectedvirtual |
Default method for setting the coordinate location of the iterator. Loop indices correspond to the actual Image region index.
Definition at line 322 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_IsInBoundsValid, and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Loop.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLocation().
|
inline |
Definition at line 308 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_NeedToUseBoundaryCondition.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeedToUseBoundaryConditionOff(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeedToUseBoundaryConditionOn().
|
static |
Save the image dimension.
Definition at line 69 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
|
protected |
The starting index for iteration within the itk::Image region on which this ConstNeighborhoodIteratorWithOnlyIndex is defined.
Definition at line 345 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBeginIndex(), itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IsAtBegin(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetBeginIndex().
|
protected |
An array of upper looping boundaries used during iteration.
Definition at line 348 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBound().
|
protected |
The image on which iteration is defined.
Definition at line 351 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetImagePointer().
|
protected |
The end index for iteration within the itk::Image region on which this ConstNeighborhoodIteratorWithOnlyIndex is defined.
Definition at line 355 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
|
mutableprotected |
Denotes which of the iterators dimensional sides spill outside region of interest boundaries.
Definition at line 365 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
|
protected |
Upper threshold of in-bounds loop counter values.
Definition at line 379 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
|
protected |
Lower threshold of in-bounds loop counter values.
Definition at line 376 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
|
mutableprotected |
Denotes if iterator is entirely within bounds
Definition at line 368 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
|
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 373 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLoop().
|
protected |
Array of loop counters used during iteration.
Definition at line 358 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex(), itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLoop().
|
protected |
Does the specified region need to worry about boundary conditions?
Definition at line 382 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetNeedToUseBoundaryCondition(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetNeedToUseBoundaryCondition().
|
protected |
The region over which iteration is defined.
Definition at line 361 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.
Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetRegion().