LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Member Functions | List of all members
lsst.geom._SpherePoint.SpherePoint Class Reference

Public Member Functions

def __iter__ (self)
 
def __repr__ (self)
 

Static Public Member Functions

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

Detailed Description

Definition at line 38 of file _SpherePoint.py.

Member Function Documentation

◆ __iter__()

def 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__()

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

Definition at line 44 of file _SpherePoint.py.

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

◆ toUnitXYZ()

def 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: