TotalNumberSSO¶
- class rubin_sim.maf.metrics.TotalNumberSSO(h_mark=22, dndh_func=<function neo_dndh_granvik>, **kwargs)¶
Bases:
BaseMoMetric
Calculate the total number of objects of a given population expected at a given H value or larger.
Operations on differential completeness values (or equivalent; fractions of the population is ok if still a differential metric result, not cumulative).
- Parameters:
- h_mark
float
, optional The H value at which to calculate the expected total number of objects. Default = 22.
- dndh_func
function
, optional The dN/dH distribution to use to calculate the expected population size.
- h_mark
- Returns:
- nObj
float
The predicted number of objects in the population.
- nObj
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