lsst::geom::Box2I Class Reference

An integer coordinate rectangle. More...

#include <Box.h>

Public Types
enum	EdgeHandlingEnum { EXPAND , SHRINK }
typedef Point2I	Point
typedef Extent2I	Extent
typedef int	Element
using	Interval = IntervalI

Public Member Functions
	Box2I () noexcept
	Construct an empty box.
	Box2I (Point2I const &minimum, Point2I const &maximum, bool invert=true)
	Construct a box from its minimum and maximum points.
	Box2I (Point2I const &corner, Extent2I const &dimensions, bool invert=true)
	Construct a box from one corner and dimensions.
	Box2I (Interval const &x, Interval const &y)
	Construct a box from a pair of intervals.
	Box2I (Box2D const &other, EdgeHandlingEnum edgeHandling=EXPAND)
	Construct an integer box from a floating-point box.
	Box2I (Box2I const &) noexcept=default
	Standard copy constructor.
	Box2I (Box2I &&) noexcept=default
	~Box2I () noexcept=default
void	swap (Box2I &other) noexcept
Box2I &	operator= (Box2I const &) noexcept=default
	Standard assignment operator.
Box2I &	operator= (Box2I &&) noexcept=default
Min/Max Accessors
Return the minimum and maximum coordinates of the box (inclusive).
Point2I const	getMin () const noexcept
int	getMinX () const noexcept
int	getMinY () const noexcept
Point2I const	getMax () const noexcept
int	getMaxX () const noexcept
int	getMaxY () const noexcept
Begin/End Accessors
Return STL-style begin (inclusive) and end (exclusive) coordinates for the box.
Point2I const	getBegin () const noexcept
int	getBeginX () const noexcept
int	getBeginY () const noexcept
Point2I const	getEnd () const noexcept
int	getEndX () const noexcept
int	getEndY () const noexcept
Size Accessors
Return the size of the box in pixels.
Extent2I const	getDimensions () const noexcept
int	getWidth () const noexcept
int	getHeight () const noexcept
int	getArea () const

Static Public Member Functions
static Box2I	makeCenteredBox (Point2D const &center, Extent const &size)
	Create a box centered as closely as possible on a particular point.

Center Accessors
Return the center coordinate of the box.
Point2D const	getCenter () const noexcept
	1-d interval accessors
double	getCenterX () const noexcept
	1-d interval accessors
double	getCenterY () const noexcept
	1-d interval accessors
Interval	getX () const
	1-d interval accessors
Interval	getY () const
	1-d interval accessors
ndarray::View< boost::fusion::vector2< ndarray::index::Range, ndarray::index::Range > >	getSlices () const
	Return slices to extract the box's region from an ndarray::Array.
bool	isEmpty () const noexcept
	Return true if the box contains no points.
bool	contains (Point2I const &point) const noexcept
	Return true if the box contains the point.
bool	contains (Element x, Element y) const noexcept
	1-d interval accessors
bool	contains (Box2I const &other) const noexcept
	Return true if all points contained by other are also contained by this.
bool	overlaps (Box2I const &other) const noexcept
	Return true if any points in other are also in this.
bool	intersects (Box2I const &other) const noexcept
	1-d interval accessors
bool	isDisjointFrom (Box2I const &other) const noexcept
	Return true if there are no points in both this and other.
void	grow (int buffer)
	Increase the size of the box by the given buffer amount in all directions.
void	grow (Extent2I const &buffer)
	Increase the size of the box by the given buffer amount in each direction.
void	shift (Extent2I const &offset)
	Shift the position of the box by the given offset.
void	flipLR (int xExtent)
	Flip a bounding box about the y-axis given a parent box of extent (xExtent).
void	flipTB (int yExtent)
	Flip a bounding box about the x-axis given a parent box of extent (yExtent).
void	include (Point2I const &point)
	Expand this to ensure that this->contains(point).
void	include (Box2I const &other)
	Expand this to ensure that this->contains(other).
void	clip (Box2I const &other) noexcept
	Shrink this to ensure that other.contains(*this).
