File: glossary.rst

package info (click to toggle)
astropy 5.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 41,972 kB
  • sloc: python: 219,331; ansic: 147,297; javascript: 13,556; lex: 8,496; sh: 3,319; xml: 1,622; makefile: 185
file content (92 lines) | stat: -rw-r--r-- 3,351 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
.. currentmodule:: astropy

****************
Astropy Glossary
****************

.. glossary::

   (`n`,)
      A parenthesized number followed by a comma denotes a tuple with one
      element. The trailing comma distinguishes a one-element tuple from a
      parenthesized ``n``.
      This is from NumPy; see https://numpy.org/doc/stable/glossary.html.

   number
      Any numeric type. eg float or int or any of the ``numpy.number``.

   -like
      Used to indicate on object of that type or that can instantiate the type.
      E.g. :class:`~astropy.units.Quantity`-like includes ``"2 * u.km"``
      because ``astropy.units.Quantity("2 * u.km")`` works.

   unit-like
      Must be an :class:`~astropy.units.UnitBase` (subclass) instance or a
      string or other instance parseable by :class:`~astropy.units.Unit`.

   quantity-like
      Must be an `~astropy.units.Quantity` (or subclass) instance or a string
      parseable by `~astropy.units.Quantity`.
      Note that the interpretation of units in strings depends on the class --
      ``Quantity("180d")`` is 180 **days**, while ``Angle("180d")`` is 180
      **degrees** -- so check the string parses as intended for ``Quantity``.

   ['physical type']
       The physical type of a quantity can be annotated in square brackets
       following a `~astropy.units.Quantity` (or similar :term:`quantity-like`).

       For example, ``distance : quantity-like ['length']``

   angle-like
      :term:`quantity-like`, but interpreted by an angular
      `~astropy.units.SpecificTypeQuantity`, like `~astropy.coordinates.Angle`
      or `~astropy.coordinates.Longitude` or `~astropy.coordinates.Latitude`.
      Note that the interpretation of units in strings depends on the class --
      ``Quantity("180d")`` is 180 days, while ``Angle("180d")`` is 180 degrees
      -- so make sure the string parses as intended for ``Angle``.

   length-like
      :term:`quantity-like`, but interpretable by
      :class:`~astropy.coordinates.Distance`.

   frame-like
      A :class:`~astropy.coordinates.BaseCoordinateFrame` subclass instance or a
      string that can be converted to a Frame by
      :class:`~astropy.coordinates.sky_coordinate_parsers._get_frame_class`.

   coordinate-like
      A Coordinate-type object such as a
      :class:`~astropy.coordinates.BaseCoordinateFrame` subclass instance or a
      :class:`~astropy.coordinates.SkyCoord` (or subclass) instance.

   table-like
      An astropy :class:`~astropy.table.Table` or any object that can
      initialize one. Anything marked as table-like will be processed through
      a :class:`~astropy.table.Table`.

   time-like
      :class:`~astropy.time.Time` or any valid initializer.

   buffer-like
      Anything that implements Python's buffer protocol. See
      https://docs.python.org/3/c-api/buffer.html#bufferobjects

   writable file-like object
      In the context of a :term:`python:file-like object` object, anything
      that supports writing with a method ``write``.

   readable file-like object
      In the context of a :term:`python:file-like object` object, anything
      that supports writing with a method ``read``.


***************************
Optional Packages' Glossary
***************************

.. currentmodule:: matplotlib.pyplot

.. glossary::

   color
      Any valid Matplotlib color.