lsst::sphgeom::UnionRegion Class Reference

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

#include <CompoundRegion.h>

Inheritance diagram for lsst::sphgeom::UnionRegion:

Public Member Functions
std::unique_ptr< Region >	clone () const override
	clone returns a deep copy of this region. More...
Box	getBoundingBox () const override
	getBoundingBox returns a bounding-box for this region. More...
Box3d	getBoundingBox3d () const override
	getBoundingBox3d returns a 3-dimensional bounding-box for this region. More...
Circle	getBoundingCircle () const override
	getBoundingCircle returns a bounding-circle for this region. More...
bool	contains (UnitVector3d const &v) const override
	contains tests whether the given unit vector is inside this region. More...
Relationship	relate (Region const &r) const override
std::vector< uint8_t >	encode () const override
	encode serializes this region into an opaque byte string. More...
	CompoundRegion (Region const &first, Region const &second)
	Construct by copying or taking ownership of operands. More...
	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. More...
bool	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. More...
bool	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. More...
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

Static Public Member Functions
static std::unique_ptr< UnionRegion >	decode (std::vector< uint8_t > const &s)
static std::unique_ptr< UnionRegion >	decode (uint8_t const *buffer, size_t n)

Static Public Attributes
static constexpr uint8_t	TYPE_CODE = 'u'

Protected Member Functions
std::vector< std::uint8_t >	_encode (std::uint8_t tc) const

Static Protected Member Functions
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.

Definition at line 101 of file CompoundRegion.h.

Member Function Documentation

_decode()

std::array< std::unique_ptr< Region >, 2 > lsst::sphgeom::CompoundRegion::_decode ( std::uint8_t  tc, std::uint8_t const *  buffer, std::size_t  nBytes  )

staticprotectedinherited

Definition at line 97 of file CompoundRegion.cc.

                                                               {
    std::uint8_t const *end = buffer + nBytes;
    if (nBytes == 0) {
        throw std::runtime_error("Encoded CompoundRegion is truncated.");
    }
    if (buffer[0] != tc) {
        throw std::runtime_error("Byte string is not an encoded CompoundRegion.");
    }
    ++buffer;
    std::array<std::unique_ptr<Region>, 2> result;
    std::uint64_t nBytes1 = consumeDecodeU64(buffer, end);
    result[0] = Region::decode(buffer, nBytes1);
    buffer += nBytes1;
    std::uint64_t nBytes2 = consumeDecodeU64(buffer, end);
    result[1] = Region::decode(buffer, nBytes2);
    buffer += nBytes2;
    if (buffer != end) {
        throw std::runtime_error("Encoded CompoundRegion is has unexpected additional bytes.");
    }
    return result;
}

_encode()

std::vector< std::uint8_t > lsst::sphgeom::CompoundRegion::_encode ( std::uint8_t  tc ) const

protectedinherited

Definition at line 85 of file CompoundRegion.cc.

                                                                 {
    std::vector<std::uint8_t> buffer;
    buffer.push_back(tc);
    auto buffer1 = getOperand(0).encode();
    encodeU64(buffer1.size(), buffer);
    buffer.insert(buffer.end(), buffer1.begin(), buffer1.end());
    auto buffer2 = getOperand(1).encode();
    encodeU64(buffer2.size(), buffer);
    buffer.insert(buffer.end(), buffer2.begin(), buffer2.end());
    return buffer;
}

clone()

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

inlineoverridevirtual

clone returns a deep copy of this region.

Implements lsst::sphgeom::Region.

Definition at line 108 of file CompoundRegion.h.

{ return std::make_unique<UnionRegion>(*this); }

CompoundRegion() [1/4]

lsst::sphgeom::CompoundRegion::CompoundRegion ( CompoundRegion &&  )

defaultnoexcept

CompoundRegion() [2/4]

lsst::sphgeom::CompoundRegion::CompoundRegion

(

CompoundRegion const &

other

)

Definition at line 55 of file CompoundRegion.cc.

        : _operands{other.getOperand(0).clone(), other.getOperand(1).clone()} {}

CompoundRegion() [3/4]

lsst::sphgeom::CompoundRegion::CompoundRegion	(	Region const &	first,
		Region const &	second
	)

Construct by copying or taking ownership of operands.

Definition at line 51 of file CompoundRegion.cc.

        : _operands{first.clone(), second.clone()} {}

CompoundRegion() [4/4]

lsst::sphgeom::CompoundRegion::CompoundRegion ( std::array< std::unique_ptr< Region >, 2 >  operands )