Box2I	dilatedBy (Extent const &buffer) const
	Increase the size of the box by the given amount(s) on all sides (returning a new object).
Box2I	dilatedBy (Element buffer) const
	1-d interval accessors
Box2I	erodedBy (Extent const &buffer) const
	Decrease the size of the box by the given amount(s) on all sides (returning a new object).
Box2I	erodedBy (Element buffer) const
	1-d interval accessors
Box2I	shiftedBy (Extent const &offset) const
	Shift the position of the box by the given offset (returning a new object).
Box2I	reflectedAboutX (Element x) const
	Reflect the box about a vertical line (returning a new object).
Box2I	reflectedAboutY (Element y) const
	Reflect the box about a horizontal line (returning a new object).
Box2I	expandedTo (Point const &other) const
	Expand the box to ensure that contains(other) is true (returning a new object).
Box2I	expandedTo (Box2I const &other) const
	1-d interval accessors
Box2I	clippedTo (Box2I const &other) const noexcept
	Shrink an interval to ensure that it is contained by other (returning a new object).
bool	operator== (Box2I const &other) const noexcept
	Compare two boxes for equality.
bool	operator!= (Box2I const &other) const noexcept
	Compare two boxes for equality.
std::size_t	hash_value () const noexcept
	Return a hash of this object.
std::vector< Point2I >	getCorners () const
	Get the corner points.
std::string	toString () const
	1-d interval accessors

Detailed Description

An integer coordinate rectangle.

Box2I is an inclusive box that represents a rectangular region of pixels. A box never has negative dimensions; the empty box is defined to have zero-size dimensions, and is treated as though it does not have a well-defined position (regardless of the return value of getMin() or getMax() for an empty box).

Definition at line 55 of file Box.h.

Member Typedef Documentation

Element

typedef int lsst::geom::Box2I::Element

Definition at line 59 of file Box.h.

Extent

typedef Extent2I lsst::geom::Box2I::Extent

Definition at line 58 of file Box.h.

Interval

using lsst::geom::Box2I::Interval = IntervalI

Definition at line 61 of file Box.h.

Point

typedef Point2I lsst::geom::Box2I::Point

Definition at line 57 of file Box.h.

Member Enumeration Documentation

EdgeHandlingEnum

enum lsst::geom::Box2I::EdgeHandlingEnum

Enumerator
EXPAND
SHRINK

Definition at line 63 of file Box.h.

{ EXPAND, SHRINK };

Constructor & Destructor Documentation

Box2I() [1/7]

lsst::geom::Box2I::Box2I ( )

inlinenoexcept

Construct an empty box.

Definition at line 66 of file Box.h.

: _minimum(0), _dimensions(0) {}

Box2I() [2/7]

lsst::geom::Box2I::Box2I	(	Point2I const &	minimum,
		Point2I const &	maximum,
		bool	invert = true )

Construct a box from its minimum and maximum points.

Parameters

[in]	minimum	Minimum (lower left) coordinate (inclusive).
[in]	maximum	Maximum (upper right) coordinate (inclusive).
[in]	invert	If true (default), swap the minimum and maximum coordinates if minimum > maximum instead of creating an empty box.

Definition at line 31 of file Box.cc.

        : _minimum(minimum), _dimensions(maximum - minimum) {
    for (int n = 0; n < 2; ++n) {
        if (_dimensions[n] < 0) {
            if (invert) {
                _minimum[n] += _dimensions[n];
                _dimensions[n] = -_dimensions[n];
            } else {
                *this = Box2I();
                return;
            }
        }
    }
    _dimensions += Extent2I(1);
}

Box2I() [3/7]

lsst::geom::Box2I::Box2I	(	Point2I const &	corner,
		Extent2I const &	dimensions,
		bool	invert = true )

Construct a box from one corner and dimensions.

Parameters

[in]	corner	Reference coordinate. This is the lower left corner if both dimensions are positive, but a right corner or upper corner if the corresponding dimension is negative and invert is set.
[in]	dimensions	Box dimensions. If either dimension coordinate is 0, the box will be empty.
[in]	invert	If true (default), invert any negative dimensions instead of creating an empty box.

