An integer coordinate rectangle. More...

#include <Box.h>

Public Types
enum	EdgeHandlingEnum { EXPAND, SHRINK }

typedef Point2I	Point

typedef Extent2I	Extent

typedef int	Element

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 &)=default
	Standard copy constructor. More...

	Box2I (Box2I &&)=default

	~Box2I ()=default

void	swap (Box2I &other)

Box2I &	operator= (Box2I const &)=default
	Standard assignment operator. More...

Box2I &	operator= (Box2I &&)=default

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
	Get the corner points. More...

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

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 55 of file Box.h.

Member Typedef Documentation

◆ Element

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

Definition at line 59 of file Box.h.

◆ Extent

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

Definition at line 58 of file Box.h.

◆ Point

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

Definition at line 57 of file Box.h.

Member Enumeration Documentation

◆ EdgeHandlingEnum

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

Enumerator
EXPAND
SHRINK

Definition at line 61 of file Box.h.

61 { EXPAND, SHRINK };

lsst::afw::geom::Box2I::SHRINK

Definition: Box.h:61

lsst::afw::geom::Box2I::EXPAND

Definition: Box.h:61

Constructor & Destructor Documentation

◆ Box2I() [1/6]

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

inline

Construct an empty box.

Definition at line 64 of file Box.h.

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

◆ Box2I() [2/6]

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.

Definition at line 32 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/6]

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.

Definition at line 48 of file Box.cc.

         : _minimum(minimum), _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/6]

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.

Definition at line 70 of file Box.cc.

                                                               : _minimum(), _dimensions() {
     if (other.isEmpty()) {
         *this = Box2I();
         return;
     }
     if (!std::isfinite(other.getMinX()) || !std::isfinite(other.getMinY()) ||
         !std::isfinite(other.getMaxX()) || !std::isfinite(other.getMaxY())) {
         throw LSST_EXCEPT(pex::exceptions::InvalidParameterError, "Cannot convert non-finite Box2D to Box2I");
     }
     Point2D fpMin(other.getMin() + Extent2D(0.5));
     Point2D fpMax(other.getMax() - Extent2D(0.5));
     switch (edgeHandling) {
         case EXPAND:
             for (int n = 0; n < 2; ++n) {
                 _minimum[n] = static_cast<int>(std::floor(fpMin[n]));
                 _dimensions[n] = static_cast<int>(std::ceil(fpMax[n])) + 1 - _minimum[n];
             }
             break;
         case SHRINK:
             for (int n = 0; n < 2; ++n) {
                 _minimum[n] = static_cast<int>(std::ceil(fpMin[n]));
                 _dimensions[n] = static_cast<int>(std::floor(fpMax[n])) + 1 - _minimum[n];
             }
             break;
     }
 }

◆ Box2I() [5/6]

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

default

Standard copy constructor.

◆ Box2I() [6/6]

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

default

◆ ~Box2I()

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

default

Member Function Documentation

◆ clip()

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

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

Definition at line 179 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;
 }

◆ contains() [1/2]

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

Return true if the box contains the point.

Definition at line 102 of file Box.cc.

                                                {
     return all(point.ge(this->getMin())) && all(point.le(this->getMax()));
 }

◆ contains() [2/2]

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.

Definition at line 106 of file Box.cc.

                                              {
     return other.isEmpty() ||
            (all(other.getMin().ge(this->getMin())) && all(other.getMax().le(this->getMax())));
 }

◆ flipLR()

void lsst::afw::geom::Box2I::flipLR ( int xExtent )

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

Definition at line 128 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::afw::geom::Box2I::flipTB ( int yExtent )

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

Definition at line 135 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::afw::geom::Box2I::getArea ( ) const

inline

Examples:: spatialCellExample.cc, and testSpatialCell.h.

Definition at line 156 of file Box.h.

156 { return getWidth() * getHeight(); }

lsst::afw::geom::Box2I::getHeight

int getHeight() const

Definition: Box.h:155

lsst::afw::geom::Box2I::getWidth

int getWidth() const

Definition: Box.h:154

◆ getBegin()

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

inline

Definition at line 138 of file Box.h.

138 { return _minimum; }

◆ getBeginX()

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

inline

Definition at line 139 of file Box.h.

139 { return _minimum.getX(); }

◆ getBeginY()

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

inline

Definition at line 140 of file Box.h.

140 { return _minimum.getY(); }

◆ getCorners()

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)

Definition at line 211 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::afw::geom::Box2I::getDimensions ( ) const

inline

Definition at line 153 of file Box.h.

153 { return _dimensions; }

◆ getEnd()

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

inline

Definition at line 142 of file Box.h.

