jgrss/features delayed

doc/source/tutorial-edit.rst

@@ -164,3 +164,27 @@ The GeoWombat :func:`replace` function mimics :func:`pandas.DataFrame.replace`.
 .. note::
 
     The :func:`replace` function is typically used with thematic data.
+
+Clipping to bounds
+------------------
+
+Geowombat's :func:`clip_by_polygon` limits the bounds of the image to match a polygon, 
+where the polygon can be a `GeoDatabase`, or a path to a file readable with `geopandas.read_file()`. 
+You can augment the clip by using a `query` on the polygon attributes,  if multiple polygons 
+are present you can `mask_data` to fill `nan` where polygons are not present, or expand the clip 
+array bounds by `expand_by` pixels on each side.
+
+.. code:: python
+
+    import geowombat as gw
+    from geowombat.data import l8_224078_20200518, l8_224078_20200518_polygons
+    import geopandas as gpd
+
+    polys = gpd.read_file(l8_224078_20200518_polygons)
+
+
+    with gw.open(l8_224078_20200518) as src:
+        src.gw.clip_by_polygon(df, 
+                               query="name == water",
+                               mask_data=True,
+                               expand_by=1)