reVeal.overlay.calc_feature_count#

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

Calculate the count of features intersecting each zone in input zones dataframe.

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 to be counted. 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. Note that none of these are used, but this allows passing an arbitrary dictionary that includes both used and unused parameters as input to the function.

Returns:

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