lsst::sphgeom::Box3d Class Reference

Box3d represents a box in ℝ³. More...

#include <Box3d.h>

Public Member Functions
	Box3d ()
	This constructor creates an empty 3D box. More...
	Box3d (Vector3d const &v)
	This constructor creates a box containing a single point. More...
	Box3d (Vector3d const &v1, Vector3d const &v2)
	This constructor creates a box spanning the intervals [v1.x(), v2.x()], [v1.y(), v2.y()], and [v1.z(), v2.z()]. More...
	Box3d (Vector3d const &v, double w, double h, double d)
	This constructor creates a box with center v, half-width w, half-height h, and half-depth d. More...
	Box3d (Interval1d const &x, Interval1d const &y, Interval1d const &z)
	This constructor creates a box spanning the given x, y, and z intervals. More...
bool	operator== (Box3d const &b) const
	Two 3D boxes are equal if they contain the same points. More...
bool	operator!= (Box3d const &b) const
bool	operator== (Vector3d const &v) const
	A box is equal to a point if it contains only that point. More...
bool	operator!= (Vector3d const &v) const
Interval1d	operator() (int i) const
	The function call operator returns the i-th interval of this box. More...
Interval1d const &	x () const
Interval1d const &	y () const
Interval1d const &	z () const
bool	isEmpty () const
	isEmpty returns true if this box does not contain any points. More...
bool	isFull () const
	isFull returns true if this box contains all points in ℝ³. More...
Vector3d	getCenter () const
	getCenter returns the center of this box. More...
double	getWidth () const
	getWidth returns the width (x-axis extent) of this box. More...
double	getHeight () const
	getHeight returns the height (y-axis extent) of this box. More...
double	getDepth () const
	getDepth returns the depth (z-axis extent) of this box. More...
Box3d &	dilateBy (double r)
	dilateBy minimally expands or shrinks this Box to include or remove all points within distance |r| of its boundary. More...
Box3d	dilatedBy (double r) const
Box3d &	dilateBy (double w, double h, double d)
	dilateBy morphologically dilates or erodes the x, y, and z intervals of this box by w, h, and d. More...
Box3d	dilatedBy (double w, double h, double d) const
Box3d &	erodeBy (double r)
Box3d	erodedBy (double r) const
Box3d &	erodeBy (double w, double h, double d)
Box3d	erodedBy (double w, double h, double d) const
Relationship	relate (Vector3d const &v) const
Relationship	relate (Box3d const &b) const
bool	contains (Vector3d const &b) const
bool	contains (Box3d const &b) const
bool	contains (double x_, double y_, double z_) const
bool	isDisjointFrom (Vector3d const &b) const
bool	isDisjointFrom (Box3d const &b) const
bool	intersects (Vector3d const &b) const
bool	intersects (Box3d const &b) const
bool	isWithin (Vector3d const &b) const
bool	isWithin (Box3d const &b) const
Box3d &	clipTo (Vector3d const &b)
Box3d &	clipTo (Box3d const &b)
Box3d	clippedTo (Vector3d const &b) const
Box3d	clippedTo (Box3d const &b) const
Box3d &	expandTo (Vector3d const &b)
Box3d &	expandTo (Box3d const &b)
Box3d	expandedTo (Vector3d const &b) const
Box3d	expandedTo (Box3d const &b) const

Static Public Member Functions
static Box3d	empty ()
static Box3d	full ()
static Box3d	aroundUnitSphere ()
	aroundUnitSphere returns a minimal Box3d containing the unit sphere. More...

Detailed Description

Box3d represents a box in ℝ³.

It is the Cartesian product of three intervals of ℝ.

Definition at line 42 of file Box3d.h.

Constructor & Destructor Documentation

Box3d() [1/5]

lsst::sphgeom::Box3d::Box3d ( )

inline

This constructor creates an empty 3D box.

Definition at line 63 of file Box3d.h.

{}

