LSST Applications g07dc498a13+5a531fccd6,g1409bbee79+5a531fccd6,g1a7e361dbc+5a531fccd6,g1fd858c14a+bae9e05889,g28da252d5a+b6acab2954,g33399d78f5+749e2df9f6,g35bb328faa+e55fef2c71,g3bd4b5ce2c+753c3426d3,g3d4cdeeb7c+495e717508,g43bc871e57+32b9ddb877,g53246c7159+e55fef2c71,g60b5630c4e+f9e43d3906,g6e5c4a0e23+f441d97430,g78460c75b0+8427c4cc8f,g786e29fd12+307f82e6af,g8534526c7b+af2545e932,g85d8d04dbe+ded3a614ca,g89139ef638+5a531fccd6,g8b49a6ea8e+f9e43d3906,g9125e01d80+e55fef2c71,g989de1cb63+5a531fccd6,g9a9baf55bd+f1bd1a7c26,g9f33ca652e+c963d5c8aa,gaaedd4e678+5a531fccd6,gabe3b4be73+9c0c3c7524,gb092a606b0+a33ed67792,gb58c049af0+28045f66fd,gc2fcbed0ba+f9e43d3906,gca43fec769+e55fef2c71,gcf25f946ba+749e2df9f6,gd6cbbdb0b4+784e334a77,gde0f65d7ad+a0ab96d407,ge278dab8ac+25667260f6,geab183fbe5+f9e43d3906,gecb8035dfe+0fa5abcb94,gefa07fa684+89734069dd,gf58bf46354+e55fef2c71,gfe7187db8c+55cd7d2043,w.2025.01
LSST Data Management Base Package
Loading...
Searching...
No Matches
_ellipse.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
31#include "lsst/sphgeom/python.h"
32
33#include "lsst/sphgeom/Box.h"
34#include "lsst/sphgeom/Box3d.h"
35#include "lsst/sphgeom/Circle.h"
40
43
44namespace py = pybind11;
45using namespace pybind11::literals;
46
47namespace lsst {
48namespace sphgeom {
49
50template <>
52 cls.attr("TYPE_CODE") = py::int_(Ellipse::TYPE_CODE);
53
54 cls.def_static("empty", &Ellipse::empty);
55 cls.def_static("full", &Ellipse::full);
56
57 cls.def(py::init<>());
58 cls.def(py::init<Circle const &>(), "circle"_a);
59 cls.def(py::init<UnitVector3d const &, Angle>(), "center"_a,
60 "angle"_a = Angle(0.0));
61 cls.def(py::init<UnitVector3d const &, UnitVector3d const &, Angle>(),
62 "focus1"_a, "focus2"_a, "alpha"_a);
63 cls.def(py::init<UnitVector3d const &, Angle, Angle, Angle>(), "center"_a,
64 "alpha"_a, "beta"_a, "orientation"_a);
65 cls.def(py::init<Ellipse const &>(), "ellipse"_a);
66
67 cls.def("__eq__", &Ellipse::operator==, py::is_operator());
68 cls.def("__ne__", &Ellipse::operator!=, py::is_operator());
69
70 cls.def("isFull", &Ellipse::isFull);
71 cls.def("isGreatCircle", &Ellipse::isGreatCircle);
72 cls.def("isCircle", &Ellipse::isCircle);
73 cls.def("getTransformMatrix", &Ellipse::getTransformMatrix);
74 cls.def("getCenter", &Ellipse::getCenter);
75 cls.def("getF1", &Ellipse::getF1);
76 cls.def("getF2", &Ellipse::getF2);
77 cls.def("getAlpha", &Ellipse::getAlpha);
78 cls.def("getBeta", &Ellipse::getBeta);
79 cls.def("getGamma", &Ellipse::getGamma);
80 cls.def("complement", &Ellipse::complement);
81 cls.def("complemented", &Ellipse::complemented);
82
83 // Note that the Region interface has already been wrapped.
84
85 cls.def("__str__", [](Ellipse const &self) {
86 return py::str("Ellipse({!s}, {!s}, {!s})")
87 .format(self.getF1(), self.getF2(), self.getAlpha());
88 });
89 cls.def("__repr__", [](Ellipse const &self) {
90 return py::str("Ellipse({!r}, {!r}, {!r})")
91 .format(self.getF1(), self.getF2(), self.getAlpha());
92 });
93 cls.def(py::pickle(&python::encode, &python::decode<Ellipse>));
94}
95
96} // sphgeom
97} // 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 contains a class representing 3x3 real matrices.
This file declares a class for representing unit vectors in ℝ³.
Angle represents an angle in radians.
Definition Angle.h:50
Ellipse is an elliptical region on the sphere.
Definition Ellipse.h:177
static constexpr std::uint8_t TYPE_CODE
Definition Ellipse.h:179
bool isCircle() const
Definition Ellipse.h:232
Angle getAlpha() const
getAlpha returns α, the first semi-axis length of the ellipse.
Definition Ellipse.h:259
UnitVector3d getF2() const
getF2 returns the second focal point of the ellipse.
Definition Ellipse.h:251
bool isGreatCircle() const
Definition Ellipse.h:230
static Ellipse full()
Definition Ellipse.h:183
Angle getBeta() const
getBeta returns β, the second semi-axis length of the ellipse.
Definition Ellipse.h:264
UnitVector3d getF1() const
getF1 returns the first focal point of the ellipse.
Definition Ellipse.h:245
Angle getGamma() const
getGamma returns ɣ ∈ [0, π/2], half of the angle between the foci.
Definition Ellipse.h:268
bool isFull() const
Definition Ellipse.h:228
static Ellipse empty()
Definition Ellipse.h:181
Ellipse & complement()
complement sets this ellipse to the closure of its complement.
Definition Ellipse.h:271
Matrix3d const & getTransformMatrix() const
getTransformMatrix returns the orthogonal matrix that maps vectors to the basis in which the quadrati...
Definition Ellipse.h:237
Ellipse complemented() const
complemented returns the closure of the complement of this ellipse.
Definition Ellipse.h:281
UnitVector3d getCenter() const
getCenter returns the center of the ellipse as a unit vector.
Definition Ellipse.h:240
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition Region.h:89
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)
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.