dash.posteriorCalculation.weightedMean.weightedMean

Create a new weighted mean index calculation object

Syntax



obj = dash.posteriorCalculation.weightedMean(rows, weights, nanflag)

Description



obj = dash.posteriorCalculation.weightedMean(rows, weights, nanflag)

Creates a new calculation object for a weighted mean index. Assumes that all error checking of inputs occurs in kalmanFilter.index

Input Arguments

rows

vector, linear indices
The state vector rows used in the mean

weights

numeric vector [nRows]
Weights for a weighted mean

nanflag

‘includenan’ | ‘omitnan’
How to treat NaN values in a weighted mean

Output Arguments

obj

scalar weightedMean object
The new weighted mean index calculation object