reVeal.overlay.calc_sum_attribute_length#

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

Calculate the sum of attribute-length of input features intersecting each zone in input zones dataframe. Attribute-length is defined as the product of the length of each feature in each zone and the specified attribute value (i.e., length * attribute).

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 whose attribute-lengths will be summed. Expected to a be a LineString or MultiLineString input, though this is not checked. Results for Points/MultiPoints will be returned as all zeros, and results for Polygons/MultiPolygons will use perimeters instead of lengths. Must be in the same CRS as the zones_df.

  • attribute (str) – Name of attribute in dset_src to use for calculating attribute-lengths.

  • 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 sum of attribute-lengths of features in each zone. The index from the input zones_df is also included.