reVeal.overlay.calc_percent_covered#

calc_percent_covered(zones_df, dset_src, where=None, **kwargs)[source]#

Calculate the percent of each zone covered by the union of the intersecting.

Parameters:

zones_df (geopandas.GeoDataFrame) – Input zones dataframe, to which results will be aggregated. This function assumes that the index of zones_df is unique for each feature. If this is not the case, unexpected results may occur.
dset_src (str) – Path to input vector dataset with geometries to be included in calculating coverage percents. Expected to a be a Polygon or MultiPolygon input, though this is not checked. Results for Points/MultiPoints and LineStrings/MultiLineStrings will be returned as all zeros. Must be in the same CRS as the zones_df.
where (str, optional) – Optional query string to apply to the input dset_src to subset the features included in the results. Should follow the format expr defined in pandas.DataFrame.query.
**kwargs – Arbitrary keyword arguments. Not used, but allows passing extra parameters.

Returns:

pandas.DataFrame – Returns a pandas DataFrame with a “value” column, representing the percent of each zone coverd by input features. The index from the input zones_df is also included.