PSM.bayfox.rows

Indicate the stateVector rows used to run a BayFOX PSM

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 vector rows that should be used as input for the BayFOX PSM when calling “PSM.estimate”. By default, the input should be a column vector with two element. The first element is the row of the SST input, and the second element is the row of the d18O (seawater) input.

If you provided a fixed value of d18Osw, then the input should be scalar and should indicate the row of the SST input. Similarly, if you provided a fixed SST value, then the input should be scalar and should indicate the row of the d18Osw input.



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 either 1 row (when there is fixed d18O or SST), or 2 rows (when neither variable is fixed) and one column per ensemble member. If the matrix has two rows, the the first row indicates SST inputs, and the second row is the d18O (seawater) inputs.



obj = obj.rows(evolvingRows)

Indicate which state vector row to use for different ensembles in an evolving set. 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 [1|2 x 1 x nEvolving] or of size [1|2 x nMembers x nEvolving]. If the second dimension has a size of 1, uses the same row for all the ensemble members in a particular evolving ensemble. If the second dimension has a size of nMembers, allows you to use a different row 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 BayFOX PSM object.

Input Arguments

rows

column vector, linear indices [1|2]
The state vector rows required to run the PSM. If either d18Osw or SST is fixed, then rows is a scalar and indicates the state vector row holding the unfixed input. If neither variable is fixed, then rows is a column vector with two elements. The first element is the row of the SST inputs and the second element is the row of the d18O_seawater inputs.

memberRows

matrix, linear indices [1|2 x nMembers]
Indicates which state vector rows to use for each ensemble member. Should be a matrix with one (fixed d18O or SST) or two rows (neither variable fixed) and one column per ensemble member. If using two rows, the first row is the SST inputs, and the second row is the d18O_seawater inputs.

evolvingRows

3*D* array, linear indices [1|2 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 bayfox object
The BayFOX PSM with updated rows

rows

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