streamobs.columns module

Column-name helpers for injected catalogs.

These centralize the naming convention so the injector is not hard-coded to specific bands. Injected catalogs are always survey-namespaced — <name>_<band>_true (true / noiseless), <namespace>_<band>_obs (observed / noisy), <namespace>_<band>_err (reported error), and <namespace>_flag_observed — produced by StreamInjector whether it serves one survey or several. The namespace is the survey’s namespace ({name}_{release}).

Observed, error, and flag columns carry the full namespace, release included (e.g. lsst_yr5_r_obs, roman_dc2_F158_obs), so the same survey at two releases never collides.

True-magnitude columns are the deliberate exception: a true (noiseless) magnitude does not depend on which survey release observed it, so these are keyed on the survey name only and the release is dropped (e.g. roman_F158_true, shared across roman_dc2 and roman_hlwas_*; lsst_r_true, shared across every LSST release). true_col() therefore takes the leading {name} component of whatever namespace it is handed. See docs/source/column_convention.md for the full table.

The survey argument therefore identifies the namespace. survey=None is retained only as a low-level fallback that yields the bare <band>_… / flag_observed names; the injector itself never uses it.

Note

This convention intentionally drops the historical mag_<band> / mag_<band>_obs / magerr_<band> names — it is not backward compatible with catalogs written by older streamobs versions.

streamobs.columns.err_col(band, survey_namespace=None)

Column holding the reported magnitude error for band.

streamobs.columns.flag_col(survey_namespace=None)

Column holding the detection flag (band-independent).

streamobs.columns.obs_col(band, survey_namespace=None)

Column holding the observed (noisy) magnitude for band.

streamobs.columns.perfect_flag_col(survey_namespace=None)

Column holding the perfect star/galaxy-separation flag (band-independent).

streamobs.columns.true_col(band, survey_namespace=None)

Column holding the true (noiseless) apparent magnitude for band.

Unlike obs_col() / err_col() / flag_col(), this drops the release and keys on the survey name only — a true magnitude is release-independent, so lsst_yr1 and lsst_yr5 both yield lsst_<band>_true.