PSM.prysm.coral.coral

Create a new PRYSM coral PSM object

Syntax



obj = PSM.prysm.coral(lat, lon)


obj = PSM.prysm.coral(…, ‘d18O’, d18O)


obj = PSM.prysm.coral(…, ‘species’, species)


obj = PSM.prysm.coral(…, ‘b1’, b1)


obj = PSM.prysm.coral(…, ‘b2’, b2)


obj = PSM.prysm.coral(…, ‘b3’, b3)


obj = PSM.prysm.coral(…, ‘b4’, b4)


obj = PSM.prysm.coral(…, ‘b5’, b5)

Description



obj = PSM.prysm.coral(lat, lon)

Creates a new PSM object that implements the PRYSM coral sensor module. Runs the model without d18O as an input using the default coral species and default d18O-SSS slope.

Please see the documentation of the “pseudocoral.py” function in the psm.coral.sensor module of PRYSM for additional details on the inputs.



obj = PSM.prysm.coral(…, ‘d18O’, d18O)

Indicate whether the model should run using d18O as an input. Default is to not use it as an input.



obj = PSM.prysm.coral(…, ‘species’, species)

Indicate the species of the coral. This sets the slope of the coral-SST regression. See details below.



obj = PSM.prysm.coral(…, ‘b1’, b1)


obj = PSM.prysm.coral(…, ‘b2’, b2)


obj = PSM.prysm.coral(…, ‘b3’, b3)


obj = PSM.prysm.coral(…, ‘b4’, b4)


obj = PSM.prysm.coral(…, ‘b5’, b5)

Set the d18O-SSS slope for different regions of the globe.

Input Arguments

lat

numeric scalar
The latitude of the site in decimal degrees

lon

numeric scalar
The longitude of the site in decimal degrees

d18O

scalar logical
True if the model should use d18O as an input. Otherwise false (default).

species

string scalar
The name of the coral species. This sets the slope of the coral-SST regression.

[“Default”]: a = -0.22

[“Porites_sp”]: a = -.26178

[“Porites_lob”]: a = -.19646

[“Porites_lut”]: a = -.17391

[“Porites_aus”]: a = -.21

[“Montast”]: a = -.22124

[“Diploas”]: a = -.14992

b1

numeric scalar
Red sea d18O-SSS slope. Default is 0.31

b2

numeric scalar
Tropical Pacific d18O-SSS slope. Default is 0.27

b3

numeric scalar
South Pacific d18O-SSS slope. Default is 0.45

b4

numeric scalar
Indian Ocean d18O-SSS slope. Default is 0.16

b5

numeric scalar
Tropical Atlantic/Caribbean d18O-SSS slope. Default is 0.15

Output Arguments

obj

scalar PSM.*prysm*.*coral* object
The new PRYSM coral PSM object