uvex_transients.cli.pipeline.run_yield_summary#

uvex_transients.cli.pipeline.run_yield_summary(config: RunConfig, raw: EventCatalog, detected: EventCatalog, exposure: ExposureCatalog) → YieldTable[source]#

Build a YieldTable per the config’s yield: section (Clopper-Pearson confidence level).

Parameters:

  • config (RunConfig) – The parsed run-config.

  • raw (EventCatalog) – The feasible (pre-cut) catalog – typically run_generate’s own output.

  • detected (EventCatalog) – The detected (post-cut) catalog – typically run_cuts’s own output.

  • exposure (ExposureCatalog) – Typically run_exposure’s own output.

Returns:

One row per transient type in config.transients.

Return type:

YieldTable