PSM.bayspar.rows

Indicate the stateVector rows used to run a BaySPAR PSM

Syntax



obj = obj.rows(row)


obj = obj.rows(memberRows)


obj = obj.rows(evolvingRows)


rows = obj.rows


obj = obj.rows(‘delete’)

Description



obj = obj.rows(row)

Indicate the state vector row that should be used as the SST input for the BaySPAR PSM when calling the “PSM.estimate” command. The input is a scalar. Uses the same state vector row for each ensemble member and each ensemble in an evolving set.



obj = obj.rows(memberRows)

Indicate which state vector row to use for each ensemble member. This syntax allows you to use different state vector rows for different ensemble members. The input is a row vector with one element per ensemble member.



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 x 1 x nEvolving] or of size [1 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 BaySPAR PSM object.

Input Arguments

row

scalar linear index
The state vector row that holds the SST input required to run the BaySPAR PSM. Uses the same row for all ensemble members and ensembles in an evolving set.

memberRows

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

evolvingRows

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

rows

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