kalmanFilter.kalmanFilter

Create a new kalmanFilter object

Syntax



obj = kalmanFilter


obj = kalmanFilter(label)


obj = kalmanFilter(labels)


obj = kalmanFilter(size)


obj = kalmanFilter(size, labels)

Description



obj = kalmanFilter

Initializes a new Kalman filter object. The new object does not have observations, estimates, uncertainties, or a prior. The algorithm will only return the ensemble mean when run.



obj = kalmanFilter(label)


obj = kalmanFilter(labels)

Also applies a label to the Kalman filter object. If unset, the label is set to an empty string. If labels is a string array, returns an array of Kalman filter objects and applies the corresponding label to each individual Kalman filter.



obj = kalmanFilter(size)


obj = kalmanFilter(size, labels)

Initializes an array of Kalman filter objects of the indicated size. Optionally also applies a label to each object in the array. If applying labels, the size of the “labels” array must match the requested size of the kalmanFilter array.

Input Arguments

labels

string array | cellstring array | char row vector
Labels for the elements of a kalmanFilter array. If the only input, the output array will have the same size as labels. If combined with the “size input, must be the size of the requested array.

size

row vector, positive integers
Indicates the size of the requested array of kalmanFilter objects. Must have at least 2 elements, and all elements must be non-negative integers.

Output Arguments

obj

scalar kalmanFilter object | kalmanFilter array
A new kalmanFilter object or an array of kalmanFilter objects.