Exceptions

lsst::pex::exceptions::OverflowError

Thrown if the maximum Point2I would overflow.

Definition at line 47 of file Box.cc.

        : _minimum(corner), _dimensions(dimensions) {
    for (int n = 0; n < 2; ++n) {
        if (_dimensions[n] == 0) {
            *this = Box2I();
            return;
        } else if (_dimensions[n] < 0) {
            if (invert) {
                _minimum[n] += (_dimensions[n] + 1);
                _dimensions[n] = -_dimensions[n];
            } else {
                *this = Box2I();
                return;
            }
        }
    }
    if (!isEmpty() && any(getMin().gt(getMax()))) {
        throw LSST_EXCEPT(pex::exceptions::OverflowError,
                          "Box dimensions too large; integer overflow detected.");
    }
}

Box2I() [4/7]

lsst::geom::Box2I::Box2I ( Interval const & x, Interval const & y )

inline

Construct a box from a pair of intervals.

Parameters

[in]	x	Extent in x direction.
[in]	y	Extent in y direction.

Definition at line 98 of file Box.h.

                                                  :
        Box2I(Point(x.getMin(), y.getMin()), Point(x.getMax(), y.getMax()), false)
    {}

Box2I() [5/7]

lsst::geom::Box2I::Box2I ( Box2D const & other, EdgeHandlingEnum edgeHandling = EXPAND )

explicit

Construct an integer box from a floating-point box.

Floating-point to integer box conversion is based on the concept that a pixel is not an infinitesimal point but rather a square of unit size centered on integer-valued coordinates. Converting a floating-point box to an integer box thus requires a choice on how to handle pixels which are only partially contained by the input floating-point box.

Parameters

[in]	other	A floating-point box to convert.
[in]	edgeHandling	If EXPAND, the integer box will contain any pixels that overlap the floating-point box. If SHRINK, the integer box will contain only pixels completely contained by the floating-point box.

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if other is not finite.

Definition at line 88 of file Box.cc.

                                                              :
    Box2I(IntervalI(other.getX(), translateEdgeHandling(edgeHandling)),
          IntervalI(other.getY(), translateEdgeHandling(edgeHandling)))
{}

Box2I() [6/7]

lsst::geom::Box2I::Box2I ( Box2I const & )

defaultnoexcept

Standard copy constructor.

Box2I() [7/7]

lsst::geom::Box2I::Box2I ( Box2I && )

defaultnoexcept

~Box2I()

lsst::geom::Box2I::~Box2I ( )

defaultnoexcept

Member Function Documentation

clip()

void lsst::geom::Box2I::clip ( Box2I const & other )

noexcept

Shrink this to ensure that other.contains(*this).

In particular, if other and this box do not overlap this box will become empty.

Parameters

other

the box that must contain this one

Definition at line 189 of file Box.cc.

                                            {
    if (isEmpty()) return;
    if (other.isEmpty()) {
        *this = Box2I();
        return;
    }
    Point2I maximum(getMax());
    Point2I const& otherMin = other.getMin();
    Point2I const otherMax = other.getMax();
    for (int n = 0; n < 2; ++n) {
        if (otherMin[n] > _minimum[n]) {
            _minimum[n] = otherMin[n];
        }
        if (otherMax[n] < maximum[n]) {
            maximum[n] = otherMax[n];
        }
    }
    if (any(maximum.lt(_minimum))) {
        *this = Box2I();
        return;
    }
    _dimensions = Extent2I(1) + maximum - _minimum;
}

clippedTo()

Box2I lsst::geom::Box2I::clippedTo ( Box2I const & other ) const

noexcept

Shrink an interval to ensure that it is contained by other (returning a new object).

In particular, if other and this interval do not overlap this interval will become empty.

Definition at line 243 of file Box.cc.

                                                        {
    return Box2I(getX().clippedTo(other.getX()),
                 getY().clippedTo(other.getY()));
}

