DiscoveryDistanceMetric¶
- class rubin_sim.maf.metrics.DiscoveryDistanceMetric(parent_discovery_metric, distance_col='geo_dist', badval=-999, **kwargs)¶
Bases:
BaseChildMetric
Returns the distance of the first discovery track of an SSobject.
Methods Summary
run
(sso_obs, orb, hval, metric_values)Calculate the child metric value.
Methods Documentation
- run(sso_obs, orb, hval, metric_values)¶
Calculate the child 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.
- metric_valuesdict or np.ndarray
The return value from the parent metric.
- Returns:
- float