src.toolbox.steps.custom.variables.oxygen#

Classes#

DeriveUncalibratedPhase

DeriveOptodeTemperature

PhasePressureCorrection

DeriveCalibratedPhase

DeriveOxygenConcentration

MolarDOXYSalinityCorrection

MolarDOXYPressureCorrection

Functions#

check_config(self, expected_params)

Module Contents#

src.toolbox.steps.custom.variables.oxygen.check_config(self, expected_params)[source]#
class src.toolbox.steps.custom.variables.oxygen.DeriveUncalibratedPhase[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Derive Uncalibrated Phase'[source]#
run()[source]#

Example

  • name: “Derive Uncalibrated Phase” parameters:

    # <MANDATORY> blue_phase_name: “BPHASE_DOXY” # <OPTIONAL> red_phase_name: “RPHASE_DOXY”

    diagnostics: false

generate_diagnostics()[source]#
class src.toolbox.steps.custom.variables.oxygen.DeriveOptodeTemperature[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Derive Optode Temperature'[source]#
run()[source]#

Example

  • name: “Derive Optode Temperature” parameters:

    temp_voltage_name: “TEMP_VOLTAGE_DOXY” calib_coefficients: [0, 1, 0, 0, 0, 0]

    diagnostics: false

generate_diagnostics()[source]#
class src.toolbox.steps.custom.variables.oxygen.PhasePressureCorrection[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Phase Pressure Correction'[source]#
run()[source]#

Example

  • name: “Phase Pressure Correction” parameters:

    optode_pressure_name: “PRES” correction_coefficient: 0.1

    diagnostics: false

generate_diagnostics()[source]#
class src.toolbox.steps.custom.variables.oxygen.DeriveCalibratedPhase[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Derive Calibrated Phase'[source]#
run()[source]#

Example

  • name: “Derive Calibrated Phase” parameters:

    uncalibrated_phase_name: “UNCAL_PHASE_DOXY” calib_coefficients: [0, 1, 0, 0]

    diagnostics: false

generate_diagnostics()[source]#
class src.toolbox.steps.custom.variables.oxygen.DeriveOxygenConcentration[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Derive Oxygen Concentration'[source]#
func_poly()[source]#
func_SVU()[source]#
run()[source]#

Example

  • name: “Derive Oxygen Concentration” parameters:

    # <MANDATORY> method: “poly” # <METHOD DEPENDENT> # The following params are for “poly” method temperature_name: “TEMP” calib_coefficient_matrix: [

    [0, 1, 0, 0], [0, 1, 0, 0], [0, 1, 0, 0], [0, 1, 0, 0], [0, 1, 0, 0]

    ]

    diagnostics: false

generate_diagnostics()[source]#
class src.toolbox.steps.custom.variables.oxygen.MolarDOXYSalinityCorrection[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Molar DOXY Salinity Correction'[source]#
oxy_solubility_salinity_correction()[source]#
water_vapour_partial_pressure(reference_salinity=None)[source]#
run()[source]#

Example

  • name: “Molar DOXY Salinity Correction” parameters:

    # <MANDATORY> salinity_name: “PRAC_SALINITY” temperature_name: “TEMP” # <OPTIONAL> reference_salinity: 0

    diagnostics: false

generate_diagnostics()[source]#
class src.toolbox.steps.custom.variables.oxygen.MolarDOXYPressureCorrection[source]#

Bases: toolbox.steps.base_step.BaseStep, toolbox.utils.qc_handling.QCHandlingMixin

step_name = 'Molar DOXY Pressure Correction'[source]#
run()[source]#

Example

  • name: “Molar DOXY Pressure Correction” parameters:

    # <MANDATORY> pressure_name: “PRES” temperature_name: “TEMP” molar_doxy_name: “MOLAR_DOXY_PSAL” uncalibrated_phase_correction_applied: true

    diagnostics: false

generate_diagnostics()[source]#