lsst::afw::geom::SpanPixelIterator Class Reference

An iterator that yields Point2I and increases in the x direction. More...

#include <SpanPixelIterator.h>

Inheritance diagram for lsst::afw::geom::SpanPixelIterator:

Public Member Functions
	SpanPixelIterator (Point2I const &p=Point2I())

Private Member Functions
Point2I const &	dereference () const
void	increment ()
void	decrement ()
void	advance (int n)
bool	equal (SpanPixelIterator const &other) const
int	distance_to (SpanPixelIterator const &other) const

Private Attributes
Point2I	_p

Friends
class	boost::iterator_core_access

Detailed Description

An iterator that yields Point2I and increases in the x direction.

This is used to iterate over the pixels in a Span, and by extension to iterate over regions like boxes and ellipses.

Definition at line 40 of file SpanPixelIterator.h.

Constructor & Destructor Documentation

lsst::afw::geom::SpanPixelIterator::SpanPixelIterator ( Point2I const &  p = Point2I() )

inlineexplicit

Definition at line 45 of file SpanPixelIterator.h.

: _p(p) {}

Member Function Documentation

void lsst::afw::geom::SpanPixelIterator::advance ( int  n )

inlineprivate

Definition at line 57 of file SpanPixelIterator.h.

{ _p.getX() += n; }

void lsst::afw::geom::SpanPixelIterator::decrement ( )

inlineprivate

Definition at line 55 of file SpanPixelIterator.h.

{ --_p.getX(); }

Point2I const& lsst::afw::geom::SpanPixelIterator::dereference ( ) const

inlineprivate

Definition at line 51 of file SpanPixelIterator.h.

{ return _p; }

int lsst::afw::geom::SpanPixelIterator::distance_to ( SpanPixelIterator const &  other ) const

inlineprivate

Definition at line 63 of file SpanPixelIterator.h.

                                                           {
        assert(other._p.getY() == _p.getY());
        return other._p.getX() - _p.getX();
    }

bool lsst::afw::geom::SpanPixelIterator::equal ( SpanPixelIterator const &  other ) const

inlineprivate

Definition at line 59 of file SpanPixelIterator.h.

                                                      {
        return _p.getX() == other._p.getX() && _p.getY() == other._p.getY();
    }

void lsst::afw::geom::SpanPixelIterator::increment ( )

inlineprivate

Definition at line 53 of file SpanPixelIterator.h.

{ ++_p.getX(); }

Friends And Related Function Documentation

friend class boost::iterator_core_access

friend

Definition at line 49 of file SpanPixelIterator.h.

Member Data Documentation

Point2I lsst::afw::geom::SpanPixelIterator::_p

private

Definition at line 68 of file SpanPixelIterator.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/SpanPixelIterator.h