dash.ensembleFilter.uncertainties

Process the uncertainties for a filter object

Syntax



[outputs, type] = obj.uncertainties(header, …)


[uncCell, ‘return’] = obj.uncertainties(header)


[objCell, ‘set’] = obj.uncertainties(header, R)


[objCell, ‘set’] = obj.uncertainties(header, R, whichR)


[objCell, ‘set’] = obj.uncertainties(header, R, whichR, type)


[objCell, ‘delete’] = obj.uncertainties(‘delete’)

Description



[outputs, type] = obj.uncertainties(header, …)

Processes options for uncertainties for a filter. Returns the outputs for the operations collected in a cell. Also returns a string indicate the type of operation performed.



[uncCell, ‘return’] = obj.uncertainties(header)

Returns the current uncertainties and whichR.



[objCell, ‘set’] = obj.uncertainties(header, R)


[objCell, ‘set’] = obj.uncertainties(header, R, whichR)


[objCell, ‘set’] = obj.uncertainties(header, R, whichR, type)

Error checks the input uncertainties and whichR and overwrites any previously existing uncertainties. Returns the updated filter object.



[objCell, ‘delete’] = obj.uncertainties(‘delete’)

Deletes any current uncertainties and returns the updated filter object.

Input Arguments

R

numeric matrix [nSite x nR] | numeric array [nSite x nSite x nR]
Uncertainties for the filter

whichR

vector, linear indices [nTime]
Indicates which set of uncertainties to use in each time step

type

string scalar | scalar logical
Indicates whether the uncertainties are variances or covariances

[“v”|”var”|”variance”|false]: Error variances

[“c”|”cov”|”covariance”|true]: Error covariances

Output Arguments

outputs

cell scalar
Varargout-style outputs

type

‘return’|’set’|’delete’
Indicates the type of operation

uncCell

cell vector [2] {R, whichR}
The current uncertainties and whichR in a cell

objCell

cell scalar {obj}
The updated object in a cell