Uncertainty Metric

class stonesoup.metricgenerator.uncertaintymetric.SumofCovarianceNormsMetric

Bases: stonesoup.metricgenerator.base.MetricGenerator

Computes the sum of the covariance matrix norms of each state at a time step. The matrix norm calculated is the Frobenius norm. The metric generator will return this value at each time step in the track(s) as a measure of the uncertainty.

compute_metric(manager)

Computes the metric using the data in the metric manager

Parameters

manager (MetricManager) – Contains the data to be used to create the metric

Returns

metric – Containing the metric information. The value of the metric is a list of the metric at each timestamp

Return type

list Metric

static extract_states(object_with_states)

Extracts a list of states from a list of (or single) objects containing states. This method is defined to handle StateMutableSequence and State types.

Parameters

object_with_states (object containing a list of states) – Method of state extraction depends on the type of the object

Returns

Return type

list of State

compute_over_time(track_states)

Compute the metric using the data in the metric manager

Parameters

track_states (list of State) – List of states created by a filter

Returns

metric – Covering the duration that states exist for in the parameters. Metric.value contains a list of the sums of covariance matrix norms at each timestamp

Return type

TimeRangeMetric

compute_sum_covariancenorms(track_states)

Computes the sum of covariance norms metric for a single time step.

Parameters

track_states (list of State) – List of states created by a filter

Returns

metric – The sum of covariance matrix norms metric at a single time step

Return type

SingleTimeMetric