dash.ensembleFilter.estimates

Process the estimates for a filter object

Syntax



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


[estCell, ‘return’] = obj.estimates(header)


[objCell, ‘set’] = obj.estimates(header, Ye)


[objCell, ‘set’] = obj.estimates(header, Ye, whichPrior)


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

Description



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

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



[estCell, ‘return’] = obj.estimates(header)

Returns the current estimates and whichPrior.



[objCell, ‘set’] = obj.estimates(header, Ye)


[objCell, ‘set’] = obj.estimates(header, Ye, whichPrior)

Error checks the input estimates and whichPrior and overwrites any previously existing estimates. Returns the updated filter object.



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

Deletes any current estimates and returns the updated filter object.

Input Arguments

Ye

numeric array [nSite x nMembers x nPrior]
Estimates for the filter

whichPrior

vector, linear indices [nTime]
Indicates which prior (set of estimates) to use in each time step.

Output Arguments

outputs

cell scalar
Varargout-style outputs

type

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

estCell

cell vector [2] {Y, whichPrior}
The current estimates and whichPrior in a cell

objCell

cell scalar {obj}
The updated object in a cell