ValueAtHMetric¶
- class rubin_sim.maf.metrics.ValueAtHMetric(h_mark=22, **kwargs)¶
Bases:
BaseMoMetricReturn the metric value at a given H value.
Requires the metric values to be one-dimensional (typically, completeness values).
- Parameters:
- h_mark
float, optional The H value at which to look up the metric value. Default = 22.
- h_mark
- Returns:
- value:
float
- value:
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