dash.stateVectorVariable.weightedMean

Apply a weighted mean to dimensions of a state vector variable


Syntax



Description

obj = obj.weightedMean(dims, weights, header)

Takes a weighted mean 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.

Output Arguments

obj

scalar dash.*stateVectorVariable* object
The variable with updated weighted mean parameters.