reVeal.overlay#

overlay module

Note that to expose methods here for by reVeal.grid.CharacterizeGrid.run() and functions dependent on it, the function must be prefixed with calc_.

Functions

calc_area(zones_df, dset_src, weights_dset_src)

Calculate the area of a raster within each zone.

calc_area_apportioned_sum(zones_df, ...[, where])

Calculate the area-apportioned sum of the specified attribute for input features intersecting each zone in input zones dataframe.

calc_area_weighted_average(zones_df, ...[, ...])

Calculate the area-weighted average of the specified attribute for input features intersecting each zone in input zones dataframe.

calc_area_weighted_majority(zones_df, ...[, ...])

Calculate the area-weighted majority of the specified attribute for input features intersecting each zone in input zones dataframe.

calc_feature_count(zones_df, dset_src[, where])

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

calc_mean(zones_df, dset_src, weights_dset_src)

Calculate zonal mean or weighted mean of raster values over the input zones.

calc_median(zones_df, dset_src[, parallel, ...])

Calculate zonal median of raster values over the input zones.

calc_percent_covered(zones_df, dset_src[, where])

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

calc_sum(zones_df, dset_src, weights_dset_src)

Calculate zonal sum or weighted sum of raster values over the input zones.

calc_sum_area(zones_df, dset_src[, where])

Calculate the sum of combined areas of input features intersecting each zone in input zones dataframe.

calc_sum_attribute(zones_df, dset_src, attribute)

Calculate the sum of the specified attribute for all features intersecting each zone in input zones dataframe.

calc_sum_attribute_length(zones_df, ...[, where])

Calculate the sum of attribute-length of input features intersecting each zone in input zones dataframe.

calc_sum_length(zones_df, dset_src[, where])

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

exact_extract_wrap(*args, **kwargs)

Helper function for calling exact_extract in a subprocess without receiving FutureWarning messages from gdal.

zonal_statistic(zones_df, dset_src, stat[, ...])

Calculate zonal statistic for the specified statistic.

zonal_statistic_parallel(zones_df, dset_src, ...)

Calculate zonal statistic for the specified statistic using parallel processing.

zonal_statistic_serial(zones_df, dset_src, stat)

Calculate zonal statistic for the specified statistic using serial processing.