Box3d() [2/5]

lsst::sphgeom::Box3d::Box3d ( Vector3d const &  v )

inlineexplicit

This constructor creates a box containing a single point.

Definition at line 66 of file Box3d.h.

    {
        _intervals[0] = Interval1d(v.x());
        _intervals[1] = Interval1d(v.y());
        _intervals[2] = Interval1d(v.z());
        _enforceInvariants();
    }

Box3d() [3/5]

lsst::sphgeom::Box3d::Box3d ( Vector3d const &  v1, Vector3d const &  v2  )

inline

This constructor creates a box spanning the intervals [v1.x(), v2.x()], [v1.y(), v2.y()], and [v1.z(), v2.z()].

Definition at line 76 of file Box3d.h.

    {
        _intervals[0] = Interval1d(v1.x(), v2.x());
        _intervals[1] = Interval1d(v1.y(), v2.y());
        _intervals[2] = Interval1d(v1.z(), v2.z());
        _enforceInvariants();
    }

Box3d() [4/5]

lsst::sphgeom::Box3d::Box3d ( Vector3d const &  v, double  w, double  h, double  d  )

inline

This constructor creates a box with center v, half-width w, half-height h, and half-depth d.

Definition at line 86 of file Box3d.h.

    {
        _intervals[0] = Interval1d(v.x()).dilatedBy(w);
        _intervals[1] = Interval1d(v.y()).dilatedBy(h);
        _intervals[2] = Interval1d(v.z()).dilatedBy(d);
        _enforceInvariants();
    }

Box3d() [5/5]

lsst::sphgeom::Box3d::Box3d ( Interval1d const &  x, Interval1d const &  y, Interval1d const &  z  )

inline

This constructor creates a box spanning the given x, y, and z intervals.

Definition at line 96 of file Box3d.h.

    {
        _intervals[0] = Interval1d(x);
        _intervals[1] = Interval1d(y);
        _intervals[2] = Interval1d(z);
        _enforceInvariants();
    }

Member Function Documentation

aroundUnitSphere()

static Box3d lsst::sphgeom::Box3d::aroundUnitSphere ( )

inlinestatic

aroundUnitSphere returns a minimal Box3d containing the unit sphere.

Definition at line 56 of file Box3d.h.

                                    {
        return Box3d(Interval1d(-1.0, 1.0),
                     Interval1d(-1.0, 1.0),
                     Interval1d(-1.0, 1.0));
    }

clippedTo() [1/2]

Box3d lsst::sphgeom::Box3d::clippedTo ( Box3d const &  b ) const

inline

clippedTo returns the intersection of this box and b.

Definition at line 240 of file Box3d.h.

                                           {
        return Box3d(*this).clipTo(b);
    }

clippedTo() [2/2]

Box3d lsst::sphgeom::Box3d::clippedTo ( Vector3d const &  b ) const

inline

clippedTo returns the intersection of this box and b.

Definition at line 236 of file Box3d.h.

                                              {
        return Box3d(*this).clipTo(b);
    }

clipTo() [1/2]

Box3d& lsst::sphgeom::Box3d::clipTo ( Box3d const &  b )

inline

clipTo sets this box to the intersection of this box and b.

Definition at line 225 of file Box3d.h.

                                    {
        _intervals[0].clipTo(b.x());
        _intervals[1].clipTo(b.y());
        _intervals[2].clipTo(b.z());
        _enforceInvariants();
        return *this;
    }

clipTo() [2/2]

Box3d& lsst::sphgeom::Box3d::clipTo ( Vector3d const &  b )

inline

clipTo sets this box to the intersection of this box and b.

Definition at line 217 of file Box3d.h.

                                       {
        _intervals[0].clipTo(b.x());
        _intervals[1].clipTo(b.y());
        _intervals[2].clipTo(b.z());
        _enforceInvariants();
        return *this;
    }

contains() [1/3]

