dash.stateVectorVariable.weightedTotal
Apply a weighted total to dimensions of a state vector variable
Syntax
Description
Takes a weighted total over the indicated dimensions.
Input Arguments
dims
vector, linear indices [nDimensions]
The indices of the ensemble dimensions to update.
weights
cell vector [nDimensions] {numeric vector}
Weights to use for each dimension.
header
string scalar
Header for thrown error IDs.
Output Arguments
obj
scalar dash.*stateVectorVariable* object
The variable with updated weighted total parameters.