A range of pixels within one row of an Image. More...

#include <Span.h>

Public Types
using	Iterator = SpanPixelIterator
	An iterator over points in the Span.

using	Interval = lsst::geom::IntervalI

Public Member Functions
	Span (int y, int x0, int x1)

	Span (Interval const &x, int y)

	Span () noexcept
	Construct an empty Span with zero width at the origin.

	Span (Span const &) noexcept=default

	Span (Span &&) noexcept=default

Span &	operator= (Span const &) noexcept=default

Span &	operator= (Span &&) noexcept=default

	~Span () noexcept=default

Iterator	begin () const noexcept
	Return an iterator to the first pixel in the Span.

Iterator	end () const noexcept
	Return an iterator to one past the last pixel in the Span.

int	getX0 () const noexcept
	Return the starting x-value.

int &	getX0 () noexcept
	Return the starting x-value.

int	getX1 () const noexcept
	Return the ending x-value.

int &	getX1 () noexcept
	Return the ending x-value.

Interval	getX () const noexcept

int	getY () const noexcept
	Return the y-value.

int &	getY () noexcept
	Return the y-value.

int	getWidth () const noexcept
	Return the number of pixels.

int	getMinX () const noexcept
	Minimum x-value.

int	getMaxX () const noexcept
	Maximum x-value.

int	getBeginX () const noexcept
	Begin (inclusive) x-value.

int	getEndX () const noexcept
	End (exclusive) x-value.

lsst::geom::Point2I const	getMin () const noexcept
	Point corresponding to minimum x.

lsst::geom::Point2I const	getMax () const noexcept
	Point corresponding to maximum x.

bool	contains (int x) const noexcept

bool	contains (int x, int y) const noexcept

bool	contains (lsst::geom::Point2I const &point) const noexcept

bool	isEmpty () const noexcept
	Return true if the span contains no pixels.

std::string	toString () const
	Return a string-representation of a Span.

void	shift (int dx, int dy) noexcept

bool	operator== (Span const &other) const noexcept

bool	operator!= (Span const &other) const noexcept

std::size_t	hash_value () const noexcept
	Return a hash of this object.

bool	operator< (const Span &b) const noexcept

Friends
class	detection::Footprint

std::ostream &	operator<< (std::ostream &os, Span const &span)
	Stream output; delegates to toString().

Detailed Description

A range of pixels within one row of an Image.

Definition at line 47 of file Span.h.

Member Typedef Documentation

◆ Interval

using lsst::afw::geom::Span::Interval = lsst::geom::IntervalI

Definition at line 52 of file Span.h.

◆ Iterator

using lsst::afw::geom::Span::Iterator = SpanPixelIterator

An iterator over points in the Span.

Definition at line 50 of file Span.h.

Constructor & Destructor Documentation

◆ Span() [1/5]

lsst::afw::geom::Span::Span	(	int	y,
		int	x0,
		int	x1 )

inline

Parameters

y	Row that Span's in
x0	Starting column (inclusive)
x1	Ending column (inclusive)

Definition at line 54 of file Span.h.

57 : _y(y), _x0(x0), _x1(x1) {}

y

int y

Definition SpanSet.cc:48

◆ Span() [2/5]

lsst::afw::geom::Span::Span	(	Interval const &	x,
		int	y )

inline

Definition at line 59 of file Span.h.

59: _y(y), _x0(x.getMin()), _x1(x.getMax()) {}

x

double x

Definition ChebyshevBoundedField.cc:276

◆ Span() [3/5]

lsst::afw::geom::Span::Span ( )

inlinenoexcept

Construct an empty Span with zero width at the origin.

Definition at line 62 of file Span.h.

62: _y(0), _x0(0), _x1(-1) {}

◆ Span() [4/5]

lsst::afw::geom::Span::Span ( Span const & )

defaultnoexcept

◆ Span() [5/5]

