YieldTable#

class uvex_transients.simulation.yield_table.YieldTable(table: QTable, confidence: float = 0.9)[source]#

A per-transient-type yield summary, tagged by transient type.

Produced by compute_yield_summary(); see that method’s own docstring for the full column list and the estimators each one implements.

Methods

column(name)

Return a table column as a plain array, rather than an astropy.table.Column/Quantity view.

display_expected_detections([precision])

Display each transient type's expected detections, rendered if possible.

expected_detections_latex([precision])

Render each transient type's expected detections, with both uncertainty sources, as LaTeX.

from_disk(path[, table_format])

Read a yield table back from disk, as written by to_disk().

to_ascii(path[, overwrite])

Write this table to a human-readable, fixed-width ASCII file.

to_disk(path[, table_format, overwrite])

Write this table to disk as ECSV, with its provenance in the header.

to_latex([path, precision, caption, label, ...])

Render this table as a LaTeX tabular, with rate/binomial uncertainties as stacked superscripts.

Attributes

confidence

Confidence level the Clopper-Pearson binomial columns were computed at.

transient_type

Each row's transient-type name.

table

One row per transient type; see EventCatalog.compute_yield_summary for the columns.