lsst::afw::geom::Box2I Class Reference

An integer coordinate rectangle. More...

#include <Box.h>

Public Types
enum	EdgeHandlingEnum { EXPAND, SHRINK }
typedef Point2I	Point
typedef Extent2I	Extent

Public Member Functions
	Box2I ()
	Construct an empty box. More...
	Box2I (Point2I const &minimum, Point2I const &maximum, bool invert=true)
	Construct a box from its minimum and maximum points. More...
	Box2I (Point2I const &minimum, Extent2I const &dimensions, bool invert=true)
	Construct a box from its minimum point and dimensions. More...
	Box2I (Box2D const &other, EdgeHandlingEnum edgeHandling=EXPAND)
	Construct an integer box from a floating-point box. More...
	Box2I (Box2I const &other)
	Standard copy constructor. More...
void	swap (Box2I &other)
Box2I &	operator= (Box2I const &other)
	Standard assignment operator. More...
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. More...
bool	isEmpty () const
	Return true if the box contains no points. More...
bool	contains (Point2I const &point) const
	Return true if the box contains the point. More...
bool	contains (Box2I const &other) const
	Return true if all points contained by other are also contained by this. More...
bool	overlaps (Box2I const &other) const
	Return true if any points in other are also in this. More...
void	grow (int buffer)
	Increase the size of the box by the given buffer amount in all directions. More...
void	grow (Extent2I const &buffer)
	Increase the size of the box by the given buffer amount in each direction. More...
void	shift (Extent2I const &offset)
	Shift the position of the box by the given offset. More...
void	flipLR (int xExtent)
	Flip a bounding box about the y-axis given a parent box of extent (xExtent). More...
void	flipTB (int yExtent)
	Flip a bounding box about the x-axis given a parent box of extent (yExtent). More...
void	include (Point2I const &point)
	Expand this to ensure that this->contains(point). More...
void	include (Box2I const &other)
	Expand this to ensure that this->contains(other). More...
void	clip (Box2I const &other)
	Shrink this to ensure that other.contains(*this). More...
bool	operator== (Box2I const &other) const
	Compare two boxes for equality. More...
bool	operator!= (Box2I const &other) const
	Compare two boxes for equality. More...
std::vector< Point2I >	getCorners () const
std::string	toString () const
Min/Max Accessors
Return the minimum and maximum coordinates of the box (inclusive).
Point2I const	getMin () const
int	getMinX () const
int	getMinY () const
Point2I const	getMax () const
int	getMaxX () const
int	getMaxY () const
Begin/End Accessors
Return STL-style begin (inclusive) and end (exclusive) coordinates for the box.
Point2I const	getBegin () const
int	getBeginX () const
int	getBeginY () const
Point2I const	getEnd () const
int	getEndX () const
int	getEndY () const
Size Accessors
Return the size of the box in pixels.
Extent2I const	getDimensions () const
int	getWidth () const
int	getHeight () const
int	getArea () const

Private Attributes
Point2I	_minimum
Extent2I	_dimensions

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).

Examples:

image2.cc, maskedImage2.cc, spatialCellExample.cc, testSpatialCell.cc, and testSpatialCell.h.

Definition at line 53 of file Box.h.

Member Typedef Documentation

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

Definition at line 57 of file Box.h.

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

Definition at line 56 of file Box.h.

Member Enumeration Documentation

enum lsst::afw::geom::Box2I::EdgeHandlingEnum

Enumerator
EXPAND
SHRINK

Definition at line 59 of file Box.h.

{ EXPAND, SHRINK };

Constructor & Destructor Documentation

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

inline

Construct an empty box.

Definition at line 62 of file Box.h.

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

lsst::afw::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.

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

Construct a box from its minimum point and dimensions.

Parameters

[in]	minimum	Minimum (lower left) coordinate.
[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.

lsst::afw::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.

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

inline

Standard copy constructor.

Definition at line 103 of file Box.h.

: _minimum(other._minimum), _dimensions(other._dimensions) {}

Member Function Documentation

void lsst::afw::geom::Box2I::clip

(

Box2I const &

other

)

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

bool lsst::afw::geom::Box2I::contains

(

Point2I const &

point

)

const

Return true if the box contains the point.

bool lsst::afw::geom::Box2I::contains

(

Box2I 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.

void lsst::afw::geom::Box2I::flipLR

(

int

xExtent

)

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

void lsst::afw::geom::Box2I::flipTB

(

int

yExtent

)

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

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

inline

Examples:

spatialCellExample.cc, and testSpatialCell.h.

Definition at line 156 of file Box.h.

{ return getWidth() * getHeight(); }

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

inline

Definition at line 138 of file Box.h.

{ return _minimum; }

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

inline

Definition at line 139 of file Box.h.

{ return _minimum.getX(); }

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

inline

Definition at line 140 of file Box.h.

{ return _minimum.getY(); }

std::vector<Point2I> lsst::afw::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)

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

inline

Definition at line 153 of file Box.h.

{ return _dimensions; }

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

inline

Definition at line 142 of file Box.h.

{ return _minimum + _dimensions; }

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

inline

Definition at line 143 of file Box.h.

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

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

inline

Definition at line 144 of file Box.h.

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

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

inline

Definition at line 155 of file Box.h.

{ return _dimensions.getY(); }

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

inline

Definition at line 127 of file Box.h.

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

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

inline

Examples:

spatialCellExample.cc.

Definition at line 128 of file Box.h.

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

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

inline

Examples:

spatialCellExample.cc.

Definition at line 129 of file Box.h.

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

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

inline

Definition at line 123 of file Box.h.

{ return _minimum; }

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

inline

Examples:

spatialCellExample.cc.

Definition at line 124 of file Box.h.

{ return _minimum.getX(); }

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

inline

Examples:

spatialCellExample.cc.

Definition at line 125 of file Box.h.

{ return _minimum.getY(); }

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

(

)

const

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

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

inline

Definition at line 154 of file Box.h.

{ return _dimensions.getX(); }

void lsst::afw::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 193 of file Box.h.

{ grow(Extent2I(buffer)); }

void lsst::afw::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.

void lsst::afw::geom::Box2I::include

(

Point2I const &

point

)

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

void lsst::afw::geom::Box2I::include

(

Box2I const &

other

)

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

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

inline

Return true if the box contains no points.

Definition at line 166 of file Box.h.

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

bool lsst::afw::geom::Box2I::operator!=

(

Box2I const &

other

)

const

Compare two boxes for equality.

All empty boxes are equal.

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

inline

Standard assignment operator.

Definition at line 111 of file Box.h.

                                           {
        _minimum = other._minimum;
        _dimensions = other._dimensions;
        return *this;
    }

bool lsst::afw::geom::Box2I::operator==

(

Box2I const &

other

)

const

Compare two boxes for equality.

All empty boxes are equal.

bool lsst::afw::geom::Box2I::overlaps

(

Box2I const &

other

)

const

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

Any overlap operation involving an empty box returns false.

void lsst::afw::geom::Box2I::shift

(

Extent2I const &

offset

)

Shift the position of the box by the given offset.

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

inline

Definition at line 105 of file Box.h.

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

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

inline

Definition at line 243 of file Box.h.

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

Member Data Documentation

Extent2I lsst::afw::geom::Box2I::_dimensions

private

Definition at line 249 of file Box.h.

Point2I lsst::afw::geom::Box2I::_minimum

private

Definition at line 248 of file Box.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/Box.h