Update documentation for ROI and stats (#676)

Author: vschaffn

dev-environment.yml

@@ -13,7 +13,7 @@ dependencies:
   - tqdm
   - scikit-image=0.*
   - scikit-gstat>=1.0.18,<1.1
-  - geoutils=0.1.12
+  - geoutils=0.1.13
   - affine
   - pandas
   - pyogrio

doc/source/dem_class.md

@@ -136,6 +136,23 @@ slope.plot(cmap="Reds", cbar_title="Slope (°)")
 For the full list of terrain attributes, see the {ref}`terrain-attributes` page.
 ```
 
+## Statistics
+The [`get_stats()`](https://geoutils.readthedocs.io/en/latest/gen_modules/geoutils.Raster.get_stats.html) method allows to extract key statistical information from a raster in a dictionary.
+
+- Get all statistics in a dict:
+```{code-cell} ipython3
+dem.get_stats()
+```
+
+The DEM statistics functionalities in `xdem` are based on those in `geoutils`.
+For more information on computing statistics, please refer to the [`geoutils` documentation](https://geoutils.readthedocs.io/en/latest/raster_class.html#obtain-statistics).
+
+
+Note: as [`get_stats()`](https://geoutils.readthedocs.io/en/latest/gen_modules/geoutils.Raster.get_stats.html) is a raster method, it can also be used for terrain attributes:
+```{code-cell} ipython3
+slope.get_stats()
+```
+
 ## Coregistration
 
 3D coregistration is performed with {func}`~xdem.DEM.coregister_3d`, which aligns the
@@ -182,3 +199,8 @@ We use `random_state` to ensure a fixed randomized output. It is **only necessar
 
 For more details on quantifying random and structured errors, see the {ref}`uncertainty` page.
 ```
+
+## Cropping a DEM
+
+The DEM cropping functionalities in `xdem` are based on those in `geoutils` ([`crop()`](https://geoutils.readthedocs.io/en/latest/gen_modules/geoutils.Raster.crop.html#geoutils.Raster.crop), [`icrop()`](https://geoutils.readthedocs.io/en/latest/gen_modules/geoutils.Raster.icrop.html#geoutils.Raster.icrop)).
+For more information on using cropping functions, please refer to the [`geoutils` documentation](https://geoutils.readthedocs.io/en/latest/raster_class.html#crop).

environment.yml

@@ -13,7 +13,7 @@ dependencies:
   - tqdm
   - scikit-image=0.*
   - scikit-gstat>=1.0.18,<1.1
-  - geoutils=0.1.12
+  - geoutils=0.1.13
   - pip
   - affine
   - pandas

requirements.txt

@@ -11,7 +11,7 @@ scipy==1.*
 tqdm
 scikit-image==0.*
 scikit-gstat>=1.0.18,<1.1
-geoutils==0.1.12
+geoutils==0.1.13
 pip
 affine
 pandas

xdem/dem.py

@@ -209,6 +209,7 @@ def from_array(
             compatible. If False, will raise an error when incompatible.
         :param vcrs: Vertical coordinate reference system.
 
+
         :returns: DEM created from the provided array and georeferencing.
         """
         # We first apply the from_array of the parent class