A floating-point coordinate rectangle geometry. More...

#include <Box.h>

Public Types
typedef Point2D	Point
typedef Extent2D	Extent
typedef double	Element
using	Interval = IntervalD

Public Member Functions
	Box2D () noexcept
	Construct an empty box.
	Box2D (Point2D const &minimum, Point2D const &maximum, bool invert=true) noexcept
	Construct a box from its minimum and maximum points.
	Box2D (Point2D const &corner, Extent2D const &dimensions, bool invert=true) noexcept
	Construct a box from one corner and dimensions.
	Box2D (Interval const &x, Interval const &y)
	Construct a box from a pair of intervals.
	Box2D (Box2I const &other) noexcept
	Construct a floating-point box from an integer box.
	Box2D (Box2D const &) noexcept=default
	Standard copy constructor.
	Box2D (Box2D &&) noexcept=default
	~Box2D () noexcept=default
void	swap (Box2D &other) noexcept
Box2D &	operator= (Box2D const &) noexcept=default
	Standard assignment operator.
Box2D &	operator= (Box2D &&) noexcept=default
Min/Max Accessors
Return the minimum (inclusive) and maximum (exclusive) coordinates of the box.
Point2D const	getMin () const noexcept
double	getMinX () const noexcept
double	getMinY () const noexcept
Point2D const	getMax () const noexcept
double	getMaxX () const noexcept
double	getMaxY () const noexcept
Size Accessors
Return the size of the box.
Extent2D const	getDimensions () const noexcept
	1-d interval accessors
double	getWidth () const noexcept
	1-d interval accessors
double	getHeight () const noexcept
	1-d interval accessors
double	getArea () const noexcept
	1-d interval accessors
Interval	getX () const
	1-d interval accessors
Interval	getY () const
	1-d interval accessors

Static Public Member Functions
static Box2D	makeCenteredBox (Point2D const &center, Extent const &size) noexcept
	Create a box centered on a particular point.

Static Public Attributes
static double const	EPSILON = std::numeric_limits<double>::epsilon() * 2
	Value the maximum coordinate is multiplied by to increase it by the smallest possible amount.
static double const	INVALID = std::numeric_limits<double>::quiet_NaN()
	Value used to specify undefined coordinate values.

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

Detailed Description

A floating-point coordinate rectangle geometry.

Box2D is a half-open (minimum is inclusive, maximum is exclusive) box. A box never has negative dimensions; the empty box is defined to zero-size dimensions and its minimum and maximum values set to NaN. Only the empty box may have zero-size dimensions.

Definition at line 413 of file Box.h.

Member Typedef Documentation

◆ Element

typedef double lsst::geom::Box2D::Element

Definition at line 417 of file Box.h.

◆ Extent

typedef Extent2D lsst::geom::Box2D::Extent

Definition at line 416 of file Box.h.

◆ Interval

using lsst::geom::Box2D::Interval = IntervalD

Definition at line 419 of file Box.h.

◆ Point

typedef Point2D lsst::geom::Box2D::Point

Definition at line 415 of file Box.h.

Constructor & Destructor Documentation

◆ Box2D() [1/7]

lsst::geom::Box2D::Box2D ( )

noexcept

Construct an empty box.

Definition at line 274 of file Box.cc.

◆ Box2D() [2/7]

lsst::geom::Box2D::Box2D	(	Point2D const &	minimum,
		Point2D const &	maximum,
		bool	invert = true )

noexcept

Construct a box from its minimum and maximum points.

If any(minimum == maximum), the box will always be empty (even if invert==true).

Parameters

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

Definition at line 276 of file Box.cc.

◆ Box2D() [3/7]

lsst::geom::Box2D::Box2D	(	Point2D const &	corner,
		Extent2D const &	dimensions,
		bool	invert = true )

noexcept

Construct a box from one corner and dimensions.

Parameters

[in]	corner	Reference coordinate (inclusive). 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.

Definition at line 293 of file Box.cc.

◆ Box2D() [4/7]