contains() [1/3]

bool lsst::geom::Box2I::contains ( Box2I const & other ) const

noexcept

Return true if all points contained by other are also contained by this.

An empty box is contained by every other box, including other empty boxes.

Definition at line 118 of file Box.cc.

                                                      {
    return getX().contains(other.getX()) && getY().contains(other.getY());
}

contains() [2/3]

bool lsst::geom::Box2I::contains ( Element x, Element y ) const

inlinenoexcept

1-d interval accessors

Definition at line 218 of file Box.h.

{ return contains(Point2I(x, y)); }

contains() [3/3]

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

noexcept

Return true if the box contains the point.

Definition at line 114 of file Box.cc.

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

dilatedBy() [1/2]

Box2I lsst::geom::Box2I::dilatedBy ( Element buffer ) const

inline

1-d interval accessors

Definition at line 295 of file Box.h.

                                          {
        return dilatedBy(Extent(buffer, buffer));
    }

dilatedBy() [2/2]

Box2I lsst::geom::Box2I::dilatedBy

(

Extent const &

buffer

)

const

Increase the size of the box by the given amount(s) on all sides (returning a new object).

If buffer is negative, this is equivalent to eroding by -buffer.

If a final dimension of the box is less than or equal to zero, the new box will be empty.

Empty boxes remain empty after dilation.

Definition at line 213 of file Box.cc.

                                                 {
    return Box2I(getX().dilatedBy(buffer.getX()),
                 getY().dilatedBy(buffer.getY()));
}

erodedBy() [1/2]

Box2I lsst::geom::Box2I::erodedBy ( Element buffer ) const

inline

1-d interval accessors

Definition at line 313 of file Box.h.

{ return dilatedBy(-buffer); }

erodedBy() [2/2]

Box2I lsst::geom::Box2I::erodedBy ( Extent const & buffer ) const

inline

Decrease the size of the box by the given amount(s) on all sides (returning a new object).

If buffer is negative, this is equivalent to dilating by -buffer.

If a final dimension of the box is less than or equal to zero, the new box will be empty.

Empty boxes remain empty after erosion.

Definition at line 312 of file Box.h.

{ return dilatedBy(-buffer); }

expandedTo() [1/2]

Box2I lsst::geom::Box2I::expandedTo

(

Box2I const &

other

)

const

1-d interval accessors

Definition at line 238 of file Box.cc.

                                                 {
    return Box2I(getX().expandedTo(other.getX()),
                 getY().expandedTo(other.getY()));
}

expandedTo() [2/2]

Box2I lsst::geom::Box2I::expandedTo

(

Point const &

other

)

const

Expand the box to ensure that contains(other) is true (returning a new object).

Expanding an empty box with a single point yields an box with size=1 at that point; expanding an empty box with a second box is equivalent to assignment.

Definition at line 233 of file Box.cc.

                                                 {
    return Box2I(getX().expandedTo(other.getX()),
                 getY().expandedTo(other.getY()));
}

flipLR()

void lsst::geom::Box2I::flipLR

(

int

xExtent

)

Flip a bounding box about the y-axis given a parent box of extent (xExtent).

Definition at line 138 of file Box.cc.

                              {
    if (isEmpty()) return;  // should we throw an exception here instead of a no-op?
    // Apply flip about y-axis assumine parent coordinate system
    _minimum[0] = xextent - (_minimum[0] + _dimensions[0]);
    // _dimensions should remain unchanged
}

flipTB()

void lsst::geom::Box2I::flipTB

(

int

yExtent

)

Flip a bounding box about the x-axis given a parent box of extent (yExtent).

Definition at line 145 of file Box.cc.

                              {
    if (isEmpty()) return;  // should we throw an exception here instead of a no-op?
    // Apply flip about y-axis assumine parent coordinate system
    _minimum[1] = yextent - (_minimum[1] + _dimensions[1]);
    // _dimensions should remain unchanged
}

getArea()

int lsst::geom::Box2I::getArea ( ) const

inline

Definition at line 189 of file Box.h.

