kalmanFilter.observations

Set or return the observations for a Kalman filter

Syntax


obj = obj.observations(Y)
Y = obj.observations
obj = obj.observations(‘delete’)

Description


obj = obj.observations(Y)

Provides the observation matrix (Y) to the Kalman filter object. Overwrites any previously existing observation matrix. Each row holds the observations for a particular site, and each column holds observations for an assimilation time step. Use a NaN value when a site does not have an observations in a particular time step. Inf and complex values are not allowed.


Y = obj.observations

Returns the current observation matrix for the Kalman filter object.


obj = obj.observations(‘delete’)

Deletes any current observation matrix from the Kalman filter object.

Input Arguments

Y

Y

numeric matrix [nSite x nTime]

The proxy observations to use in a Kalman filter. A numeric matrix with one row per proxy site, and one column per assimilated time steps. Use NaN for records that lack an observation in a particular time step. Inf and complex values are not allowed.

Output Arguments

obj

obj

scalar kalmanFilter object

The kalmanFilter object with updated proxy observations