PeakVMagMetric¶
- class rubin_sim.maf.metrics.PeakVMagMetric(**kwargs)¶
Bases:
BaseMoMetric
Pull out the peak V magnitude of all observations of the SSobject.
Methods Summary
run
(sso_obs, orb, hval)Calculate the metric value.
Methods Documentation
- run(sso_obs, orb, hval)¶
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