solarforecastarbiter.validation.quality_mapping.check_if_series_flagged

solarforecastarbiter.validation.quality_mapping.check_if_series_flagged(flag_series, flag_description)[source]

Check if flag_series has been flagged for the checks given by flag_description

Parameters:
  • flag_series (pandas.Series) – Series of integer quality flags
  • flag_description (string or iterable of strings) – Checks to compare flag_series to. If this is an iterable, the result will be a boolean indicating if the flag represents ANY of the checks.
Returns:

pandas.Series – Boolean Series indicating if ANY of flag_description checks are represented by each flag
Raises:
  • ValueError – If any of flag_series has not been validated.
  • TypeError – If flag_description is not a string or iterable of strings
  • KeyError – If flag_description is not a possible check for the flag version