dash.ensembleFilter.observations

Process the observations for a filter object

Syntax


[outputs, type] = obj.observations(header, …)
[obsCell, ‘return’] = obj.observations(header)
[objCell, ‘set’] = obj.observations(header, Y)
[objCell, ‘delete’] = obj.observations(header, ‘delete’)

Description


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

Processes options for observations for a filter object. Returns the appropriate outputs collected in a cell, and a string indicating the type of operation performed.


[obsCell, ‘return’] = obj.observations(header)

Returns the current observation matrix.


[objCell, ‘set’] = obj.observations(header, Y)

Error checks the input observation matrix and overwrites any previously existing observations. Returns the updated filter object.


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

Deletes any current observations and returns the updated filter object.

Input Arguments

Y

Y

numeric matrix [nSite x nTime]

Observations for the filter

Output Arguments

outputs

outputs

cell scalar

Varargout-style outputs

type

type

‘return’|’set’|’delete’

Indicates the type of operation

obsCell

obsCell

cell scalar {Y}

The current observations in a cell

objCell

objCell

cell scalar {obj}

The updated object in a cell