LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
_SpherePoint.py
Go to the documentation of this file.
2# Developed for the LSST Data Management System.
3# This product includes software developed by the LSST Project
4# (https://www.lsst.org).
5# See the COPYRIGHT file at the top-level directory of this distribution
6# for details of code ownership.
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 GNU General Public License
19# along with this program. If not, see <https://www.gnu.org/licenses/>.
20#
21
22__all__ = []
23
24from lsst.utils import continueClass
25
26from ._geom import SpherePoint, _toUnitX, _toUnitY, _toUnitZ
27
28
29def _pickExactlyOne(a, b, message):
30 if a is None and b is not None:
31 return b
32 if a is not None and b is None:
33 return a
34 raise ValueError(message)
35
36
37@continueClass # noqa: F811 (FIXME: remove for py 3.8+)
38class SpherePoint: # noqa: F811
39
40 def __iter__(self):
41 for i in (0, 1):
42 yield self[i]
43
44 def __repr__(self):
45 argList = ["%r*degrees" % (pos.asDegrees(),) for pos in self]
46 return "SpherePoint(%s)" % (", ".join(argList))
47
48 @staticmethod
49 def toUnitXYZ(*, longitude=None, latitude=None, ra=None, dec=None, units):
50 """Compute the unit 3-vectors (as separate arrays) corresponding to
51 arrays of longitude and latitude.
52
53 Parameters
54 ----------
55 longitude : `float` or `numpy.ndarray`
56 Longitude coordinate of input points.
57 latitude : `float` or `numpy.ndarray`
58 Latitude coordinate of input points.
59 ra : `float` or `numpy.ndarray`
60 Synonym for `longitude`.
61 dec : `float` or `numpy.ndarray`
62 Synonym for `latitude`.
63 units : `AngleUnit`
64 Angle unit for inputs.
65
66 Returns
67 -------
68 x : `float` or numpy.ndarray`
69 X coordinates of unit 3-vectors.
70 y : `float` or numpy.ndarray`
71 Y coordinates of unit 3-vectors.
72 z : `float` or numpy.ndarray`
73 Z coordinates of unit 3-vectors.
74
75 Notes
76 -----
77 The returned Cartesian coordinate values are not guaranteed to be
78 normalized according to the conventions of `sphgeom.UnitVector3d`, but
79 are nevertheless compatible with the various vectorized `contains`
80 methods in `sphgeom` because those apply that normalization
81 internally.
82 """
83 factor = (1.0*units).asRadians()
84 lon = factor*_pickExactlyOne(longitude, ra, "Exactly one of ra and longitude must be provided.")
85 lat = factor*_pickExactlyOne(latitude, dec, "Exactly one of dec and latitude must be provided.")
86 return _toUnitX(lon, lat), _toUnitY(lon, lat), _toUnitZ(lon, lat)
toUnitXYZ(*longitude=None, latitude=None, ra=None, dec=None, units)
_pickExactlyOne(a, b, message)