LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
_region.cc
Go to the documentation of this file.
1/*
2 * This file is part of sphgeom.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (http://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This software is dual licensed under the GNU General Public License and also
11 * under a 3-clause BSD license. Recipients may choose which of these licenses
12 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
13 * respectively. If you choose the GPL option then the following text applies
14 * (but note that there is still no warranty even if you opt for BSD instead):
15 *
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 */
29#include "pybind11/pybind11.h"
30#include "pybind11/stl.h"
31#include "pybind11/numpy.h"
32
33#include "lsst/sphgeom/python.h"
34
35#include "lsst/sphgeom/Box.h"
36#include "lsst/sphgeom/Box3d.h"
37#include "lsst/sphgeom/Circle.h"
40#include "lsst/sphgeom/Region.h"
42
46
47namespace py = pybind11;
48using namespace pybind11::literals;
49
50namespace lsst {
51namespace sphgeom {
52
53template <>
54void defineClass(py::classh<Region> &cls) {
55 cls.def("clone", &Region::clone);
56 cls.def("isEmpty", &Region::isEmpty);
57 cls.def("getBoundingBox", &Region::getBoundingBox);
58 cls.def("getBoundingBox3d", &Region::getBoundingBox3d);
59 cls.def("getBoundingCircle", &Region::getBoundingCircle);
60 cls.def("contains", py::overload_cast<UnitVector3d const &>(&Region::contains, py::const_),
61 "unitVector"_a);
62 cls.def("contains", py::vectorize((bool (Region::*)(double, double, double) const)&Region::contains),
63 "x"_a, "y"_a, "z"_a);
64 cls.def("contains", py::vectorize((bool (Region::*)(double, double) const)&Region::contains),
65 "lon"_a, "lat"_a);
66 cls.def("__contains__", py::overload_cast<UnitVector3d const &>(&Region::contains, py::const_),
67 py::is_operator());
68 // The per-subclass relate() overloads are used to implement
69 // double-dispatch in C++, and are not needed in Python.
70 cls.def("relate",
71 (Relationship(Region::*)(Region const &) const) & Region::relate,
72 "region"_a);
73 cls.def("overlaps",
74 (TriState(Region::*)(Region const &) const)&Region::overlaps,
75 "region"_a);
76 cls.def("encode", &python::encode);
77 cls.def_static("decode", &python::decode<Region>, "bytes"_a);
78 cls.def_static("decodeBase64", py::overload_cast<std::string_view const&>(&Region::decodeBase64),
79 "bytes"_a);
80 cls.def_static("decodeOverlapsBase64",
81 py::overload_cast<std::string_view const&>(&Region::decodeOverlapsBase64),
82 "bytes"_a);
83 cls.def_static("getRegions", Region::getRegions, "region"_a);
84}
85
86} // sphgeom
87} // lsst
This file declares a class for representing axis-aligned bounding boxes in ℝ³.
This file declares a class for representing circular regions on the unit sphere.
This file declares a class for representing convex polygons with great circle edges on the unit spher...
This file defines an interface for spherical regions.
This file declares a class for representing unit vectors in ℝ³.
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition Region.h:89
static std::unique_ptr< Region > decodeBase64(std::string const &s)
Definition Region.h:176
virtual Circle getBoundingCircle() const =0
getBoundingCircle returns a bounding-circle for this region.
virtual Relationship relate(Region const &) const =0
virtual Box getBoundingBox() const =0
getBoundingBox returns a bounding-box for this region.
static std::vector< std::unique_ptr< Region > > getRegions(Region const &region)
getRegions returns a vector of Region.
Definition Region.cc:145
virtual bool contains(UnitVector3d const &) const =0
contains tests whether the given unit vector is inside this region.
virtual std::unique_ptr< Region > clone() const =0
clone returns a deep copy of this region.
virtual TriState overlaps(Region const &other) const =0
Definition Region.cc:59
virtual bool isEmpty() const =0
isEmpty returns true when a region does not contain any points.
static TriState decodeOverlapsBase64(std::string const &s)
Definition Region.h:190
virtual Box3d getBoundingBox3d() const =0
getBoundingBox3d returns a 3-dimensional bounding-box for this region.
TriState represents a boolean value with additional unknown state.
Definition TriState.h:46
std::unique_ptr< R > decode(pybind11::bytes bytes)
Decode a Region from a pybind11 bytes object.
Definition utils.h:69
pybind11::bytes encode(Region const &self)
Encode a Region as a pybind11 bytes object.
Definition utils.h:61
void defineClass(Pybind11Class &cls)
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
This file declares a class for representing longitude/latitude angle boxes on the unit sphere.
This file declares a class for representing elliptical regions on the unit sphere.