bool lsst::sphgeom::Box3d::contains ( Box3d const &  b ) const

inline

contains returns true iff the intersection of this box and b is equal to b.

Definition at line 164 of file Box3d.h.

                                         {
        return x().contains(b.x()) &&
               y().contains(b.y()) &&
               z().contains(b.z());
    }

contains() [2/3]

bool lsst::sphgeom::Box3d::contains ( double  x_, double  y_, double  z_  ) const

inline

contains returns true iff the intersection of this box and b is equal to b.

Definition at line 170 of file Box3d.h.

                                                         {
        return x().contains(x_) && y().contains(y_) && z().contains(z_);
    }

contains() [3/3]

bool lsst::sphgeom::Box3d::contains ( Vector3d const &  b ) const

inline

contains returns true iff the intersection of this box and b is equal to b.

Definition at line 158 of file Box3d.h.

                                            {
        return x().contains(b.x()) &&
               y().contains(b.y()) &&
               z().contains(b.z());
    }

dilateBy() [1/2]

Box3d& lsst::sphgeom::Box3d::dilateBy ( double  r )

inline

dilateBy minimally expands or shrinks this Box to include or remove all points within distance |r| of its boundary.

If this box is empty or full, or if r is zero, there is no effect. If r is positive, points are added, and if r is negative they are removed.

Definition at line 280 of file Box3d.h.

{ return dilateBy(r, r, r); }

dilateBy() [2/2]

Box3d& lsst::sphgeom::Box3d::dilateBy ( double  w, double  h, double  d  )

inline

dilateBy morphologically dilates or erodes the x, y, and z intervals of this box by w, h, and d.

If w is positive, the x interval is dilated by [-w,w]. If w is zero, the corresponding interval is not modified, and if it is negative, the longitude interval is eroded by [w,-w]. The action of h and d on the y and z intervals is analogous.

If this box is empty or full, there is no effect.

Definition at line 290 of file Box3d.h.

                                                   {
        _intervals[0].dilateBy(w);
        _intervals[1].dilateBy(h);
        _intervals[2].dilateBy(d);
        _enforceInvariants();
        return *this;
    }

dilatedBy() [1/2]

Box3d lsst::sphgeom::Box3d::dilatedBy ( double  r ) const

inline

Definition at line 281 of file Box3d.h.

{ return Box3d(*this).dilateBy(r); }

dilatedBy() [2/2]

Box3d lsst::sphgeom::Box3d::dilatedBy ( double  w, double  h, double  d  ) const

inline

Definition at line 297 of file Box3d.h.

                                                        {
        return Box3d(*this).dilateBy(w, h, d);
    }

empty()

static Box3d lsst::sphgeom::Box3d::empty ( )

inlinestatic

Definition at line 45 of file Box3d.h.

                         {
        return Box3d();
    }

erodeBy() [1/2]

Box3d& lsst::sphgeom::Box3d::erodeBy ( double  r )

inline

Definition at line 300 of file Box3d.h.

{ return dilateBy(-r); }

erodeBy() [2/2]

Box3d& lsst::sphgeom::Box3d::erodeBy ( double  w, double  h, double  d  )

inline

Definition at line 302 of file Box3d.h.

                                                  {
        return dilateBy(-w, -h, -d);
    }

erodedBy() [1/2]

Box3d lsst::sphgeom::Box3d::erodedBy ( double  r ) const

inline

Definition at line 301 of file Box3d.h.

{ return dilatedBy(-r); }

erodedBy() [2/2]

Box3d lsst::sphgeom::Box3d::erodedBy ( double  w, double  h, double  d  ) const

inline

Definition at line 305 of file Box3d.h.

                                                       {
        return dilatedBy(-w, -h, -d);
    }

expandedTo() [1/2]

Box3d lsst::sphgeom::Box3d::expandedTo ( Box3d const &  b ) const

inline

expandedTo returns the smallest box containing the union of this box and b.

