reVeal.grid.run_characterization#

run_characterization(df, characterization)[source]#

Execute a single characterization on an input grid.

Parameters:

  • df (geopandas.GeoDataFrame) – Input grid geodataframe. This should be a polygon geodataframe where all geometries form a coverage (i.e., a non-overlapping mesh) and neighboring geometries share only points or segments of the exterior boundaries. This function also assumes that the index of df is unique for each feature. If either of these are not the case, unexpected results may occur.

  • characterization (reVeal.config.characterize.Characterization) – Input information describing characterization to be run, in the form of a Characterization instance.

Returns:

pandas.DataFrame – Returns a pandas DataFrame with a “value” column, representing the output values from the characterization for each zone. The index from the input df is also included.

On this page