archive-gh-me/rasterio
1
0
Fork 0
mirror of https://github.com/rasterio/rasterio.git synced 2025-12-08 17:36:12 +00:00
Code Issues Projects Releases Wiki Activity

Resampling docs typo (#1902)

Browse Source 
* Fix error in resampling example

* Fix typo in resampling doc

* Introduce sphinx autodoc links in resampling.rst
This commit is contained in:
Guillaume Lostis 2020-04-14 21:50:43 +02:00 committed by GitHub
parent 07b25aac52
commit aabb4dd1ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/topics/resampling.rst
View File

@ -1,7 +1,8 @@
Resampling
==========
For details on changing coordinate reference systems, see `Reprojection`.
For details on changing coordinate reference systems, see
:doc:`Reprojection <reproject>`.
Up and downsampling
-------------------
@ -42,8 +43,8 @@ method.
# scale image transform
transform = dataset.transform * dataset.transform.scale(
(dataset.width / data.shape[-2]),
(dataset.height / data.shape[-1])
(dataset.width / data.shape[-1]),
(dataset.height / data.shape[-2])
)
Downsampling to 1/2 of the resolution can be done with ``upscale_factor = 1/2``.
@ -52,16 +53,16 @@ Downsampling to 1/2 of the resolution can be done with ``upscale_factor = 1/2``.
Resampling Methods
------------------
When you change the raster cell grid, you must recalulate the pixel values.
When you change the raster cell grid, you must recalculate the pixel values.
There is no "correct" way to do this as all methods involve some interpolation.
The current resampling methods can be found in the `rasterio.enums`_ source.
The current resampling methods can be found in the
:class:`rasterio.enums.Resampling()` class.
Of note, the default ``Resampling.nearest`` method may not be suitable for
continuous data. In those cases, ``Resampling.bilinear`` and
``Resampling.cubic`` are better suited. Some specialized statistical
resampling method exist, e.g. ``Resampling.average``, which may be useful when
Of note, the default :attr:`~rasterio.enums.Resampling.nearest` method may not
be suitable for continuous data. In those cases,
:attr:`~rasterio.enums.Resampling.bilinear` and
:attr:`~rasterio.enums.Resampling.cubic` are better suited.
Some specialized statistical resampling method exist, e.g.
:attr:`~rasterio.enums.Resampling.average`, which may be useful when
certain numerical properties of the data are to be retained.
.. _rasterio.enums: https://github.com/mapbox/rasterio/blob/master/rasterio/enums.py#L28