{ return getWidth() * getHeight(); }

getBegin()

Point2I const lsst::geom::Box2I::getBegin ( ) const

inlinenoexcept

Definition at line 171 of file Box.h.

{ return _minimum; }

getBeginX()

int lsst::geom::Box2I::getBeginX ( ) const

inlinenoexcept

Definition at line 172 of file Box.h.

{ return _minimum.getX(); }

getBeginY()

int lsst::geom::Box2I::getBeginY ( ) const

inlinenoexcept

Definition at line 173 of file Box.h.

{ return _minimum.getY(); }

getCenter()

Point2D const lsst::geom::Box2I::getCenter ( ) const

noexcept

1-d interval accessors

Definition at line 93 of file Box.cc.

                                              {
    return Box2D(*this).getCenter();
}

getCenterX()

double lsst::geom::Box2I::getCenterX ( ) const

inlinenoexcept

1-d interval accessors

Definition at line 199 of file Box.h.

{ return this->getCenter().getX(); }

getCenterY()

double lsst::geom::Box2I::getCenterY ( ) const

inlinenoexcept

1-d interval accessors

Definition at line 200 of file Box.h.

{ return this->getCenter().getY(); }

getCorners()

std::vector< Point2I > lsst::geom::Box2I::getCorners

(

)

const

Get the corner points.

The order is counterclockise, starting from the lower left corner, i.e.: (minX, minY), (maxX, maxY), (maxX, maxX), (minX, maxY)

Definition at line 261 of file Box.cc.

                                           {
    std::vector<Point2I> retVec;
    retVec.push_back(getMin());
    retVec.push_back(Point2I(getMaxX(), getMinY()));
    retVec.push_back(getMax());
    retVec.push_back(Point2I(getMinX(), getMaxY()));
    return retVec;
}

getDimensions()

Extent2I const lsst::geom::Box2I::getDimensions ( ) const

inlinenoexcept

Definition at line 186 of file Box.h.

{ return _dimensions; }

getEnd()

Point2I const lsst::geom::Box2I::getEnd ( ) const

inlinenoexcept

Definition at line 175 of file Box.h.

{ return _minimum + _dimensions; }

getEndX()

int lsst::geom::Box2I::getEndX ( ) const

inlinenoexcept

Definition at line 176 of file Box.h.

{ return _minimum.getX() + _dimensions.getX(); }

getEndY()

int lsst::geom::Box2I::getEndY ( ) const

inlinenoexcept

Definition at line 177 of file Box.h.

{ return _minimum.getY() + _dimensions.getY(); }

getHeight()

int lsst::geom::Box2I::getHeight ( ) const

inlinenoexcept

Definition at line 188 of file Box.h.

{ return _dimensions.getY(); }

getMax()

Point2I const lsst::geom::Box2I::getMax ( ) const

inlinenoexcept

Definition at line 160 of file Box.h.

{ return _minimum + _dimensions - Extent2I(1); }

getMaxX()

int lsst::geom::Box2I::getMaxX ( ) const

inlinenoexcept

Definition at line 161 of file Box.h.

{ return _minimum.getX() + _dimensions.getX() - 1; }

getMaxY()

int lsst::geom::Box2I::getMaxY ( ) const

inlinenoexcept

Definition at line 162 of file Box.h.

{ return _minimum.getY() + _dimensions.getY() - 1; }

getMin()

Point2I const lsst::geom::Box2I::getMin ( ) const

inlinenoexcept

Definition at line 156 of file Box.h.

{ return _minimum; }

getMinX()

int lsst::geom::Box2I::getMinX ( ) const

inlinenoexcept

Definition at line 157 of file Box.h.

{ return _minimum.getX(); }

getMinY()

int lsst::geom::Box2I::getMinY ( ) const

inlinenoexcept

Definition at line 158 of file Box.h.

{ return _minimum.getY(); }

getSlices()

ndarray::View< boost::fusion::vector2< ndarray::index::Range, ndarray::index::Range > > lsst::geom::Box2I::getSlices

(

)

const

