Skip to content

Commit

Permalink
minor docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ks905383 committed Feb 15, 2024
1 parent 677ba99 commit db8df95
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If calculating weights from rasters is taking a substantial amount of time (e.g.
# Continue as usual...
aggregated = xa.aggregate(ds,weightmap)

Note that :py:meth:`weightmap.to_file(fn)` creates and populates a separate _directory_ named ``fn`` to be able to store all the relevant components of the :py:class:`weightmap` class, including shapefiles with the geometry of the input polygons, the dataframe with the pixel overlap data, the source grid, and any additional weight grids.
Note that ``weightmap.to_file(fn)`` creates and populates a separate _directory_ named ``fn`` to be able to store all the relevant components of the :py:class:`weightmap` class, including shapefiles with the geometry of the input polygons, the dataframe with the pixel overlap data, the source grid, and any additional weight grids.

This feature is still slightly experimental, so please let us know your experiences!

Expand All @@ -46,7 +46,7 @@ At the expense of increased memory usage, processing may be sped up using an alt

Create diagnostic figure to inspect raster/polygon overlaps
------------------------------------------------------------
Once you have created a :py:class:`weightmap`, the following code will create a diagnostic figure, showing a particular polygon (or groups of polygons) + the grid cells that overlap it, colored by the relative overlap of each grid cell with the polygon (NB: this currently only works if :py:meth:`xa.pixel_overlaps` is run with `subset_to_bbox=False`, or using `subset_find` as detailed in `Detailed Code Run <./full_run.ipynb>`_)::
Once you have created a :py:class:`weightmap`, the following code will create a diagnostic figure, showing a particular polygon (or groups of polygons) + the grid cells that overlap it, colored by the relative overlap of each grid cell with the polygon (NB: this currently only works if :py:meth:`xa.pixel_overlaps` is run with ``subset_to_bbox=False``, or using :py:meth:`xa.subset_find` as detailed in `Detailed Code Run <./notebooks/full_run.ipynb>`_)::

# Querying polygon by column of the polygon `gdf`
weightmap.diag_fig({'name':'Alaska'},ds)
Expand Down

0 comments on commit db8df95

Please sign in to comment.