MeanValueAtHMetric

class rubin_sim.maf.metrics.MeanValueAtHMetric(h_mark=22, reduce_func=<function mean>, metric_name=None, **kwargs)

Bases: BaseMoMetric

Return the mean value of a metric at a given H.

Allows the metric values to be multi-dimensional (i.e. use a cloned H distribution).

Parameters:
h_markfloat, optional

The H value at which to look up the metric value. Default = 22.

Returns:
value:float

Methods Summary

run(metric_vals, h_vals)

Calculate the metric value.

Methods Documentation

run(metric_vals, h_vals)

Calculate the metric value.

Parameters:
sso_obs: np.ndarray

The input data to the metric (same as the parent metric).

orb: np.ndarray

The information about the orbit for which the metric is being calculated.

hvalfloat

The H value for which the metric is being calculated.

Returns:
float or np.ndarray or dict