lsst.sphgeom gbd998247f1+585e252eca
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst::sphgeom::UnionRegion Class Reference

#include <CompoundRegion.h>

Inheritance diagram for lsst::sphgeom::UnionRegion:
lsst::sphgeom::CompoundRegion lsst::sphgeom::Region

Public Member Functions

std::unique_ptr< Regionclone () const override
 clone returns a deep copy of this region.
 
Box getBoundingBox () const override
 getBoundingBox returns a bounding-box for this region.
 
Box3d getBoundingBox3d () const override
 getBoundingBox3d returns a 3-dimensional bounding-box for this region.
 
Circle getBoundingCircle () const override
 getBoundingCircle returns a bounding-circle for this region.
 
bool contains (UnitVector3d const &v) const override
 contains tests whether the given unit vector is inside this region.
 
Relationship relate (Region const &r) const override
 
std::vector< uint8_t > encode () const override
 
 CompoundRegion (Region const &first, Region const &second)
 Construct by copying or taking ownership of operands.
 
 CompoundRegion (std::array< std::unique_ptr< Region >, 2 > operands) noexcept
 
 CompoundRegion (CompoundRegion const &)
 
 CompoundRegion (CompoundRegion &&) noexcept=default
 
virtual bool contains (UnitVector3d const &) const=0
 contains tests whether the given unit vector is inside this region.
 
bool contains (double x, double y, double z) const
 
bool contains (double lon, double lat) const
 
- Public Member Functions inherited from lsst::sphgeom::CompoundRegion
 CompoundRegion (Region const &first, Region const &second)
 Construct by copying or taking ownership of operands.
 
 CompoundRegion (std::array< std::unique_ptr< Region >, 2 > operands) noexcept
 
 CompoundRegion (CompoundRegion const &)
 
 CompoundRegion (CompoundRegion &&) noexcept=default
 
CompoundRegionoperator= (CompoundRegion const &)=delete
 
CompoundRegionoperator= (CompoundRegion &&)=delete
 
Region const & getOperand (std::size_t n) const
 
Relationship relate (Box const &b) const override
 
Relationship relate (Circle const &c) const override
 
Relationship relate (ConvexPolygon const &p) const override
 
Relationship relate (Ellipse const &e) const override
 
- Public Member Functions inherited from lsst::sphgeom::Region
bool contains (double x, double y, double z) const
 
bool contains (double lon, double lat) const
 

Static Public Member Functions

static std::unique_ptr< UnionRegiondecode (std::vector< uint8_t > const &s)
 
static std::unique_ptr< UnionRegiondecode (uint8_t const *buffer, size_t n)
 
- Static Public Member Functions inherited from lsst::sphgeom::CompoundRegion
static std::unique_ptr< CompoundRegiondecode (std::vector< uint8_t > const &s)
 
static std::unique_ptr< CompoundRegiondecode (uint8_t const *buffer, size_t n)
 
- Static Public Member Functions inherited from lsst::sphgeom::Region
static std::unique_ptr< Regiondecode (std::vector< uint8_t > const &s)
 
static std::unique_ptr< Regiondecode (uint8_t const *buffer, size_t n)
 

Static Public Attributes

static constexpr uint8_t TYPE_CODE = 'u'
 

Additional Inherited Members

- Protected Member Functions inherited from lsst::sphgeom::CompoundRegion
std::vector< std::uint8_t > _encode (std::uint8_t tc) const
 
- Static Protected Member Functions inherited from lsst::sphgeom::CompoundRegion
static std::array< std::unique_ptr< Region >, 2 > _decode (std::uint8_t tc, std::uint8_t const *buffer, std::size_t nBytes)
 

Detailed Description

UnionRegion is a lazy point-set union of its operands.

All operations on a UnionRegion are implementing by delegating to its nested operand regions and combining the results.

Member Function Documentation

◆ clone()

std::unique_ptr< Region > lsst::sphgeom::UnionRegion::clone ( ) const
inlineoverridevirtual

clone returns a deep copy of this region.

Implements lsst::sphgeom::Region.

◆ contains() [1/4]

bool lsst::sphgeom::Region::contains ( double lon,
double lat ) const

contains tests whether the unit vector defined by the given longitude and latitude coordinates (in radians) is inside this region.

◆ contains() [2/4]

bool lsst::sphgeom::Region::contains ( double x,
double y,
double z ) const

contains tests whether the unit vector defined by the given (not necessarily normalized) coordinates is inside this region.

◆ contains() [3/4]

virtual bool lsst::sphgeom::Region::contains ( UnitVector3d const & ) const
virtual

contains tests whether the given unit vector is inside this region.

Implements lsst::sphgeom::Region.

◆ contains() [4/4]

bool lsst::sphgeom::UnionRegion::contains ( UnitVector3d const & ) const
overridevirtual

contains tests whether the given unit vector is inside this region.

Implements lsst::sphgeom::Region.

◆ decode()

static std::unique_ptr< UnionRegion > lsst::sphgeom::UnionRegion::decode ( std::vector< uint8_t > const & s)
inlinestatic

decode deserializes a UnionRegion from a byte string produced by encode.

◆ encode()

std::vector< uint8_t > lsst::sphgeom::UnionRegion::encode ( ) const
inlineoverridevirtual

encode serializes this region into an opaque byte string. Byte strings emitted by encode can be deserialized with decode.

Implements lsst::sphgeom::Region.

◆ getBoundingBox()

Box lsst::sphgeom::UnionRegion::getBoundingBox ( ) const
overridevirtual

getBoundingBox returns a bounding-box for this region.

Implements lsst::sphgeom::Region.

◆ getBoundingBox3d()

Box3d lsst::sphgeom::UnionRegion::getBoundingBox3d ( ) const
overridevirtual

getBoundingBox3d returns a 3-dimensional bounding-box for this region.

Implements lsst::sphgeom::Region.

◆ getBoundingCircle()

Circle lsst::sphgeom::UnionRegion::getBoundingCircle ( ) const
overridevirtual

getBoundingCircle returns a bounding-circle for this region.

Implements lsst::sphgeom::Region.

◆ relate()

Relationship lsst::sphgeom::UnionRegion::relate ( Region const & ) const
overridevirtual

relate computes the spatial relationships between this region A and another region B. The return value S is a bitset with the following properties:

  • Bit S & DISJOINT is set only if A and B do not have any points in common.
  • Bit S & CONTAINS is set only if A contains all points in B.
  • Bit S & WITHIN is set only if B contains all points in A.

Said another way: if the CONTAINS, WITHIN or DISJOINT bit is set, then the corresponding spatial relationship between the two regions holds conclusively. If it is not set, the relationship may or may not hold.

These semantics allow for conservative relationship computations. In particular, a Region may choose to implement relate by replacing itself and/or the argument with a simplified bounding region.

Implements lsst::sphgeom::CompoundRegion.


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