PSM.prysm.coral.rows

Indicate the stateVector rows used to run the PRYSM coral sensor module

Syntax



obj = obj.rows(rows)


obj = obj.rows(memberRows)


obj = obj.rows(evolvingRows)


rows = obj.rows


obj = obj.rows(‘delete’)

Description



obj = obj.rows(rows)

Indicate the state vectors row that should be used as the SSS, SST, and optionally d18O inputs for the coral sensor module when calling the “PSM.estimate” command. The input is a column vector with either 2 or 3 rows. The first row is SST, and the second is SSS. If the model does not use d18O as input, then there should only be 2 rows. If the model uses d18O inputs, then a third row should locate d18O. Uses the same state vector rows for each ensemble member and each ensemble in an evolving set.



obj = obj.rows(memberRows)

Indicate which state vector rows to use for each ensemble member. This syntax allows you to use different state vector rows for different ensemble members. The input is a matrix with 2 or 3 rows, and one column per ensemble member. The rows should refer to the SSS, SST, and optionally d18O variables (in that order).



obj = obj.rows(evolvingRows)

This syntax allows you to use different state vector rows for different ensembles in an evolving set. The input should be a 3D array of either size [2|3 x 1 x nEvolving] or of size [2|3 x nMembers x nEvolving]. If the second dimension has a size of 1, uses the same rows for all the ensemble members in a particular evolving ensemble. If the second dimension has a size of nMembers, allows you to use different rows for each ensemble member in each evolving ensemble.



rows = obj.rows

Returns the current rows for the PSM object



obj = obj.rows(‘delete’)

Deletes any currently specified rows from the object.

Input Arguments

rows

linear indices, column vector [2|3]
The state vector rows that hold the climate variables required to run the coral sensor module. The first row is SST, second is SSS, and third is relative humidity. Uses the same rows for all ensemble members and ensembles in an evolving set.

memberRows

matrix, linear indices [2|3 x nMembers]
Indicates which state vector rows to use for each ensemble member. Should be a matrix with 2 or 3 rows and one element per ensemble member. Uses the same rows for the ensemble members in different evolving ensembles.

evolvingRows

3*D* array, linear indices [2|3 x 1|*nMembers* x nEvolving]
Indicates which state vector row to use for different ensembles in an evolving set. Should be a 3D array, and the number of elements along the third dimension should match the number of ensembles in the evolving set. If the second dimension has a length of 1, uses the same row for all the ensemble members in each evolving ensemble. If the second dimension has a length equal to the number of ensemble members, allows you to indicate which state vector row to use for each ensemble member in each evolving ensemble.

Output Arguments

obj

scalar prysm.*coral* object
The coral PSM with updated rows

rows

linear indices, [2|3 x 1|*nMembers* x 1|*nEvolving*]
The current rows for the coral PSM