lsst::geom::Box2D::Box2D	(	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 463 of file Box.h.

◆ Box2D() [5/7]

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

explicitnoexcept

Construct a floating-point box from an integer box.

Integer to floating-point 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. While the output floating-point box thus has the same dimensions as the input integer box, its minimum/maximum coordinates are 0.5 smaller/greater.

Definition at line 310 of file Box.cc.

◆ Box2D() [6/7]

lsst::geom::Box2D::Box2D ( Box2D const & )

defaultnoexcept

Standard copy constructor.

◆ Box2D() [7/7]

lsst::geom::Box2D::Box2D ( Box2D && )

defaultnoexcept

◆ ~Box2D()

lsst::geom::Box2D::~Box2D ( )

defaultnoexcept

Member Function Documentation

◆ clip()

void lsst::geom::Box2D::clip ( Box2D 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 416 of file Box.cc.

◆ clippedTo()

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

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

In particular, if other and this do not overlap, the new box will be empty.

Definition at line 471 of file Box.cc.

◆ contains() [1/3]

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

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 328 of file Box.cc.

◆ contains() [2/3]

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

inlinenoexcept

Return true if the box contains no points.

Definition at line 562 of file Box.h.

◆ contains() [3/3]

bool lsst::geom::Box2D::contains ( Point2D const & point ) const

noexcept

Return true if the box contains the point.

Definition at line 322 of file Box.cc.

◆ dilatedBy() [1/2]

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

inline

Return true if the box contains no points.

Definition at line 650 of file Box.h.

◆ dilatedBy() [2/2]

Box2D lsst::geom::Box2D::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 the final size of the box is less than zero in either dimension the new box will empty.

Empty boxes remain empty after dilation. Infinite bounds are unaffected by dilation.

Exceptions

lsst::pex::exceptions::InvalidParameterError Thrown if buffer is not finite.

Definition at line 438 of file Box.cc.

◆ erodedBy() [1/2]

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

inline

Return true if the box contains no points.

Definition at line 672 of file Box.h.

◆ erodedBy() [2/2]

Box2D lsst::geom::Box2D::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 the final size of the box is less than zero in either dimension the new box will empty.

Empty boxes remain empty after erosion. Infinite bounds are unaffected by erosion.

Exceptions

lsst::pex::exceptions::InvalidParameterError Thrown if buffer is not finite.

Definition at line 671 of file Box.h.

◆ expandedTo() [1/2]

Box2D lsst::geom::Box2D::expandedTo ( Box2D const & other ) const

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

Expanding an empty box with a second box is equivalent to assignment.

Definition at line 466 of file Box.cc.

◆ expandedTo() [2/2]

Box2D lsst::geom::Box2D::expandedTo ( Point const & other ) const

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

Expanding an empty box with a single point yields a box with dimensions == (0, 0) at that point.

Exceptions

lsst::pex::exceptions::InvalidParameterError Thrown if other is not finite.

Definition at line 458 of file Box.cc.

◆ flipLR()

void lsst::geom::Box2D::flipLR ( float xExtent )

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

Definition at line 356 of file Box.cc.

◆ flipTB()

void lsst::geom::Box2D::flipTB ( float yExtent )

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

Definition at line 368 of file Box.cc.

◆ getArea()

double lsst::geom::Box2D::getArea ( ) const

inlinenoexcept

1-d interval accessors

Definition at line 531 of file Box.h.

◆ getCenter()

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

inlinenoexcept

Return true if the box contains no points.

Definition at line 549 of file Box.h.

◆ getCenterX()

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

inlinenoexcept

Return true if the box contains no points.

Definition at line 552 of file Box.h.

◆ getCenterY()

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

inlinenoexcept

Return true if the box contains no points.

Definition at line 553 of file Box.h.

◆ getCorners()

std::vector< Point2D > lsst::geom::Box2D::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 496 of file Box.cc.

◆ getDimensions()

Extent2D const lsst::geom::Box2D::getDimensions ( ) const

inlinenoexcept

1-d interval accessors

Definition at line 528 of file Box.h.

◆ getHeight()

double lsst::geom::Box2D::getHeight ( ) const

inlinenoexcept

1-d interval accessors

Definition at line 530 of file Box.h.

◆ getMax()

Point2D const lsst::geom::Box2D::getMax ( ) const

inlinenoexcept

Definition at line 517 of file Box.h.

◆ getMaxX()

double lsst::geom::Box2D::getMaxX ( ) const

inlinenoexcept

Definition at line 518 of file Box.h.

◆ getMaxY()

double lsst::geom::Box2D::getMaxY ( ) const

inlinenoexcept

Definition at line 519 of file Box.h.

◆ getMin()

Point2D const lsst::geom::Box2D::getMin ( ) const

inlinenoexcept

Definition at line 513 of file Box.h.

◆ getMinX()

double lsst::geom::Box2D::getMinX ( ) const

inlinenoexcept

Definition at line 514 of file Box.h.

◆ getMinY()

double lsst::geom::Box2D::getMinY ( ) const

inlinenoexcept

Definition at line 515 of file Box.h.

◆ getWidth()

double lsst::geom::Box2D::getWidth ( ) const

inlinenoexcept

1-d interval accessors

Definition at line 529 of file Box.h.

◆ getX()

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

inline

1-d interval accessors

Definition at line 539 of file Box.h.

◆ getY()

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

inline

1-d interval accessors

Definition at line 540 of file Box.h.

◆ grow() [1/2]

void lsst::geom::Box2D::grow ( double 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 594 of file Box.h.

◆ grow() [2/2]

void lsst::geom::Box2D::grow ( Extent2D 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 343 of file Box.cc.

◆ hash_value()

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

noexcept

Return a hash of this object.

Definition at line 486 of file Box.cc.

◆ include() [1/2]

void lsst::geom::Box2D::include ( Box2D const & other )

noexcept

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

Definition at line 398 of file Box.cc.

◆ include() [2/2]

void lsst::geom::Box2D::include ( Point2D const & point )

noexcept

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

If the point sets a new maximum value for the box, the maximum coordinate will be adjusted to ensure the point is actually contained by the box instead of sitting on its exclusive upper edge.

Definition at line 380 of file Box.cc.

◆ intersects()

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

inlinenoexcept

Return true if the box contains no points.

Definition at line 579 of file Box.h.

◆ isDisjointFrom()

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

noexcept

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

Definition at line 339 of file Box.cc.

◆ isEmpty()

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

inlinenoexcept

Return true if the box contains no points.

Definition at line 557 of file Box.h.

◆ makeCenteredBox()

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

staticnoexcept

Create a box centered 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, it shall be centered on center. Behavior is undefined if either center or size is non-finite.

Definition at line 316 of file Box.cc.

◆ operator!=()

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

noexcept

Compare two boxes for equality.

All empty boxes are equal.

Definition at line 481 of file Box.cc.

◆ operator=() [1/2]

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

defaultnoexcept

◆ operator=() [2/2]

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

defaultnoexcept

Standard assignment operator.

◆ operator==()

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

noexcept

Compare two boxes for equality.

All empty boxes are equal.

Definition at line 476 of file Box.cc.

◆ overlaps()

bool lsst::geom::Box2D::overlaps ( Box2D 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 332 of file Box.cc.

◆ reflectedAboutX()

Box2D lsst::geom::Box2D::reflectedAboutX ( Element x ) const

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

Empty boxes remain empty when reflected.

Exceptions

lsst::pex::exceptions::InvalidParameterError Thrown if x is not finite.

Definition at line 448 of file Box.cc.

◆ reflectedAboutY()

Box2D lsst::geom::Box2D::reflectedAboutY ( Element y ) const

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

Empty boxes remain empty when reflected.

Exceptions

lsst::pex::exceptions::InvalidParameterError Thrown if y is not finite.

Definition at line 453 of file Box.cc.

◆ shift()

void lsst::geom::Box2D::shift ( Extent2D const & offset )

Shift the position of the box by the given offset.

Definition at line 350 of file Box.cc.

◆ shiftedBy()

Box2D lsst::geom::Box2D::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. Infinite bounds are unaffected by shifting.

Exceptions

lsst::pex::exceptions::InvalidParameterError Thrown if offset is not finite.

Definition at line 443 of file Box.cc.

◆ swap()

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

inlinenoexcept

Definition at line 498 of file Box.h.

◆ toString()

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

inline

Return true if the box contains no points.

Definition at line 761 of file Box.h.

Member Data Documentation

◆ EPSILON

double const lsst::geom::Box2D::EPSILON = std::numeric_limits<double>::epsilon() * 2

static

Value the maximum coordinate is multiplied by to increase it by the smallest possible amount.

Definition at line 425 of file Box.h.

◆ INVALID

double const lsst::geom::Box2D::INVALID = std::numeric_limits<double>::quiet_NaN()

static

Value used to specify undefined coordinate values.

Definition at line 428 of file Box.h.

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

include/lsst/geom/Box.h
src/Box.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Center Accessors

Detailed Description

Member Typedef Documentation

◆ Element

◆ Extent

◆ Interval

◆ Point

Constructor & Destructor Documentation

◆ Box2D() [1/7]

◆ Box2D() [2/7]

◆ Box2D() [3/7]

◆ Box2D() [4/7]

◆ Box2D() [5/7]

◆ Box2D() [6/7]

◆ Box2D() [7/7]

◆ ~Box2D()

Member Function Documentation

◆ clip()

◆ clippedTo()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ dilatedBy() [1/2]

◆ dilatedBy() [2/2]

◆ erodedBy() [1/2]

◆ erodedBy() [2/2]

◆ expandedTo() [1/2]

◆ expandedTo() [2/2]

◆ flipLR()

◆ flipTB()

◆ getArea()

◆ getCenter()

◆ getCenterX()

◆ getCenterY()

◆ getCorners()

◆ getDimensions()

◆ getHeight()

◆ getMax()

◆ getMaxX()

◆ getMaxY()

◆ getMin()

◆ getMinX()

◆ getMinY()

◆ getWidth()

◆ getX()

◆ getY()

◆ grow() [1/2]

◆ grow() [2/2]

◆ hash_value()

◆ include() [1/2]

◆ include() [2/2]

◆ intersects()

◆ isDisjointFrom()

◆ isEmpty()

◆ makeCenteredBox()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ overlaps()

◆ reflectedAboutX()

◆ reflectedAboutY()

◆ shift()

◆ shiftedBy()

◆ swap()

◆ toString()

Member Data Documentation

◆ EPSILON

◆ INVALID