explicitnoexcept

Definition at line 52 of file CompoundRegion.cc.

        : _operands(std::move(operands)) {}

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.

Definition at line 104 of file Region.cc.

                                                  {
    return contains(UnitVector3d(LonLat::fromRadians(lon, lat)));
}

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.

Definition at line 100 of file Region.cc.

                                                        {
    return contains(UnitVector3d(x, y, z));
}

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.

Definition at line 146 of file CompoundRegion.cc.

                                                      {
    return getOperand(0).contains(v) || getOperand(1).contains(v);
}

decode() [1/2]

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.

Definition at line 120 of file CompoundRegion.h.

                                                                          {
        return decode(s.data(), s.size());
    }

decode() [2/2]

static std::unique_ptr< UnionRegion > lsst::sphgeom::UnionRegion::decode ( uint8_t const *  buffer, size_t  n  )

inlinestatic

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

Definition at line 123 of file CompoundRegion.h.

                                                                              {
        return std::make_unique<UnionRegion>(_decode(TYPE_CODE, buffer, n));
    }

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.

Definition at line 115 of file CompoundRegion.h.

{ return _encode(TYPE_CODE); }

getBoundingBox()

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

overridevirtual

getBoundingBox returns a bounding-box for this region.

Implements lsst::sphgeom::Region.

Definition at line 134 of file CompoundRegion.cc.

                                      {
    return getUnionBounds(*this, [](Region const &r) { return r.getBoundingBox(); });
}

getBoundingBox3d()

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

overridevirtual

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

Implements lsst::sphgeom::Region.

Definition at line 138 of file CompoundRegion.cc.

                                          {
    return getUnionBounds(*this, [](Region const &r) { return r.getBoundingBox3d(); });
}

getBoundingCircle()

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

overridevirtual

getBoundingCircle returns a bounding-circle for this region.

Implements lsst::sphgeom::Region.

Definition at line 142 of file CompoundRegion.cc.

                                            {
    return getUnionBounds(*this, [](Region const &r) { return r.getBoundingCircle(); });
}

getOperand()

Region const & lsst::sphgeom::CompoundRegion::getOperand ( std::size_t  n ) const

inlineinherited

Definition at line 64 of file CompoundRegion.h.

                                                 {
        return *_operands[n];
    }

relate() [1/5]

Relationship lsst::sphgeom::CompoundRegion::relate ( Box const &  ) const

overridevirtualinherited

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::Region.

Definition at line 80 of file CompoundRegion.cc.

{ return relate(static_cast<Region const &>(b)); }

relate() [2/5]

Relationship lsst::sphgeom::CompoundRegion::relate ( Circle const &  ) const

overridevirtualinherited

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::Region.

Definition at line 81 of file CompoundRegion.cc.

{ return relate(static_cast<Region const &>(c)); }

relate() [3/5]

Relationship lsst::sphgeom::CompoundRegion::relate ( ConvexPolygon const &  ) const

overridevirtualinherited

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::Region.

Definition at line 82 of file CompoundRegion.cc.

{ return relate(static_cast<Region const &>(p)); }

relate() [4/5]

Relationship lsst::sphgeom::CompoundRegion::relate ( Ellipse const &  ) const

overridevirtualinherited

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::Region.

Definition at line 83 of file CompoundRegion.cc.

{ return relate(static_cast<Region const &>(e)); }

relate() [5/5]

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.

Definition at line 150 of file CompoundRegion.cc.

                                                        {
    auto r1 = getOperand(0).relate(rhs);
    auto r2 = getOperand(1).relate(rhs);
    return
        // Both operands must be disjoint with the given region for the union
        // to be disjoint with it.
        ((r1 & DISJOINT) & (r2 & DISJOINT))
        // Both operands must be within the given region for the union to be
        // within it.
        | ((r1 & WITHIN) & (r2 & WITHIN))
        // If either operand contains the given region, the union contains it.
        | ((r1 & CONTAINS) | (r2 & CONTAINS));
}

Member Data Documentation

TYPE_CODE

constexpr uint8_t lsst::sphgeom::UnionRegion::TYPE_CODE = 'u'

staticconstexpr

Definition at line 103 of file CompoundRegion.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-4.0.1/Linux64/sphgeom/ga1cf026fa3+ac198e9f13/include/lsst/sphgeom/CompoundRegion.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-4.0.1/Linux64/sphgeom/ga1cf026fa3+ac198e9f13/src/CompoundRegion.cc