xcompare.xr_stats module

Module for computing area-weighted statistics

xcompare.xr_stats.corr(arr1, arr2, area)

Calculates area-weighted correlation

Parameters:

• arr1 (numpy.ndarray) – First array

• arr2 (numpy.ndarray) – Second array

• area (numpy.ndarray) – Cell area field

Return type:

numpy.float64

xcompare.xr_stats.cov(arr1, arr2, area)

Calculates area-weighted covariance

Parameters:

• arr1 (numpy.ndarray) – First array

• arr2 (numpy.ndarray) – Second array

• area (numpy.ndarray) – Cell area field

Return type:

numpy.float64

xcompare.xr_stats.xr_stats_2d(arr1, arr2, area, fmt='list')

Calculates basic area-weighted statistics for two DataArrays

Parameters:

• arr1 (xarray.DataArray) – First input array

• arr2 (xarray.DataArray) – Second input array

• area (xarray.DataArray) – Cell area field

• fmt (str) – Define output format “list” or “dict”, default=”list”

Return type:

List or dict of bias, rmse, and pattern correlation