API参考
cyeva.base
base 模块主要存放基础对象相关的类和函数。
- class cyeva.base.Comparison(observation, forecast)
对比对象, 即预设预报和观测的两个等长数组, 该对象初始化以后可以进行其支持的相关指标计算。
- 参数:
observation (np.ndarray or list) – 观测数组。
forecast (np.ndarray or list) – 预报数组。
- calc_rmse(observation=None, forecast=None, *args, **kwargs)
计算 均方根误差（RMSE）
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
- 返回:
RMSE 均方根误差值
- 返回类型:
float
- calc_mae(observation=None, forecast=None, *args, **kwargs)
计算 平均绝对误差（MAE）
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
- 返回:
MAE 平均绝对误差
- 返回类型:
float
- calc_chi_square(observation=None, forecast=None, *args, **kwargs)
计算 卡方（χ2）
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
- 返回:
χ2 卡方
- 返回类型:
float
- calc_rss(observation=None, forecast=None, *args, **kwargs)
计算 剩余平方和（RSS）
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
- 返回:
RSS 剩余平方和
- 返回类型:
float
- calc_linregress_args(observation=None, forecast=None, *args, **kwargs)
计算 线性回归参数
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
- 返回:
(斜率, 截距, 相关系数, P值, 标准差)
- 返回类型:
tuple
- calc_bias(observation=None, forecast=None, threshold=0, *args, **kwargs)
计算 晴雨BIAS评分
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
threshold (Number) – 二值化阈值, 高于该值的成员被标记为 True, 否则标记为 False。默认为 0。
- 返回:
BIAS 评分
- 返回类型:
float
- calc_binary_accuracy_ratio(observation=None, forecast=None, threshold=0, *args, **kwargs)
计算 二值准确率
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
threshold (Number) – 二值化阈值, 高于该值的成员被标记为 True, 否则标记为 False。默认为 0。
- 返回:
二值化准确率
- 返回类型:
float
- calc_diff_accuracy_ratio(observation=None, forecast=None, limit=1, *args, **kwargs)
计算 误差准确率
- 参数:
observation (np.ndarray or list) – 观测数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
forecast (np.ndarray or list) – 预报数组, 当为 None 时, 从实例化的对象中获取。默认为 None。
limit (Number) – 预报与观测之间的差值限制, 二者的差值的绝对值低于该值则被认为是预报正确, 否则认为预报错误。默认为 1。
- 返回:
误差准确率
- 返回类型:
float
cyeva.binarize
binarize 模块主要存放二值化相关的函数。
- cyeva.binarize.threshold_binarize(observation, forecast, threshold=0, compare='>=')
基于阈值对观测和预报数组进行二值化
- 参数:
observation (np.ndarray or list) – 观测数组
forecast (np.ndarray or list) – 预报数组
threshold (Number) – 二值化阈值, 高于该值的成员被标记为 True, 否则标记为 False。默认为 0。
compare (str) – 过滤方式, 结合阈值满足此种方式的成员将被标记为 True, 否则为 False。默认为
">="
- 返回:
二值化后由 True 和 False 组成的观测和预报数组
- 返回类型:
tuple
cyeva.statistic
statistic 模块主要存放统计相关的函数。
- cyeva.statistic.calc_binary_quadrant_values(observation, forecast)
计算二值化象限值, 象限值包括：命中数(hits), 漏报数(misses), 空报数(false_alarms), 正确否定数(correct_rejects)
- 参数:
observation (np.ndarray or list) – 由 True 和 False 组成的二值化观测数组
forecast (np.ndarray or list) – 由 True 和 False 组成的二值化预报数组
- 返回:
二值化象限值, 内容为: (hits, misses, false_alarms, correct_rejects, total)
- 返回类型:
tuple
- cyeva.statistic.calc_binary_accuracy_ratio(observation, forecast)
计算 二值准确率
- 参数:
observation (np.ndarray or list) – 由 True 和 False 组成的二值化观测数组
forecast (np.ndarray or list) – 由 True 和 False 组成的二值化预报数组
- 返回:
二值化准确率，单位 %
- 返回类型:
float
- cyeva.statistic.calc_hit_ratio(observation, forecast)
计算 命中率
- 参数:
observation (np.ndarray or list) – 由 True 和 False 组成的二值化观测数组
forecast (np.ndarray or list) – 由 True 和 False 组成的二值化预报数组
- 返回:
命中率，单位 %
- 返回类型:
float