pelagos_py.steps.quality_control.spike_qc#

class pelagos_py.steps.quality_control.spike_qc.spike_qc(data, **kwargs)[source]#

Bases: pelagos_py.steps.base_qc.BaseQC

Target Variable: Any Flag Number: 4 (bad) Variables Flagged: Any Checks for spiking in the data using rolling median values compared against the meadian average deviation (MAD).

Example

- name: "Apply QC"
  parameters:
    qc_settings: {
        "spike test": {
          "variables": {"PRES": 2, "LATITUDE": 1},
          "also_flag": {"PRES": ["CNDC", "TEMP"], "LATITUDE": ["LONGITUDE"]},
          "plot": ["PRES", "LATITUDE"]
          "window_size": 10,
        }
    }
  diagnostics: true
return_qc()[source]#

Representative of QC processing, to be overridden by subclasses.

Returns:

flags – Output QC flags for the data specific to the test.

Return type:

array-like

plot_diagnostics()[source]#

Representative of diagnostic plotting (optional).