dash.ensembleFilter.prior

Process the prior for a filter object

Syntax



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


[priorCell, ‘return’] = obj.prior(header)


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


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


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

Description



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

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



[priorCell, ‘return’] = obj.prior(header)

Returns the current prior and whichPrior.



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


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

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



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

Deletes any current prior and returns the updated filter object.

Input Arguments

Ye

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

whichPrior

vector, linear indices [nTime]
Indicates which prior to use in each time step.

Output Arguments

outputs

cell scalar
Varargout-style outputs

type

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

priorCell

cell vector [2] {X, whichPrior}
The current prior and whichPrior in a cell

objCell

cell scalar {obj}
The updated object in a cell