LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
lsst.geom._SpherePoint.SpherePoint Class Reference

Public Member Functions

 __iter__ (self)
 
 __repr__ (self)
 

Static Public Member Functions

 toUnitXYZ (*longitude=None, latitude=None, ra=None, dec=None, units)
 

Detailed Description

Definition at line 38 of file _SpherePoint.py.

Member Function Documentation

◆ __iter__()

lsst.geom._SpherePoint.SpherePoint.__iter__ ( self)

Definition at line 40 of file _SpherePoint.py.

40 def __iter__(self):
41 for i in (0, 1):
42 yield self[i]
43

◆ __repr__()

lsst.geom._SpherePoint.SpherePoint.__repr__ ( self)

Definition at line 44 of file _SpherePoint.py.

44 def __repr__(self):
45 argList = ["%r*degrees" % (pos.asDegrees(),) for pos in self]
46 return "SpherePoint(%s)" % (", ".join(argList))
47

◆ toUnitXYZ()

lsst.geom._SpherePoint.SpherePoint.toUnitXYZ ( * longitude = None,
latitude = None,
ra = None,
dec = None,
units )
static
Compute the unit 3-vectors (as separate arrays) corresponding to
arrays of longitude and latitude.

Parameters
----------
longitude : `float` or `numpy.ndarray`
    Longitude coordinate of input points.
latitude : `float` or `numpy.ndarray`
    Latitude coordinate of input points.
ra : `float` or `numpy.ndarray`
    Synonym for `longitude`.
dec : `float` or `numpy.ndarray`
    Synonym for `latitude`.
units : `AngleUnit`
    Angle unit for inputs.

Returns
-------
x : `float` or numpy.ndarray`
    X coordinates of unit 3-vectors.
y : `float` or numpy.ndarray`
    Y coordinates of unit 3-vectors.
z : `float` or numpy.ndarray`
    Z coordinates of unit 3-vectors.

Notes
-----
The returned Cartesian coordinate values are not guaranteed to be
normalized according to the conventions of `sphgeom.UnitVector3d`, but
are nevertheless compatible with the various vectorized `contains`
methods in `sphgeom` because those apply that normalization
internally.

Definition at line 49 of file _SpherePoint.py.

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)

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