Definition at line 269 of file Box3d.h.

                                            {
        return Box3d(*this).expandTo(b);
    }

expandedTo() [2/2]

Box3d lsst::sphgeom::Box3d::expandedTo ( Vector3d const &  b ) const

inline

expandedTo returns the smallest box containing the union of this box and b.

Definition at line 265 of file Box3d.h.

                                               {
        return Box3d(*this).expandTo(b);
    }

expandTo() [1/2]

Box3d& lsst::sphgeom::Box3d::expandTo ( Box3d const &  b )

inline

expandTo minimally expands this box to contain b.

Definition at line 254 of file Box3d.h.

                                      {
        _intervals[0].expandTo(b.x());
        _intervals[1].expandTo(b.y());
        _intervals[2].expandTo(b.z());
        return *this;
    }

expandTo() [2/2]

Box3d& lsst::sphgeom::Box3d::expandTo ( Vector3d const &  b )

inline

expandTo minimally expands this box to contain b.

Definition at line 247 of file Box3d.h.

                                         {
        _intervals[0].expandTo(b.x());
        _intervals[1].expandTo(b.y());
        _intervals[2].expandTo(b.z());
        return *this;
    }

full()

static Box3d lsst::sphgeom::Box3d::full ( )

inlinestatic

Definition at line 49 of file Box3d.h.

                        {
        return Box3d(Interval1d::full(),
                     Interval1d::full(),
                     Interval1d::full());
    }

getCenter()

Vector3d lsst::sphgeom::Box3d::getCenter ( ) const

inline

getCenter returns the center of this box.

An arbitrary vector is returned for boxes that are empty or full.

Definition at line 139 of file Box3d.h.

                               {
        return Vector3d(x().getCenter(), y().getCenter(), z().getCenter());
    }

getDepth()

double lsst::sphgeom::Box3d::getDepth ( ) const

inline

getDepth returns the depth (z-axis extent) of this box.

It is negative or NaN for empty boxes, and infinite for full boxes.

Definition at line 153 of file Box3d.h.

{ return z().getSize(); }

getHeight()

double lsst::sphgeom::Box3d::getHeight ( ) const

inline

getHeight returns the height (y-axis extent) of this box.

It is negative or NaN for empty boxes, and infinite for full boxes.

Definition at line 149 of file Box3d.h.

{ return y().getSize(); }

getWidth()

double lsst::sphgeom::Box3d::getWidth ( ) const

inline

getWidth returns the width (x-axis extent) of this box.

It is negative or NaN for empty boxes, and infinite for full boxes.

Definition at line 145 of file Box3d.h.

{ return x().getSize(); }

intersects() [1/2]

bool lsst::sphgeom::Box3d::intersects ( Box3d const &  b ) const

inline

intersects returns true iff the intersection of this box and b is non-empty.

Definition at line 192 of file Box3d.h.

                                           {
        return x().intersects(b.x()) &&
               y().intersects(b.y()) &&
               z().intersects(b.z());
    }

intersects() [2/2]

bool lsst::sphgeom::Box3d::intersects ( Vector3d const &  b ) const

inline

intersects returns true iff the intersection of this box and b is non-empty.

Definition at line 186 of file Box3d.h.

                                              {
        return x().intersects(b.x()) &&
               y().intersects(b.y()) &&
               z().intersects(b.z());
    }

isDisjointFrom() [1/2]

bool lsst::sphgeom::Box3d::isDisjointFrom ( Box3d const &  b ) const

inline

isDisjointFrom returns true iff the intersection of this box and b is empty.

Definition at line 180 of file Box3d.h.

{ return !intersects(b); }

isDisjointFrom() [2/2]

bool lsst::sphgeom::Box3d::isDisjointFrom ( Vector3d const &  b ) const

inline

isDisjointFrom returns true iff the intersection of this box and b is empty.

Definition at line 178 of file Box3d.h.

{ return !intersects(b); }