Return slices to extract the box's region from an ndarray::Array.

Definition at line 109 of file Box.cc.

              {
    return ndarray::view(getBeginY(), getEndY())(getBeginX(), getEndX());
}

getWidth()

int lsst::geom::Box2I::getWidth ( ) const

inlinenoexcept

Definition at line 187 of file Box.h.

{ return _dimensions.getX(); }

getX()

Interval lsst::geom::Box2I::getX ( ) const

inline

1-d interval accessors

Definition at line 205 of file Box.h.

{ return Interval::fromMinSize(getMinX(), getWidth()); }

getY()

Interval lsst::geom::Box2I::getY ( ) const

inline

1-d interval accessors

Definition at line 206 of file Box.h.

{ return Interval::fromMinSize(getMinY(), getHeight()); }

grow() [1/2]

void lsst::geom::Box2I::grow

(

Extent2I const &

buffer

)

Increase the size of the box by the given buffer amount in each direction.

If a negative buffer is passed and the final size of the box is less than or equal to zero, the box will be made empty.

Definition at line 130 of file Box.cc.

                                       {
    *this = dilatedBy(buffer);
}

grow() [2/2]

void lsst::geom::Box2I::grow ( int buffer )

inline

Increase the size of the box by the given buffer amount in all directions.

If a negative buffer is passed and the final size of the box is less than or equal to zero, the box will be made empty.

Definition at line 249 of file Box.h.

{ grow(Extent2I(buffer)); }

hash_value()

std::size_t lsst::geom::Box2I::hash_value ( ) const

noexcept

Return a hash of this object.

Definition at line 256 of file Box.cc.

                                           {
    // Completely arbitrary seed
    return cpputils::hashCombine(17, _minimum, _dimensions);
}

include() [1/2]

void lsst::geom::Box2I::include

(

Box2I const &

other

)

Expand this to ensure that this->contains(other).

Definition at line 169 of file Box.cc.

                                      {
    if (other.isEmpty()) return;
    if (this->isEmpty()) {
        *this = other;
        return;
    }
    Point2I maximum(getMax());
    Point2I const& otherMin = other.getMin();
    Point2I const otherMax = other.getMax();
    for (int n = 0; n < 2; ++n) {
        if (otherMin[n] < _minimum[n]) {
            _minimum[n] = otherMin[n];
        }
        if (otherMax[n] > maximum[n]) {
            maximum[n] = otherMax[n];
        }
    }
    _dimensions = Extent2I(1) + maximum - _minimum;
}

include() [2/2]

void lsst::geom::Box2I::include

(

Point2I const &

point

)

Expand this to ensure that this->contains(point).

Definition at line 152 of file Box.cc.

                                        {
    if (isEmpty()) {
        _minimum = point;
        _dimensions = Extent2I(1);
        return;
    }
    Point2I maximum(getMax());
    for (int n = 0; n < 2; ++n) {
        if (point[n] < _minimum[n]) {
            _minimum[n] = point[n];
        } else if (point[n] > maximum[n]) {
            maximum[n] = point[n];
        }
    }
    _dimensions = Extent2I(1) + maximum - _minimum;
}

intersects()

bool lsst::geom::Box2I::intersects ( Box2I const & other ) const

inlinenoexcept

1-d interval accessors

Definition at line 235 of file Box.h.

{ return overlaps(other); }

isDisjointFrom()

bool lsst::geom::Box2I::isDisjointFrom ( Box2I const & other ) const

noexcept

Return true if there are no points in both this and other.

Definition at line 126 of file Box.cc.

                                                            {
    return getX().isDisjointFrom(other.getX()) || getY().isDisjointFrom(other.getY());
}

isEmpty()

bool lsst::geom::Box2I::isEmpty ( ) const

inlinenoexcept

Return true if the box contains no points.

Definition at line 213 of file Box.h.

{ return _dimensions.getX() == 0 && _dimensions.getY() == 0; }

makeCenteredBox()

Box2I lsst::geom::Box2I::makeCenteredBox ( Point2D const & center, Box2I::Extent const & size )

