optimalSensor.metric

Specify the metric for an optimal sensor


Syntax



Description

obj = obj.metric(J)

Provide the initial sensor metric for optimal sensor algorithms. The metric is a scalar value assessed across an ensemble. The ability of observation sites to reduce the variance of the metric across the ensemble forms the basis of the optimal sensor algorithm. The sensor metric should be a vector with one element per ensemble member and cannot contain NaN values.

J = obj.metric

Returns the current metric for the optimal sensor object.

obj = obj.metric(‘delete’)

Deletes any current metric from the optimal sensor object.f


Input Arguments

J

numeric vector [nMembers]
The initial sensor metric for any optimal sensor algorithms. A numeric vector with one element per ensemble member.

Output Arguments

obj

scalar optimalSensor object
The optimalSensor object with an updated metric

J

numeric row vector [1 x nMembers]
The current metric for the optimalSensor object