PSM.baymag.baymag

Creates a new BayMAG PSM object


Syntax



Description

obj = PSM.baymag(age, clean, species)

Initializes a new BayMAG PSM object. The PSM will require SST, SSS, Omega, and pH inputs from the ensemble. Please see the documentation of baymag_forward_ln.m in the BayMAG repository for details about the inputs.

obj = PSM.baymag(…, ‘options’, options)

Provide optional arguments to the BayMAG forward model. See the documentation of baymag_forward_ln.m in the BayMAG repository for details.

obj = PSM.baymag(…, ‘pH’, pH) Uses a fixed value for pH, rather than values from the ensemble.

obj = PSM.baymag(…, ‘omega’, omega) Uses a fixed value for Omega, rather than values from the ensemble.

obj = PSM.baymag(…, ‘salinity’, salinity) Uses a fixed value for sea-surface salinity, rather than values from the ensemble.

obj = PSM.baymag(…, ‘sst’, sst) Uses a fixed value for sea-surface temperatures, rather than values from the ensemble.


Input Arguments

age

numeric scalar
Age of the observation

clean

numeric scalar
Describes the cleaning technique

species

string scalar
Name of the target species.

options

cell vector
Optional arguments for the BayMAG PSM

pH

numeric scalar
pH (total scale)

omega

numeric scalar
Bottom water saturation state

salinity

numeric scalar
Sea surface salinity (in psu)

sst

numeric scalar
Sea surface temperature (Celsius)

Output Arguments

obj

scalar PSM.*baymag* object
The new BayMAG PSM object