lsst::afw::geom::Span::Span ( Span && )

defaultnoexcept

◆ ~Span()

lsst::afw::geom::Span::~Span ( )

defaultnoexcept

Member Function Documentation

◆ begin()

Iterator lsst::afw::geom::Span::begin ( ) const

inlinenoexcept

Return an iterator to the first pixel in the Span.

Definition at line 71 of file Span.h.

71{ return Iterator(lsst::geom::Point2I(_x0, _y)); }

lsst::afw::geom::Span::Iterator

SpanPixelIterator Iterator

An iterator over points in the Span.

Definition Span.h:50

lsst::geom::Point< int, 2 >

◆ contains() [1/3]

bool lsst::afw::geom::Span::contains ( int x ) const

inlinenoexcept

Definition at line 95 of file Span.h.

95{ return (x >= _x0) && (x <= _x1); }

◆ contains() [2/3]

bool lsst::afw::geom::Span::contains	(	int	x,
		int	y ) const

inlinenoexcept

Definition at line 96 of file Span.h.

96{ return (x >= _x0) && (x <= _x1) && (y == _y); }

◆ contains() [3/3]

bool lsst::afw::geom::Span::contains ( lsst::geom::Point2I const & point ) const

inlinenoexcept

Definition at line 97 of file Span.h.

                                                               {
        return contains(point.getX(), point.getY());
    }

◆ end()

Iterator lsst::afw::geom::Span::end ( ) const

inlinenoexcept

Return an iterator to one past the last pixel in the Span.

Definition at line 74 of file Span.h.

74{ return Iterator(lsst::geom::Point2I(_x1 + 1, _y)); }

◆ getBeginX()

int lsst::afw::geom::Span::getBeginX ( ) const

inlinenoexcept

Begin (inclusive) x-value.

Definition at line 86 of file Span.h.

◆ getEndX()

int lsst::afw::geom::Span::getEndX ( ) const

inlinenoexcept

End (exclusive) x-value.

Definition at line 87 of file Span.h.

◆ getMax()

lsst::geom::Point2I const lsst::afw::geom::Span::getMax ( ) const

inlinenoexcept

Point corresponding to maximum x.

Definition at line 91 of file Span.h.

◆ getMaxX()

int lsst::afw::geom::Span::getMaxX ( ) const

inlinenoexcept

Maximum x-value.

Definition at line 85 of file Span.h.

◆ getMin()

lsst::geom::Point2I const lsst::afw::geom::Span::getMin ( ) const

inlinenoexcept

Point corresponding to minimum x.

Definition at line 88 of file Span.h.

◆ getMinX()

int lsst::afw::geom::Span::getMinX ( ) const

inlinenoexcept

Minimum x-value.

Definition at line 84 of file Span.h.

◆ getWidth()

int lsst::afw::geom::Span::getWidth ( ) const

inlinenoexcept

Return the number of pixels.

Definition at line 83 of file Span.h.

◆ getX()

Interval lsst::afw::geom::Span::getX ( ) const

inlinenoexcept

Definition at line 80 of file Span.h.

80{ return Interval::fromMinMax(_x0, _x1); }

lsst::geom::IntervalI::fromMinMax

static IntervalI fromMinMax(Element min, Element max)

Construct an interval from its lower and upper bounds.

Definition Interval.cc:53

◆ getX0() [1/2]

int lsst::afw::geom::Span::getX0 ( ) const

inlinenoexcept

Return the starting x-value.

Definition at line 76 of file Span.h.

◆ getX0() [2/2]

int & lsst::afw::geom::Span::getX0 ( )

inlinenoexcept

Return the starting x-value.

Definition at line 77 of file Span.h.

◆ getX1() [1/2]

int lsst::afw::geom::Span::getX1 ( ) const

inlinenoexcept

Return the ending x-value.

Definition at line 78 of file Span.h.

◆ getX1() [2/2]

