pastas.check.stat_ufunc_threshold#
- pastas.check.stat_ufunc_threshold(ml: pastas.typing.Model, ufunc: collections.abc.Callable, statistic: str, threshold: float, **kwargs)#
Generic function to compare a model statistic with a threshold using a ufunc.
- Parameters:
ml (pastas.Model) – Pastas model instance.
ufunc (callable) – Numpy ufunc (e.g. np.greater_than) to compare the model statistic with the threshold.
statistic (str) – Name of the statistic to be compared.
threshold (float) – Threshold value for the statistic.
**kwargs – Additional keyword arguments to pass to the statistic function.
- Returns:
df – DataFrame with the results of the check.
- Return type: