From c1072bd99770ec91f9785f5f527428ee818f0a0b Mon Sep 17 00:00:00 2001 From: samueljmcameron Date: Thu, 25 Jun 2026 08:58:31 +0100 Subject: [PATCH] Update NewFilter.rst to include diagnosticFlagBenchmark documentation. Included description and example. --- .../jedi-components/ufo/qcfilters/NewFilter.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/inside/jedi-components/ufo/qcfilters/NewFilter.rst b/docs/inside/jedi-components/ufo/qcfilters/NewFilter.rst index f02f3613..ade9184a 100644 --- a/docs/inside/jedi-components/ufo/qcfilters/NewFilter.rst +++ b/docs/inside/jedi-components/ufo/qcfilters/NewFilter.rst @@ -38,3 +38,18 @@ All observation filters in UFO are tested with the :code:`ObsFilters` test from reference: name: TestReference/northward_wind absTol: 1e-5 + +- :code:`diagnosticFlagBenchmark`: A map whose presence instructs the test to count how many instances of a Diagnostic Flag are :code:`true`. Each key is a diagnostic flag along with the relevant variable being tested. Each value is the number of instances that the diagnostic flag is set to :code:`true`. Example: + + .. code-block:: yaml + + diagnosticFlagBenchmark: + PermanentStationRejection/relativeHumidity: 115 + InterpolationCheckRejection/relativeHumidity: 33 + FinalQCRejection/relativeHumidity: 264 + SignificantWindLevelInAscent/relativeHumidity: 0 + TropopauseLevelInAscent/relativeHumidity: 2 + PartialLayerUsedInAveraging/airTemperature: 2 + MaximumWindLevelInAscent/airTemperature: 0 + SignificantWindLevelInAscent/airTemperature: 0 + StandardLevelInAscent/airTemperature: 29