142 { return _minimum + _dimensions; }

◆ getEndX()

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

inline

Definition at line 143 of file Box.h.

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

◆ getEndY()

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

inline

Definition at line 144 of file Box.h.

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

◆ getHeight()

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

inline

Definition at line 155 of file Box.h.

155 { return _dimensions.getY(); }

◆ getMax()

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

inline

Definition at line 127 of file Box.h.

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

lsst::afw::geom::Extent2I

Extent< int, 2 > Extent2I

Definition: Extent.h:380

◆ getMaxX()

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

inline

Examples:: spatialCellExample.cc.

Definition at line 128 of file Box.h.

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

◆ getMaxY()

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

inline

Examples:: spatialCellExample.cc.

Definition at line 129 of file Box.h.

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

◆ getMin()

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

inline

Definition at line 123 of file Box.h.

123 { return _minimum; }

◆ getMinX()

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

inline

Examples:: spatialCellExample.cc.

Definition at line 124 of file Box.h.

124 { return _minimum.getX(); }

◆ getMinY()

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

inline

Examples:: spatialCellExample.cc.

Definition at line 125 of file Box.h.

125 { return _minimum.getY(); }

◆ getSlices()

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.

Definition at line 97 of file Box.cc.

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

◆ getWidth()

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

inline

Definition at line 154 of file Box.h.

154 { return _dimensions.getX(); }

◆ grow() [1/2]

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 188 of file Box.h.

188 { grow(Extent2I(buffer)); }

lsst::afw::geom::Extent2I

Extent< int, 2 > Extent2I

Definition: Extent.h:380

lsst::afw::geom::Box2I::grow

void grow(int buffer)

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

Definition: Box.h:188

◆ grow() [2/2]

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.

Definition at line 116 of file Box.cc.

                                        {
     if (isEmpty()) return;  // should we throw an exception here instead of a no-op?
     _minimum -= buffer;
     _dimensions += buffer * 2;
     if (any(_dimensions.le(0))) *this = Box2I();
 }

◆ include() [1/2]

void lsst::afw::geom::Box2I::include ( Point2I const & point )

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

Definition at line 142 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;
 }

◆ include() [2/2]

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

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

Definition at line 159 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;
 }

◆ isEmpty()

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

inline

Return true if the box contains no points.

Definition at line 163 of file Box.h.

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

◆ operator!=()

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

Compare two boxes for equality.

All empty boxes are equal.

Definition at line 207 of file Box.cc.

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

◆ operator=() [1/2]

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

default

Standard assignment operator.

◆ operator=() [2/2]

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

default

◆ operator==()

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

Compare two boxes for equality.

All empty boxes are equal.

Definition at line 203 of file Box.cc.

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

◆ overlaps()

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.

Definition at line 111 of file Box.cc.

                                              {
     return !(other.isEmpty() || this->isEmpty() || any(other.getMax().lt(this->getMin())) ||
              any(other.getMin().gt(this->getMax())));
 }

◆ shift()

void lsst::afw::geom::Box2I::shift ( Extent2I const & offset )

Shift the position of the box by the given offset.

Definition at line 123 of file Box.cc.

                                         {
     if (isEmpty()) return;  // should we throw an exception here instead of a no-op?
     _minimum += offset;
 }

◆ swap()

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

inline

Definition at line 108 of file Box.h.

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

◆ toString()

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

inline

Definition at line 238 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:

/home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/include/lsst/afw/geom/Box.h
/home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/src/geom/Box.cc

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Element

◆ Extent

◆ Point

Member Enumeration Documentation

◆ EdgeHandlingEnum

Constructor & Destructor Documentation

◆ Box2I() [1/6]

◆ Box2I() [2/6]

◆ Box2I() [3/6]

◆ Box2I() [4/6]

◆ Box2I() [5/6]

◆ Box2I() [6/6]

◆ ~Box2I()

Member Function Documentation

◆ clip()

◆ contains() [1/2]

◆ contains() [2/2]

◆ flipLR()

◆ flipTB()

◆ getArea()

◆ getBegin()

◆ getBeginX()

◆ getBeginY()

◆ getCorners()

◆ getDimensions()

◆ getEnd()

◆ getEndX()

◆ getEndY()

◆ getHeight()

◆ getMax()

◆ getMaxX()

◆ getMaxY()

◆ getMin()

◆ getMinX()

◆ getMinY()

◆ getSlices()

◆ getWidth()

◆ grow() [1/2]

◆ grow() [2/2]

◆ include() [1/2]

◆ include() [2/2]

◆ isEmpty()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ overlaps()

◆ shift()

◆ swap()

◆ toString()