Skip to content

DOC: Fix format of rasterio tables added in #910 #915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snowman2 merged 1 commit into from
Mar 3, 2026
Merged

DOC: Fix format of rasterio tables added in #910 #915

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 59 additions & 59 deletions docs/getting_started/switching_from_rasterio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,75 +31,75 @@ Profile

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

+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| ``rasterio`` from ``ds.profile`` | ``rioxarray`` from DataArray |
+==================================+=======================================================================================================================+
| :attr:`blockxsize` | :attr:`.encoding["preferred_chunks"]["x"]` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`blockysize` | :attr:`.encoding["preferred_chunks"]["y"]` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`compress` | *Unused in rioxarray* |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.count` | :attr:`rio.count <rioxarray.rioxarray.XRasterBase.count>` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.crs` | :attr:`rio.crs <rioxarray.rioxarray.XRasterBase.crs>` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.driver` | Unused in rioxarray |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.dtype` | :attr:`.encoding["rasterio_dtype"]` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.height` | :attr:`rio.height <rioxarray.rioxarray.XRasterBase.height>` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`interleave` | Unused in rioxarray |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.nodata` | :attr:`rio.nodata <rioxarray.raster_array.RasterArray.nodata>` (or `encoded_nodata <nodata_management.html>`_ ) |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`tiled` | Unused in rioxarray |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:~rasterio.io.DatasetReader.transform` | :func:`rio.transform() <rioxarray.rioxarray.XRasterBase.transform>` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.width` | :attr:`rio.width <rioxarray.rioxarray.XRasterBase.width>` |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| ``rasterio`` from ``ds.profile`` | ``rioxarray`` from DataArray |
+==============================================+=======================================================================================================================+
| :attr:`blockxsize` | :attr:`.encoding["preferred_chunks"]["x"]` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`blockysize` | :attr:`.encoding["preferred_chunks"]["y"]` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`compress` | *Unused in rioxarray* |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.count` | :attr:`rio.count <rioxarray.rioxarray.XRasterBase.count>` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.crs` | :attr:`rio.crs <rioxarray.rioxarray.XRasterBase.crs>` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.driver` | Unused in rioxarray |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.dtype` | :attr:`.encoding["rasterio_dtype"]` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.height` | :attr:`rio.height <rioxarray.rioxarray.XRasterBase.height>` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`interleave` | Unused in rioxarray |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.nodata` | :attr:`rio.nodata <rioxarray.raster_array.RasterArray.nodata>` (or `encoded_nodata <nodata_management.html>`_ ) |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`tiled` | Unused in rioxarray |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.transform` | :func:`rio.transform() <rioxarray.rioxarray.XRasterBase.transform>` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.width` | :attr:`rio.width <rioxarray.rioxarray.XRasterBase.width>` |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+

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.

Other dataset parameters
------------------------

+----------------------------------+-------------------------------------------------------------------+
| ``rasterio`` from ``ds`` | ``rioxarray`` from DataArray |
+==================================+===================================================================+
| :attr:`~rasterio.io.DatasetReader.gcps` or :func:`~rasterio.io.DatasetReader.get_gcps` | :func:`rio.get_gcps() <rioxarray.rioxarray.XRasterBase.get_gcps>` |
+----------------------------------+-------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.rpcs` | :func:`rio.get_rpcs() <rioxarray.rioxarray.XRasterBase.get_rpcs>` |
+----------------------------------+-------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.bounds` | :func:`rio.bounds() <rioxarray.rioxarray.XRasterBase.bounds>` |
+----------------------------------+-------------------------------------------------------------------+
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| ``rasterio`` from ``ds`` | ``rioxarray`` from DataArray |
+========================================================================================+===================================================================+
| :attr:`~rasterio.io.DatasetReader.gcps` or :func:`~rasterio.io.DatasetReader.get_gcps` | :func:`rio.get_gcps() <rioxarray.rioxarray.XRasterBase.get_gcps>` |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.rpcs` | :func:`rio.get_rpcs() <rioxarray.rioxarray.XRasterBase.get_rpcs>` |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :attr:`~rasterio.io.DatasetReader.bounds` | :func:`rio.bounds() <rioxarray.rioxarray.XRasterBase.bounds>` |
+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+

Functions
---------

+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| ``rasterio`` | ``rioxarray`` |
+====================================+===================================================================================================================================+
| :func:`rasterio.open` | :func:`rioxarray.open_rasterio` or :attr:`xarray.open_dataset(..., engine="rasterio", decode_coords="all") <xarray.open_dataset>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.io.DatasetReader.read` | :func:`compute() <xarray.DataArray.compute>` (load data into memory) |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`ds.read(... window=) <rasterio.io.DatasetReader.read>` | :func:`rio.isel_window() <rioxarray.rioxarray.XRasterBase.isel_window>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.io.DatasetWriter.write` | :func:`rio.to_raster() <rioxarray.raster_array.RasterArray.to_raster>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`mask(..., crop=False) <rasterio.mask.mask>` | :func:`rio.clip(..., drop=False) <rioxarray.raster_array.RasterArray.clip>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`mask(..., crop=True) <rasterio.mask.mask>` | :func:`rio clip(..., drop=True) <rioxarray.raster_array.RasterArray.clip>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.warp.reproject` | :func:`rio.reproject() <rioxarray.raster_array.RasterArray.reproject>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.merge.merge` | :func:`rioxarray.merge.merge_arrays` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.fill.fillnodata` | :func:`rio.interpolate_na() <rioxarray.raster_array.RasterArray.interpolate_na>` |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| ``rasterio`` | ``rioxarray`` |
+===============================================================+===================================================================================================================================+
| :func:`rasterio.open` | :func:`rioxarray.open_rasterio` or :attr:`xarray.open_dataset(..., engine="rasterio", decode_coords="all") <xarray.open_dataset>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.io.DatasetReader.read` | :func:`compute() <xarray.DataArray.compute>` (load data into memory) |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`ds.read(... window=) <rasterio.io.DatasetReader.read>` | :func:`rio.isel_window() <rioxarray.rioxarray.XRasterBase.isel_window>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.io.DatasetWriter.write` | :func:`rio.to_raster() <rioxarray.raster_array.RasterArray.to_raster>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`mask(..., crop=False) <rasterio.mask.mask>` | :func:`rio.clip(..., drop=False) <rioxarray.raster_array.RasterArray.clip>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`mask(..., crop=True) <rasterio.mask.mask>` | :func:`rio clip(..., drop=True) <rioxarray.raster_array.RasterArray.clip>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.warp.reproject` | :func:`rio.reproject() <rioxarray.raster_array.RasterArray.reproject>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.merge.merge` | :func:`rioxarray.merge.merge_arrays` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`~rasterio.fill.fillnodata` | :func:`rio.interpolate_na() <rioxarray.raster_array.RasterArray.interpolate_na>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+



Expand Down
Loading