DiscoveryMetric¶
- class rubin_sim.maf.metrics.DiscoveryMetric(n_obs_per_night=2, t_min=0.003472222222222222, t_max=0.0625, n_nights_per_window=3, t_window=15, snr_limit=None, badval=None, **kwargs)¶
Bases:
BaseMoMetric
Identify the discovery opportunities for an SSobject.
- Parameters:
- n_obs_per_nightint, optional
Number of observations required within a single night. Default 2.
- t_minfloat, optional
Minimum time span between observations in a single night, in days. Default 5 minutes (5/60/24).
- t_maxfloat, optional
Maximum time span between observations in a single night, in days. Default 90 minutes.
- n_nights_per_windowint, optional
Number of nights required with observations, within the track window. Default 3.
- t_windowint, optional
Number of nights included in the track window. Default 15.
- snr_limitNone or float, optional
SNR limit to use for observations. If snr_limit is None, (default), then it uses the completeness calculation added to the ‘vis’ column (probabilistic visibility, based on 5-sigma limit). If snr_limit is not None, it uses this SNR value as a cutoff.
- metricNamestr, optional
The metric name to use. Default will be to construct Discovery_nObsPerNightxnNightsPerWindowintWindow.
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