itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference
[Image Iterators]
#include <itkConstShapedNeighborhoodIterator.h>
Detailed Description
template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
class itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >
Const version of ShapedNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image.
ConstShapedNeighborhoodIterator implements the read-only methods of ShapedNeighborhoodIterator. A "shaped" neighborhood iterator is one that allows you to specify which neighbor elements are active and which are inactive. See ShapedNeighborhoodIterator for more information.
- See also:
- Neighborhood
- MORE INFORMATION
- For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from http://www.itk.org.
- See also:
- ImageConstIterator
ConstShapedNeighborhoodIterator
CorrespondenceDataStructureIterator
FloodFilledFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalIterator
FloodFilledSpatialFunctionConditionalConstIterator
FloodFilledSpatialFunctionConditionalIterator
ImageLinearConstIteratorWithIndex
ImageRandomConstIteratorWithIndex
ImageRegionConstIteratorWithIndex
ImageRegionExclusionConstIteratorWithIndex
ImageRegionExclusionIteratorWithIndex
ImageRegionReverseConstIterator
- Examples:
Definition at line 70 of file itkConstShapedNeighborhoodIterator.h.
Member Typedef Documentation
| typedef TBoundaryCondition itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType |
Typedef for boundary condition type.
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 107 of file itkConstShapedNeighborhoodIterator.h.
| typedef ImageBoundaryCondition<ImageType>* itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType |
Typedef for generic boundary condition pointer
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 110 of file itkConstShapedNeighborhoodIterator.h.
| typedef TImage itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType |
Typedef support for common objects
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 94 of file itkConstShapedNeighborhoodIterator.h.
| typedef std::list<unsigned int> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListType |
An stl storage container type that can be sorted. The type used for the list of active offsets in the neighborhood.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 104 of file itkConstShapedNeighborhoodIterator.h.
| typedef Index<itkGetStaticConstMacro(Dimension)> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType |
Typedef support for common objects
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 96 of file itkConstShapedNeighborhoodIterator.h.
| typedef IndexType::IndexValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexValueType |
Typedef support for common objects
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 97 of file itkConstShapedNeighborhoodIterator.h.
| typedef TImage::InternalPixelType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType |
Extract image type information.
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 76 of file itkConstShapedNeighborhoodIterator.h.
| typedef Neighborhood<PixelType, itkGetStaticConstMacro(Dimension)> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType |
Typedef support for common objects
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 99 of file itkConstShapedNeighborhoodIterator.h.
| typedef Superclass::OffsetType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType |
Inherit typedefs from superclass
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 87 of file itkConstShapedNeighborhoodIterator.h.
| typedef OffsetType::OffsetValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType |
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 88 of file itkConstShapedNeighborhoodIterator.h.
| typedef TImage::PixelType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType |
External support for pixel type.
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 77 of file itkConstShapedNeighborhoodIterator.h.
| typedef Superclass::RadiusType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType |
Radius typedef support.
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 89 of file itkConstShapedNeighborhoodIterator.h.
| typedef TImage::RegionType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType |
Typedef support for common objects
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 95 of file itkConstShapedNeighborhoodIterator.h.
| typedef ConstShapedNeighborhoodIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Self |
Standard class typedefs.
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 83 of file itkConstShapedNeighborhoodIterator.h.
| typedef Superclass::SizeType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType |
Size and value typedef support.
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 90 of file itkConstShapedNeighborhoodIterator.h.
| typedef Superclass::SizeValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType |
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 91 of file itkConstShapedNeighborhoodIterator.h.
| typedef NeighborhoodIterator<TImage, TBoundaryCondition> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass |
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 84 of file itkConstShapedNeighborhoodIterator.h.
Constructor & Destructor Documentation
| itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator | ( | ) | [inline] |
Default constructor
Definition at line 210 of file itkConstShapedNeighborhoodIterator.h.
| virtual itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstShapedNeighborhoodIterator | ( | ) | [inline, virtual] |
Virtual destructor
Definition at line 220 of file itkConstShapedNeighborhoodIterator.h.
| itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator | ( | const SizeType & | radius, | |
| const ImageType * | ptr, | |||
| const RegionType & | region | |||
| ) | [inline] |
Constructor which establishes the region size, neighborhood, and image over which to walk.
Definition at line 224 of file itkConstShapedNeighborhoodIterator.h.
| itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator | ( | const ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > & | ) | [protected] |
Copy constructor
Member Function Documentation
| virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateIndex | ( | const unsigned | int | ) | [protected, virtual] |
Class is protected here so that it is not publicly accessible, but can be accessed by subclasses.. Add/Remove a neighborhood index to/from the active. Locations in the active list are the only accessible elements in the neighborhood. The argument is an index location calculated as an offset into a linear array which represents the image region defined by the radius of this iterator, with the smallest dimension as the fastest increasing index.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
| virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffset | ( | const OffsetType & | off | ) | [inline, virtual] |
Add/Remove a neighborhood offset (from the center of the neighborhood) to/from the active list. Active list offsets are the only locations updated and accessible through the iterator.
Definition at line 289 of file itkConstShapedNeighborhoodIterator.h.
| const ConstIterator& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Begin | ( | ) | const [inline] |
Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Definition at line 201 of file itkConstShapedNeighborhoodIterator.h.
| virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ClearActiveList | ( | ) | [inline, virtual] |
Removes all active pixels from this neighborhood.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 296 of file itkConstShapedNeighborhoodIterator.h.
| virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateIndex | ( | const unsigned | int | ) | [protected, virtual] |
Class is protected here so that it is not publicly accessible, but can be accessed by subclasses.. Add/Remove a neighborhood index to/from the active. Locations in the active list are the only accessible elements in the neighborhood. The argument is an index location calculated as an offset into a linear array which represents the image region defined by the radius of this iterator, with the smallest dimension as the fastest increasing index.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
| virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateOffset | ( | const OffsetType & | off | ) | [inline, virtual] |
Add/Remove a neighborhood offset (from the center of the neighborhood) to/from the active list. Active list offsets are the only locations updated and accessible through the iterator.
Definition at line 291 of file itkConstShapedNeighborhoodIterator.h.
| const ConstIterator& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::End | ( | ) | const [inline] |
Returns a const iterator for the neighborhood which points to the last pixel in the neighborhood.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 206 of file itkConstShapedNeighborhoodIterator.h.
| const IndexListType& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexList | ( | ) | const [inline] |
Returns the list of active indicies in the neighborhood
Definition at line 306 of file itkConstShapedNeighborhoodIterator.h.
| IndexListType::size_type itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexListSize | ( | ) | const [inline] |
Returns the size of the list of active neighborhood indicies.
Definition at line 310 of file itkConstShapedNeighborhoodIterator.h.
| itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::itkStaticConstMacro | ( | Dimension | , | |
| unsigned | int, | |||
| TImage::ImageDimension | ||||
| ) |
Save the image dimension.
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
| Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator++ | ( | ) |
Reimplements the operator++ method so that only active pixel locations are updated.
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
| Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator+= | ( | const OffsetType & | ) |
Addition of an itk::Offset. Note that this method does not do any bounds checking. Adding an offset that moves the iterator out of its assigned region will produce undefined results.
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
| Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator-- | ( | ) |
Reimplements the operator-- method so that only active pixel locations are updated.
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
| Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator-= | ( | const OffsetType & | ) |
Subtraction of an itk::Offset. Note that this method does not do any bounds checking. Subtracting an offset that moves the iterator out of its assigned region will produce undefined results.
Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.
| Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator= | ( | const Self & | orig | ) | [inline] |
Assignment operator
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 270 of file itkConstShapedNeighborhoodIterator.h.
| virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf | ( | std::ostream & | , | |
| Indent | ||||
| ) | const [virtual] |
Standard itk print method
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Friends And Related Function Documentation
friend struct ConstIterator [friend] |
Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.
Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< TImage >.
Definition at line 340 of file itkConstShapedNeighborhoodIterator.h.
Member Data Documentation
IndexListType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ActiveIndexList [protected] |
Definition at line 357 of file itkConstShapedNeighborhoodIterator.h.
bool itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive [protected] |
Definition at line 356 of file itkConstShapedNeighborhoodIterator.h.
ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstBeginIterator [protected] |
Definition at line 359 of file itkConstShapedNeighborhoodIterator.h.
ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstEndIterator [protected] |
Definition at line 358 of file itkConstShapedNeighborhoodIterator.h.
The documentation for this class was generated from the following file:
