solarforecastarbiter.metrics.deterministic.deadband_mask

solarforecastarbiter.metrics.deterministic.deadband_mask(obs, fx, deadband)[source]

Calculate deadband mask.

\[\text{mask_i} = | fx_i - obs_i | <= deadband * | obs_i |\]

Floating point arithmetic makes the equality difficult to guarantee so do not rely on it.

Equality

Parameters:
  • obs ((n,) array_like) – Observed values.
  • fx ((n,) array_like) – Forecasted values.
  • deadband (float) – Fractional tolerance relative to the observed values.
Returns:

mask (array_like) – 1 if a point is within the deadband, 0 if not