Skip to content

Commit 7022c15

Browse files
remi-braunremi-braun
authored
Fix rasterio tables (#915)
1 parent 2e5cf73 commit 7022c15

1 file changed

Lines changed: 59 additions & 59 deletions

File tree

‎docs/getting_started/switching_from_rasterio.rst‎

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -31,75 +31,75 @@ Profile
3131

3232
Here is the parameters that you can derive from ``rasterio``'s Dataset profile:
3333

34-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
35-
| ``rasterio`` from ``ds.profile`` | ``rioxarray`` from DataArray |
36-
+==================================+=======================================================================================================================+
37-
| :attr:`blockxsize` | :attr:`.encoding["preferred_chunks"]["x"]` |
38-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
39-
| :attr:`blockysize` | :attr:`.encoding["preferred_chunks"]["y"]` |
40-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
41-
| :attr:`compress` | *Unused in rioxarray* |
42-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
43-
| :attr:`~rasterio.io.DatasetReader.count` | :attr:`rio.count <rioxarray.rioxarray.XRasterBase.count>` |
44-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
45-
| :attr:`~rasterio.io.DatasetReader.crs` | :attr:`rio.crs <rioxarray.rioxarray.XRasterBase.crs>` |
46-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
47-
| :attr:`~rasterio.io.DatasetReader.driver` | Unused in rioxarray |
48-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
49-
| :attr:`~rasterio.io.DatasetReader.dtype` | :attr:`.encoding["rasterio_dtype"]` |
50-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
51-
| :attr:`~rasterio.io.DatasetReader.height` | :attr:`rio.height <rioxarray.rioxarray.XRasterBase.height>` |
52-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
53-
| :attr:`interleave` | Unused in rioxarray |
54-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
55-
| :attr:`~rasterio.io.DatasetReader.nodata` | :attr:`rio.nodata <rioxarray.raster_array.RasterArray.nodata>` (or `encoded_nodata <nodata_management.html>`_ ) |
56-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
57-
| :attr:`tiled` | Unused in rioxarray |
58-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
59-
| :attr:~rasterio.io.DatasetReader.transform` | :func:`rio.transform() <rioxarray.rioxarray.XRasterBase.transform>` |
60-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
61-
| :attr:`~rasterio.io.DatasetReader.width` | :attr:`rio.width <rioxarray.rioxarray.XRasterBase.width>` |
62-
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
34+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
35+
| ``rasterio`` from ``ds.profile`` | ``rioxarray`` from DataArray |
36+
+==============================================+=======================================================================================================================+
37+
| :attr:`blockxsize` | :attr:`.encoding["preferred_chunks"]["x"]` |
38+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
39+
| :attr:`blockysize` | :attr:`.encoding["preferred_chunks"]["y"]` |
40+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
41+
| :attr:`compress` | *Unused in rioxarray* |
42+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
43+
| :attr:`~rasterio.io.DatasetReader.count` | :attr:`rio.count <rioxarray.rioxarray.XRasterBase.count>` |
44+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
45+
| :attr:`~rasterio.io.DatasetReader.crs` | :attr:`rio.crs <rioxarray.rioxarray.XRasterBase.crs>` |
46+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
47+
| :attr:`~rasterio.io.DatasetReader.driver` | Unused in rioxarray |
48+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
49+
| :attr:`~rasterio.io.DatasetReader.dtype` | :attr:`.encoding["rasterio_dtype"]` |
50+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
51+
| :attr:`~rasterio.io.DatasetReader.height` | :attr:`rio.height <rioxarray.rioxarray.XRasterBase.height>` |
52+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
53+
| :attr:`interleave` | Unused in rioxarray |
54+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
55+
| :attr:`~rasterio.io.DatasetReader.nodata` | :attr:`rio.nodata <rioxarray.raster_array.RasterArray.nodata>` (or `encoded_nodata <nodata_management.html>`_ ) |
56+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
57+
| :attr:`tiled` | Unused in rioxarray |
58+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
59+
| :attr:`~rasterio.io.DatasetReader.transform` | :func:`rio.transform() <rioxarray.rioxarray.XRasterBase.transform>` |
60+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
61+
| :attr:`~rasterio.io.DatasetReader.width` | :attr:`rio.width <rioxarray.rioxarray.XRasterBase.width>` |
62+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
6363

6464
The values not used in ``rioxarray`` comes from the abstraction of the dataset in ``xarray``: a dataset no longer belongs to a file on disk even if read from it. The driver and other file-related notions are meaningless in this context.
6565

6666
Other dataset parameters
6767
------------------------
6868

69-
+----------------------------------+-------------------------------------------------------------------+
70-
| ``rasterio`` from ``ds`` | ``rioxarray`` from DataArray |
71-
+==================================+===================================================================+
72-
| :attr:`~rasterio.io.DatasetReader.gcps` or :func:`~rasterio.io.DatasetReader.get_gcps` | :func:`rio.get_gcps() <rioxarray.rioxarray.XRasterBase.get_gcps>` |
73-
+----------------------------------+-------------------------------------------------------------------+
74-
| :attr:`~rasterio.io.DatasetReader.rpcs` | :func:`rio.get_rpcs() <rioxarray.rioxarray.XRasterBase.get_rpcs>` |
75-
+----------------------------------+-------------------------------------------------------------------+
76-
| :attr:`~rasterio.io.DatasetReader.bounds` | :func:`rio.bounds() <rioxarray.rioxarray.XRasterBase.bounds>` |
77-
+----------------------------------+-------------------------------------------------------------------+
69+
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
70+
| ``rasterio`` from ``ds`` | ``rioxarray`` from DataArray |
71+
+========================================================================================+===================================================================+
72+
| :attr:`~rasterio.io.DatasetReader.gcps` or :func:`~rasterio.io.DatasetReader.get_gcps` | :func:`rio.get_gcps() <rioxarray.rioxarray.XRasterBase.get_gcps>` |
73+
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
74+
| :attr:`~rasterio.io.DatasetReader.rpcs` | :func:`rio.get_rpcs() <rioxarray.rioxarray.XRasterBase.get_rpcs>` |
75+
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
76+
| :attr:`~rasterio.io.DatasetReader.bounds` | :func:`rio.bounds() <rioxarray.rioxarray.XRasterBase.bounds>` |
77+
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
7878

7979
Functions
8080
---------
8181

82-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
83-
| ``rasterio`` | ``rioxarray`` |
84-
+====================================+===================================================================================================================================+
85-
| :func:`rasterio.open` | :func:`rioxarray.open_rasterio` or :attr:`xarray.open_dataset(..., engine="rasterio", decode_coords="all") <xarray.open_dataset>` |
86-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
87-
| :func:`~rasterio.io.DatasetReader.read` | :func:`compute() <xarray.DataArray.compute>` (load data into memory) |
88-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
89-
| :func:`ds.read(... window=) <rasterio.io.DatasetReader.read>` | :func:`rio.isel_window() <rioxarray.rioxarray.XRasterBase.isel_window>` |
90-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
91-
| :func:`~rasterio.io.DatasetWriter.write` | :func:`rio.to_raster() <rioxarray.raster_array.RasterArray.to_raster>` |
92-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
93-
| :func:`mask(..., crop=False) <rasterio.mask.mask>` | :func:`rio.clip(..., drop=False) <rioxarray.raster_array.RasterArray.clip>` |
94-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
95-
| :func:`mask(..., crop=True) <rasterio.mask.mask>` | :func:`rio clip(..., drop=True) <rioxarray.raster_array.RasterArray.clip>` |
96-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
97-
| :func:`~rasterio.warp.reproject` | :func:`rio.reproject() <rioxarray.raster_array.RasterArray.reproject>` |
98-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
99-
| :func:`~rasterio.merge.merge` | :func:`rioxarray.merge.merge_arrays` |
100-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
101-
| :func:`~rasterio.fill.fillnodata` | :func:`rio.interpolate_na() <rioxarray.raster_array.RasterArray.interpolate_na>` |
102-
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
82+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
83+
| ``rasterio`` | ``rioxarray`` |
84+
+===============================================================+===================================================================================================================================+
85+
| :func:`rasterio.open` | :func:`rioxarray.open_rasterio` or :attr:`xarray.open_dataset(..., engine="rasterio", decode_coords="all") <xarray.open_dataset>` |
86+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
87+
| :func:`~rasterio.io.DatasetReader.read` | :func:`compute() <xarray.DataArray.compute>` (load data into memory) |
88+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
89+
| :func:`ds.read(... window=) <rasterio.io.DatasetReader.read>` | :func:`rio.isel_window() <rioxarray.rioxarray.XRasterBase.isel_window>` |
90+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
91+
| :func:`~rasterio.io.DatasetWriter.write` | :func:`rio.to_raster() <rioxarray.raster_array.RasterArray.to_raster>` |
92+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
93+
| :func:`mask(..., crop=False) <rasterio.mask.mask>` | :func:`rio.clip(..., drop=False) <rioxarray.raster_array.RasterArray.clip>` |
94+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
95+
| :func:`mask(..., crop=True) <rasterio.mask.mask>` | :func:`rio clip(..., drop=True) <rioxarray.raster_array.RasterArray.clip>` |
96+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
97+
| :func:`~rasterio.warp.reproject` | :func:`rio.reproject() <rioxarray.raster_array.RasterArray.reproject>` |
98+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
99+
| :func:`~rasterio.merge.merge` | :func:`rioxarray.merge.merge_arrays` |
100+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
101+
| :func:`~rasterio.fill.fillnodata` | :func:`rio.interpolate_na() <rioxarray.raster_array.RasterArray.interpolate_na>` |
102+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
103103

104104

105105

0 commit comments

Comments
 (0)