dash.ensembleFilter.Rcovariance

Returns R uncertainty covariance for a time steps and sites


Syntax



Description

Rcov = obj.Rcovariance(t)

Returns the R covariance matrix for the queried time steps. If the filter has saved R variances, builds a diagonal covariance matrix from the variances.

Rcov = obj.Rcovariance(t, s)

Returns the R covariance matrix at the queried time steps and observation sites. Only includes covariance elements for the requested sites.


Input Arguments

t

vector, linear indices [nTime]
The indices of time steps for a filter

s

vector, linear indices [nSite] | logical indices
The indices of observation sites for a filter. If s is logical, converts it to linear indices.

Output Arguments

Rcov

numeric 3*D* array, [nSite x nSite x nTime]
The covariance matrices for the requested sites in the requested time steps. Each element along the third dimension is a symmetric covariance matrix for a particular time step.