dash.ensembleFilter.processWhich

Parses and processes whichR and whichPrior inputs

Syntax



obj = obj.processWhich(whichArg, field, nIndex, indexType, timeIsSet, whichIsSet, header)

Description

Interprets whichR and whichPrior inputs. Error checks to ensure that which arguments are the correct length and valid indices. Sets nTime if appropriate. Saves the which argument for evolving values. Records an empty array for static values.

Input Arguments

whichArg

any data type
The whichR or whichPrior argument being parsed

field

‘whichR’ | ‘whichPrior’
Indicates which field to update

nIndex

nR | nPrior
Indicates the number of R uncertainties or number of priors that the which argument can index into

indexType

string scalar
Identifying name for the indices

timeIsSet

scalar logical
True is time is set for the filter and should not be updated via whichArg. False if whichArg can update nTime.

whichIsSet

scalar logical
True if whichArg is already set by another data input and should not be updated. False if whichArg can update the field.

Output Arguments

obj

scalar dash.*ensembleFilter* object
The updated filter object