src.toolbox.steps.custom.qc.gross_range_qc#

Gross Range Test QC Step.

Classes#

gross_range_qc

Outside range test similar to IOOS QC gross range test. Not to be confused with range test, which flags within a range.

Module Contents#

class src.toolbox.steps.custom.qc.gross_range_qc.gross_range_qc(data, **kwargs)[source]#

Bases: toolbox.steps.base_qc.BaseQC

Outside range test similar to IOOS QC gross range test. Not to be confused with range test, which flags within a range.

Given two values it checks for data points outside of this range and assigns a corresponding flag as defined in the configuration. The variable_ranges parameter is required for this test, but also_flag is not.

Target Variable: Any Flag Number: Any Variables Flagged: Any

Example

gross range qc:
variable_ranges:
TEMP:

3: [0, 30] # Flags temperature data outside of this range as probably bad (3) 4: [-2.5, 40] # Flags temperature data outside of this range as bad (4)

CNDC:

3: [5, 42] 4: [2, 45]

also_flag:

TEMP: [DOXY] # Flag DOXY based on TEMP flags

qc_name = 'gross range qc'[source]#
dynamic = True[source]#
variable_ranges[source]#
plot[source]#
required_variables[source]#
tested_variables[source]#
qc_outputs[source]#
return_qc()[source]#

Select data outside of the ranges and flag accordingly.

plot_diagnostics()[source]#

Visualise the QC results in a similar manner to range_test