isEmpty()

bool lsst::sphgeom::Box3d::isEmpty ( ) const

inline

isEmpty returns true if this box does not contain any points.

Definition at line 128 of file Box3d.h.

                         {
        return x().isEmpty();
    }

isFull()

bool lsst::sphgeom::Box3d::isFull ( ) const

inline

isFull returns true if this box contains all points in ℝ³.

Definition at line 133 of file Box3d.h.

                        {
        return x().isFull() && y().isFull() && z().isFull();
    }

isWithin() [1/2]

bool lsst::sphgeom::Box3d::isWithin ( Box3d const &  b ) const

inline

isWithin returns true if the intersection of this box and b is this box.

Definition at line 208 of file Box3d.h.

                                         {
        return x().isWithin(b.x()) &&
               y().isWithin(b.y()) &&
               z().isWithin(b.z());
    }

isWithin() [2/2]

bool lsst::sphgeom::Box3d::isWithin ( Vector3d const &  b ) const

inline

isWithin returns true if the intersection of this box and b is this box.

Definition at line 202 of file Box3d.h.

                                            {
        return x().isWithin(b.x()) &&
               y().isWithin(b.y()) &&
               z().isWithin(b.z());
    }

operator!=() [1/2]

bool lsst::sphgeom::Box3d::operator!= ( Box3d const &  b ) const

inline

Definition at line 113 of file Box3d.h.

{ return !(*this == b); }

operator!=() [2/2]

bool lsst::sphgeom::Box3d::operator!= ( Vector3d const &  v ) const

inline

Definition at line 118 of file Box3d.h.

{ return !(*this == v); }

operator()()

Interval1d lsst::sphgeom::Box3d::operator() ( int  i ) const

inline

The function call operator returns the i-th interval of this box.

Definition at line 121 of file Box3d.h.

{ return _intervals[i]; }

operator==() [1/2]

bool lsst::sphgeom::Box3d::operator== ( Box3d const &  b ) const

inline

Two 3D boxes are equal if they contain the same points.

Definition at line 107 of file Box3d.h.

                                           {
        return _intervals[0] == b._intervals[0] &&
               _intervals[1] == b._intervals[1] &&
               _intervals[2] == b._intervals[2];
    }

operator==() [2/2]

bool lsst::sphgeom::Box3d::operator== ( Vector3d const &  v ) const

inline

A box is equal to a point if it contains only that point.

Definition at line 116 of file Box3d.h.

{ return *this == Box3d(v); }

relate() [1/2]

Relationship lsst::sphgeom::Box3d::relate ( Box3d const &  b ) const

inline

Definition at line 311 of file Box3d.h.

                                               {
        Relationship xr = x().relate(b.x());
        Relationship yr = y().relate(b.y());
        Relationship zr = z().relate(b.z());
        // If the box x, y, or z intervals are disjoint, then so are the
        // boxes. The other relationships must hold for all constituent
        // intervals in order to hold for the boxes.
        return ((xr & yr & zr) & (CONTAINS | WITHIN)) |
               ((xr | yr | zr) & DISJOINT);
    }

relate() [2/2]

Relationship lsst::sphgeom::Box3d::relate ( Vector3d const &  v ) const

inline

Definition at line 309 of file Box3d.h.

{ return relate(Box3d(v)); }

x()

Interval1d const& lsst::sphgeom::Box3d::x ( ) const

inline

Definition at line 123 of file Box3d.h.

{ return _intervals[0]; }

y()

Interval1d const& lsst::sphgeom::Box3d::y ( ) const

inline

Definition at line 124 of file Box3d.h.

{ return _intervals[1]; }

z()

Interval1d const& lsst::sphgeom::Box3d::z ( ) const

inline

Definition at line 125 of file Box3d.h.

{ return _intervals[2]; }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/sphgeom/22.0.1-2-gac51dbf+052faf71bd/include/lsst/sphgeom/Box3d.h