climepi.epimod.SuitabilityModel.reduce#

SuitabilityModel.reduce(suitability_threshold=None, stat=None, quantile=None, rescale=False)[source]#

Get a summary suitability model.

Applies a summary statistic over the equally likely suitability tables and/or calculates a binary suitability model based on a threshold value. If both a suitability threshold and a summary statistic are provided, the suitability threshold is applied first, and then the statistic.

Parameters:

  • suitability_threshold (float, optional) – The threshold value (strictly) above which climate conditions are considered suitable in a binary suitability model. If None, a binary suitability a binary suitability model is not computed. Default is None.

  • stat (str, optional) – The summary statistic to compute. Can be ‘mean’, ‘median’, or ‘quantile’. If None, no summary statistic is computed. Default is None.

  • quantile (array-like of floats, optional) – The quantile(s) to compute if stat is ‘quantile’. Default is None.

  • rescale (bool or str, optional) – If True, the suitability values (after applying any summary statistics) are rescaled so that the maximum value is one. Can also be set to ‘mean’ or ‘median’ such that the mean/median suitability table has max value 1. Has no effect if suitability_threshold is specified. Default is False.

Returns:

SuitabilityModel – The summary suitability model.