EventCatalog#

class uvex_transients.simulation.event_catalog.EventCatalog(table: QTable, nside: int, order: str, time_bins: Time, seed: SeedSequence | int | None = None, downsample: int | dict[str, int] | None = None)[source]#

A Monte Carlo realization of sampled transient events, tagged by type and time bin.

Produced by generate_events(). Each event carries a parameter_seed rather than sampled physical SED parameters (see sample_events_on_healpix_grid()) – those are regenerated lazily, per event, by Event.sample_parameters()/ Event.simulate_photometry() once an event is reconstructed via get_events().

Methods

`column`(name)	Return a table column as a plain array, rather than an astropy.table.Column/Quantity view.
`compute_detection_efficiency`(detected[, ...])	Estimate each transient type's detection efficiency \(\hat\epsilon = k/n\).
`compute_photometry_catalog`(mission, ...[, ...])	simulate_photometry, wrapped as a PhotometryCatalog rather than a bare QTable.
`compute_yield_summary`(detected, exposure, ...)	Build a per-transient-type yield summary, combining this catalog, detected, and exposure.
`from_disk`(path[, table_format])	Read an event catalog back from disk, as written by `to_disk()`.
`get_events`(ids, transients, schedule)	Reconstruct one or more Event objects from their event_id.
`simulate_photometry`(mission, transients, ...)	Run ~uvex_transients.simulation.event.Event.simulate_photometry over every event in this catalog.
`to_disk`(path[, table_format, overwrite])	Write this catalog's event table to disk as ECSV, with its provenance in the header.

Attributes

`coord`	Every event's sky position.
`downsample`	The downsample factor(s) generation was run with.
`ebv`	Every event's Milky Way foreground E(B-V) (cached at generation time).
`event_id`	Every event's unique id, shape `(n_events,)`.
`healpix_id`	Every event's HEALPix pixel index, at this catalog's own `nside`/`order`.
`luminosity_distance`	Every event's luminosity distance (cached at generation time).
`parameter_seed`	Every event's stored SED parameter seed.
`redshift`	Every event's redshift.
`seed`	The root seed this catalog was generated from.
`t_explosion`	Every event's explosion time.
`time_bin`	The time-bin index each event was sampled within.
`transient_type`	Every event's transient-type name.
`table`	One row per sampled event.
`nside`	HEALPix resolution used both to query the observed footprint and to sample events.
`order`	HEALPix pixel ordering scheme (`"nested"` or `"ring"`).
`time_bins`	The `n + 1` bin edges events were sampled within.