LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
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: