LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
_ellipse.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * See COPYRIGHT file at the top of the source tree.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22#include "pybind11/pybind11.h"
23
24#include "lsst/sphgeom/python.h"
25
26#include "lsst/sphgeom/Box.h"
27#include "lsst/sphgeom/Box3d.h"
28#include "lsst/sphgeom/Circle.h"
33
36
37namespace py = pybind11;
38using namespace pybind11::literals;
39
40namespace lsst {
41namespace sphgeom {
42
43template <>
45 cls.attr("TYPE_CODE") = py::int_(Ellipse::TYPE_CODE);
46
47 cls.def_static("empty", &Ellipse::empty);
48 cls.def_static("full", &Ellipse::full);
49
50 cls.def(py::init<>());
51 cls.def(py::init<Circle const &>(), "circle"_a);
52 cls.def(py::init<UnitVector3d const &, Angle>(), "center"_a,
53 "angle"_a = Angle(0.0));
54 cls.def(py::init<UnitVector3d const &, UnitVector3d const &, Angle>(),
55 "focus1"_a, "focus2"_a, "alpha"_a);
56 cls.def(py::init<UnitVector3d const &, Angle, Angle, Angle>(), "center"_a,
57 "alpha"_a, "beta"_a, "orientation"_a);
58 cls.def(py::init<Ellipse const &>(), "ellipse"_a);
59
60 cls.def("__eq__", &Ellipse::operator==, py::is_operator());
61 cls.def("__ne__", &Ellipse::operator!=, py::is_operator());
62
63 cls.def("isEmpty", &Ellipse::isEmpty);
64 cls.def("isFull", &Ellipse::isFull);
65 cls.def("isGreatCircle", &Ellipse::isGreatCircle);
66 cls.def("isCircle", &Ellipse::isCircle);
67 cls.def("getTransformMatrix", &Ellipse::getTransformMatrix);
68 cls.def("getCenter", &Ellipse::getCenter);
69 cls.def("getF1", &Ellipse::getF1);
70 cls.def("getF2", &Ellipse::getF2);
71 cls.def("getAlpha", &Ellipse::getAlpha);
72 cls.def("getBeta", &Ellipse::getBeta);
73 cls.def("getGamma", &Ellipse::getGamma);
74 cls.def("complement", &Ellipse::complement);
75 cls.def("complemented", &Ellipse::complemented);
76
77 // Note that the Region interface has already been wrapped.
78
79 cls.def("__str__", [](Ellipse const &self) {
80 return py::str("Ellipse({!s}, {!s}, {!s})")
81 .format(self.getF1(), self.getF2(), self.getAlpha());
82 });
83 cls.def("__repr__", [](Ellipse const &self) {
84 return py::str("Ellipse({!r}, {!r}, {!r})")
85 .format(self.getF1(), self.getF2(), self.getAlpha());
86 });
87 cls.def(py::pickle(&python::encode, &python::decode<Ellipse>));
88}
89
90} // sphgeom
91} // 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 ℝ³.
Ellipse is an elliptical region on the sphere.
Definition: Ellipse.h:170
static constexpr uint8_t TYPE_CODE
Definition: Ellipse.h:172
bool isCircle() const
Definition: Ellipse.h:225
Angle getAlpha() const
getAlpha returns α, the first semi-axis length of the ellipse.
Definition: Ellipse.h:252
UnitVector3d getF2() const
getF2 returns the second focal point of the ellipse.
Definition: Ellipse.h:244
bool isGreatCircle() const
Definition: Ellipse.h:223
static Ellipse full()
Definition: Ellipse.h:176
Angle getBeta() const
getBeta returns β, the second semi-axis length of the ellipse.
Definition: Ellipse.h:257
UnitVector3d getF1() const
getF1 returns the first focal point of the ellipse.
Definition: Ellipse.h:238
Angle getGamma() const
getGamma returns ɣ ∈ [0, π/2], half of the angle between the foci.
Definition: Ellipse.h:261
bool isFull() const
Definition: Ellipse.h:221
static Ellipse empty()
Definition: Ellipse.h:174
Ellipse & complement()
complement sets this ellipse to the closure of its complement.
Definition: Ellipse.h:264
bool isEmpty() const
Definition: Ellipse.h:219
Matrix3d const & getTransformMatrix() const
getTransformMatrix returns the orthogonal matrix that maps vectors to the basis in which the quadrati...
Definition: Ellipse.h:230
Ellipse complemented() const
complemented returns the closure of the complement of this ellipse.
Definition: Ellipse.h:274
UnitVector3d getCenter() const
getCenter returns the center of the ellipse as a unit vector.
Definition: Ellipse.h:233
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition: Region.h:79
lsst::geom::Angle Angle
Definition: misc.h:33
pybind11::bytes encode(Region const &self)
Encode a Region as a pybind11 bytes object.
Definition: utils.h:53
void defineClass(Pybind11Class &cls)
A base class for image defects.
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.