src.toolbox.steps.base_qc

This module defines the base class for QC tests and a registry for QC test classes.

Attributes

REGISTERED_QC	Registry of explicitly registered QC test classes.
flag_cols	Map of QC flag values to colors for diagnostics plotting.

Classes

BaseQC

Initializes a base class for quality control, to be further tweaked when inherited.

Functions

register_qc(cls)

Decorator to mark QC tests that can be accessed by the ApplyQC step.

Module Contents

src.toolbox.steps.base_qc.REGISTERED_QC

Registry of explicitly registered QC test classes.

src.toolbox.steps.base_qc.flag_cols

Map of QC flag values to colors for diagnostics plotting.

src.toolbox.steps.base_qc.register_qc(cls)

Decorator to mark QC tests that can be accessed by the ApplyQC step.

class src.toolbox.steps.base_qc.BaseQC(data, **kwargs)

Initializes a base class for quality control, to be further tweaked when inherited.

Follow the docstring format below when creating new QC tests.

Target Variable: “Any” or a specific variable names (see impossible_location_test.py) Flag Number: “Any” or a specific ARGO flag number Variables Flagged: “Any” or specific variable names, possibly external to the target variable (see valid_profile_test.py) Your description follows here.

Target Variable: Flag Number: Variables Flagged:

qc_name = None

expected_parameters

required_variables = []

qc_outputs = []

data

flags = None

return_qc()

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()

Representative of diagnostic plotting (optional).