File: coordinates.rst

package info (click to toggle)
python-xarray 2025.08.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 11,796 kB
  • sloc: python: 115,416; makefile: 258; sh: 47
file content (81 lines) | stat: -rw-r--r-- 1,434 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
.. currentmodule:: xarray

Coordinates
===========

Creating coordinates
--------------------

.. autosummary::
   :toctree: ../generated/

   Coordinates
   Coordinates.from_xindex
   Coordinates.from_pandas_multiindex

Attributes
----------

.. autosummary::
   :toctree: ../generated/

   Coordinates.dims
   Coordinates.sizes
   Coordinates.dtypes
   Coordinates.variables
   Coordinates.indexes
   Coordinates.xindexes

Dictionary Interface
--------------------

Coordinates implement the mapping interface with keys given by variable names
and values given by ``DataArray`` objects.

.. autosummary::
   :toctree: ../generated/

   Coordinates.__getitem__
   Coordinates.__setitem__
   Coordinates.__delitem__
   Coordinates.update
   Coordinates.get
   Coordinates.items
   Coordinates.keys
   Coordinates.values

Coordinates contents
--------------------

.. autosummary::
   :toctree: ../generated/

   Coordinates.to_dataset
   Coordinates.to_index
   Coordinates.assign
   Coordinates.merge
   Coordinates.copy

Comparisons
-----------

.. autosummary::
   :toctree: ../generated/

   Coordinates.equals
   Coordinates.identical

Proxies
-------

.. currentmodule:: xarray.core.coordinates

Coordinates that are accessed from the ``coords`` property of Dataset, DataArray
and DataTree objects, respectively.

.. autosummary::
   :toctree: ../generated/

   DatasetCoordinates
   DataArrayCoordinates
   DataTreeCoordinates