static

Create a box centered as closely as possible on a particular point.

Parameters

center	The desired center of the box.
size	The desired width and height (in that order) of the box.

Returns

if size is positive, a box with size size; otherwise, an empty box. If the returned box is not empty, its center shall be within half a pixel of center in either dimension.

Exceptions

lsst::pex::exceptions::OverflowError	Thrown if the resulting box would overflow.
lsst::pex::exceptions::InvalidParameterError	Thrown if center is not finite.

Definition at line 97 of file Box.cc.

                                                                           {
    if (!std::isfinite(center[0]) || !std::isfinite(center[1])) {
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError, "Cannot make Box2I with non-finite center");
    }
 
    lsst::geom::Point2D corner(center);
    corner.shift(-0.5 * lsst::geom::Extent2D(size));
    // compensate for Box2I's coordinate conventions (where max = min + size - 1)
    corner.shift(lsst::geom::Extent2D(0.5, 0.5));
    return lsst::geom::Box2I(lsst::geom::Point2I(corner), size, false);
}

operator!=()

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

noexcept

Compare two boxes for equality.

All empty boxes are equal.

Definition at line 252 of file Box.cc.

                                                        {
    return other._minimum != this->_minimum || other._dimensions != this->_dimensions;
}

operator=() [1/2]

Box2I & lsst::geom::Box2I::operator= ( Box2I && )

defaultnoexcept

operator=() [2/2]

Box2I & lsst::geom::Box2I::operator= ( Box2I const & )

defaultnoexcept

Standard assignment operator.

operator==()

bool lsst::geom::Box2I::operator== ( Box2I const & other ) const

noexcept

Compare two boxes for equality.

All empty boxes are equal.

Definition at line 248 of file Box.cc.

                                                        {
    return other._minimum == this->_minimum && other._dimensions == this->_dimensions;
}

overlaps()

bool lsst::geom::Box2I::overlaps ( Box2I const & other ) const

noexcept

Return true if any points in other are also in this.

Any overlap operation involving an empty box returns false.

Definition at line 122 of file Box.cc.

                                                      {
    return !isDisjointFrom(other);
}

reflectedAboutX()

Box2I lsst::geom::Box2I::reflectedAboutX

(

Element

x

)

const

Reflect the box about a vertical line (returning a new object).

Empty boxes remain empty when reflected.

Definition at line 223 of file Box.cc.

                                            {
    return Box2I(getX().reflectedAbout(x),
                 getY());
}

reflectedAboutY()

Box2I lsst::geom::Box2I::reflectedAboutY

(

Element

y

)

const

Reflect the box about a horizontal line (returning a new object).

Empty boxes remain empty when reflected.

Definition at line 228 of file Box.cc.

                                            {
    return Box2I(getX(),
                 getY().reflectedAbout(y));
}

shift()

void lsst::geom::Box2I::shift

(

Extent2I const &

offset

)

Shift the position of the box by the given offset.

Definition at line 134 of file Box.cc.

                                        {
    *this = shiftedBy(offset);
}

shiftedBy()

Box2I lsst::geom::Box2I::shiftedBy

(

Extent const &

offset

)

const

Shift the position of the box by the given offset (returning a new object).

Empty boxes remain empty when shifted.

Definition at line 218 of file Box.cc.

                                                 {
    return Box2I(getX().shiftedBy(offset.getX()),
                 getY().shiftedBy(offset.getY()));
}

swap()

void lsst::geom::Box2I::swap ( Box2I & other )

inlinenoexcept

Definition at line 141 of file Box.h.

                                     {
        _minimum.swap(other._minimum);
        _dimensions.swap(other._dimensions);
    }

toString()

std::string lsst::geom::Box2I::toString ( ) const

inline

1-d interval accessors

Definition at line 385 of file Box.h.

                               {
        return (boost::format("Box2I(%s,%s)") % _minimum.toString() % _dimensions.toString()).str();
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+5927e1bc1e/include/lsst/geom/Box.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+5927e1bc1e/src/Box.cc