SurveySimulator#

class uvex_transients.simulation.core.SurveySimulator(survey_schedule: SurveySchedule, transients: dict[str, ExtragalacticTransient] | None = None, simulation_seed: int | None = None)[source]#

Samples transient populations against a survey schedule.

Parameters:

  • survey_schedule (SurveySchedule) – The schedule to sample events against. See __init__().

  • transients (dict of str to ExtragalacticTransient, optional) – The transient types to register. See __init__().

  • simulation_seed (int, optional) – Root seed for Monte Carlo sampling. See __init__().

Methods

available_cuts()

Tuple of str: Every cut name registered on this class via @cut, sorted.

compute_effective_exposure(time_bins[, ...])

Tabulate each registered transient type's effective exposure per time bin.

filter_by_limiting_magnitude(catalog, ...[, ...])

Cheaply cut an EventCatalog down to events that could ever plausibly be seen.

filter_by_snr(catalog, mission, snr_threshold)

Cut an EventCatalog down to events the schedule actually detects.

generate_events(time_bins[, nside, order, ...])

Sample a Monte Carlo realization of every registered transient type over a time grid.

run_cut(name, catalog, mission, **params)

Run one @cut-registered screening method by name.

Attributes

simulation_seed

Root seed for Monte Carlo sampling.

survey_schedule

The schedule events are sampled against.

transient_collection

The registered transient types, keyed by name.