PSM.Interface.rows

Indicate the state vector rows required to run a forward model

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 row that should be used as input to the PSM when calling the “PSM.estimate” command. The input is a column vector with one element per slope/linear coefficient in the forward model. 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 one row per required input and one column per ensemble member.



obj = obj.rows(evolvingRows)

Indicate which state vector rows 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 [nInputs x 1 x nEvolving] or of size [nInputs 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 differents 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 PSM object.

Input Arguments

rows

column vector, linear indices [nInputs]
The state vector rows that hold the variables required to run the PSM. Uses the same rows for all ensemble members and ensembles in an evolving set.

memberRows

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

evolvingRows

3*D* array, linear indices [nInputs x 1|*nMembers* x nEvolving]
Indicates which state vector rows 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 rows 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 rows to use for each ensemble member in each evolving ensemble.

Output Arguments

obj

scalar PSM object
The PSM with updated rows

rows

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