dash.stateVectorVariable.sequence

Apply a sequence to ensemble dimensions of a state vector variable


Syntax



Description

obj = obj.sequence(dims, indices, metadata, header)

Applies sequences to the indicated ensemble dimensions.

obj = obj.sequence(dims, “none”, [], header)

Removes any sequences from the specified dimensions.


Input Arguments

dims

vector, linear indices [nDimensions]
The indices of the ensemble dimensions to update.

indices

cell vector [nDimensions] {additive indices [nIndices]}
The sequence indices to use for each dimension.

metadata

cell vector [nDimensions] {metadata matrix [nIndices x ?]}
The sequence metadata to use for each dimension

Output Arguments

obj

scalar dash.*stateVectorVariable* object
The variable with updated sequence parameters.