int & lsst::afw::geom::Span::getX1 ( )

inlinenoexcept

Return the ending x-value.

Definition at line 79 of file Span.h.

◆ getY() [1/2]

int lsst::afw::geom::Span::getY ( ) const

inlinenoexcept

Return the y-value.

Definition at line 81 of file Span.h.

◆ getY() [2/2]

int & lsst::afw::geom::Span::getY ( )

inlinenoexcept

Return the y-value.

Definition at line 82 of file Span.h.

◆ hash_value()

std::size_t lsst::afw::geom::Span::hash_value ( ) const

inlinenoexcept

Return a hash of this object.

Definition at line 122 of file Span.h.

                                          {
        // Completely arbitrary seed
        return cpputils::hashCombine(42, getY(), getMinX(), getMaxX());
    }

◆ isEmpty()

bool lsst::afw::geom::Span::isEmpty ( ) const

inlinenoexcept

Return true if the span contains no pixels.

Definition at line 102 of file Span.h.

102{ return _x1 < _x0; }

◆ operator!=()

bool lsst::afw::geom::Span::operator!= ( Span const & other ) const

inlinenoexcept

Definition at line 119 of file Span.h.

119{ return !(*this == other); }

◆ operator<()

bool lsst::afw::geom::Span::operator< ( const Span & b ) const

noexcept

Definition at line 32 of file Span.cc.

                                                 {
    if (_y < b._y) return true;
    if (_y > b._y) return false;
    // y equal; check x0...
    if (_x0 < b._x0) return true;
    if (_x0 > b._x0) return false;
    // x0 equal; check x1...
    if (_x1 < b._x1) return true;
    return false;
}

◆ operator=() [1/2]

Span & lsst::afw::geom::Span::operator= ( Span && )

defaultnoexcept

◆ operator=() [2/2]

Span & lsst::afw::geom::Span::operator= ( Span const & )

defaultnoexcept

◆ operator==()

bool lsst::afw::geom::Span::operator== ( Span const & other ) const

inlinenoexcept

Definition at line 116 of file Span.h.

                                                      {
        return other.getY() == getY() && other.getMinX() == getMinX() && other.getMaxX() == getMaxX();
    }

◆ shift()

void lsst::afw::geom::Span::shift	(	int	dx,
		int	dy )

inlinenoexcept

Definition at line 107 of file Span.h.

                                        {
        _x0 += dx;
        _x1 += dx;
        _y += dy;
    }

◆ toString()

std::string lsst::afw::geom::Span::toString ( ) const

Return a string-representation of a Span.

Definition at line 43 of file Span.cc.

43{ return str(boost::format("%d: %d..%d") % _y % _x0 % _x1); }

Friends And Related Symbol Documentation

◆ detection::Footprint

friend class detection::Footprint

friend

Definition at line 133 of file Span.h.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		Span const &	span )

friend

Stream output; delegates to toString().

Definition at line 114 of file Span.h.

114{ return os << span.toString(); }

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/geom/Span.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/src/geom/Span.cc

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ Interval

◆ Iterator

Constructor & Destructor Documentation

◆ Span() [1/5]

◆ Span() [2/5]

◆ Span() [3/5]

◆ Span() [4/5]

◆ Span() [5/5]

◆ ~Span()

Member Function Documentation

◆ begin()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ end()

◆ getBeginX()

◆ getEndX()

◆ getMax()

◆ getMaxX()

◆ getMin()

◆ getMinX()

◆ getWidth()

◆ getX()

◆ getX0() [1/2]

◆ getX0() [2/2]

◆ getX1() [1/2]

◆ getX1() [2/2]

◆ getY() [1/2]

◆ getY() [2/2]

◆ hash_value()

◆ isEmpty()

◆ operator!=()

◆ operator<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ shift()

◆ toString()

Friends And Related Symbol Documentation

◆ detection::Footprint

◆ operator<<