contour.py#

Contains a class and functions to support calculation of temperature and salinity (TS) contours.

class seabirdscientific.contour.ContourData(x: ndarray, y: ndarray, z: ndarray, x_vec: ndarray, y_vec: ndarray, z_mat: ndarray)#

Container for contour data for a TS plot.

Example variables are shown next to each field

seabirdscientific.contour.contour_from_t_c_p(temperature_C: ndarray, conductivity_mScm: ndarray, pressure_dbar: ndarray, min_salinity: float = 0, lat: float = 0, lon: float = 0) ContourData#

Converts conductivity (C) to salinity (S) then calls derive_ct_sa_pd_from_t_s_p to derive conservative temperature (CT), absolute salinity (SA), and potential density (PD).

Parameters:
  • temperature_C – Measured temperature in degrees C

  • Conductivity_mScm – Measured conductivity in mSiemens/cm

  • pressure_dbar – Measured pressure in decibar

  • min_salinity – Minimum salinity to include in contour data. Defaults to 0

  • lat – Used to determine absolute salinity (SA). Defaults to 0

  • lon – Used to determine absolute salinity (SA). Defaults to 0

Returns:

dataclass with xyz data for creating a TS plot

seabirdscientific.contour.contour_from_t_s_p(temperature_C: ndarray, salinity_PSU: ndarray, pressure_dbar: ndarray, min_salinity: float = 0, lat: float = 0, lon: float = 0) ContourData#

Converts temperature (T), salinity (S), and pressure (P) to conservative temperature (CT), absolute salinity (SA), and potential density (PD). CT is derived from ITS-90 temperature and practical salinity measurements. PD is derived from SA and CT.

Parameters:
  • temperature_C – Measured temperature in degrees C

  • salinity_PSU – Measured salinity in practical salinity units

  • pressure_dbar – Measured pressure in decibars

  • min_salinity – Minimum salinity to include in contour data. Defaults to 0

  • lat – Used to determine absolute salinity (SA). Defaults to 0

  • lon – Used to determine absolute salinity (SA). Defaults to 0

Returns:

dataclass with xyz data for creating a TS plot