SurveySchedule#
- class uvex_transients.surveys.base.SurveySchedule(schedule_table: QTable, instrument_fov: SkyRegion | Regions, **kwargs)[source]#
A validated, chronological table of scheduled spacecraft actions.
Wraps an
QTablewhose rows describe individual scheduled actions (observations, slews, downlinks, …) and enforces the schema declared in_SCHEMA(per-column checks) and_ACTION_SCHEMA(per-action required columns and custom checks). SeeScheduleValidationErrorfor how validation failures are reported.- Parameters:
schedule_table (
QTable) – A chronological table of scheduled spacecraft actions. See__init__().instrument_fov (
SkyRegionorRegions) – The instrument’s field of view. See__init__().**kwargs – Forwarded to
_validate_table_columns()/_validate_table_semantics(). See__init__().
Methods
compute_cadence_statistics([start_time, ...])Compute per-pixel statistics of pairwise temporal baselines.
Compute pairwise observation-time separations for each HEALPix pixel.
compute_control_time(timescale[, ...])Compute transient control time as a function of sky position.
compute_control_time_curve(timescales[, ...])Compute survey area-time exposure over a sequence of transient timescales.
compute_max_gap([start_time, end_time, ...])Compute each pixel's worst-case (maximum) successive observation gap.
compute_pair_count_curve(timescales[, ...])Compute sensitive sky area over a sequence of transient timescales.
compute_pair_counts(timescale[, ...])Compute per-pixel counts of visit pairs bracketing a transient timescale.
compute_visit_count([start_time, end_time, ...])Compute the number of visits to each HEALPix pixel.
compute_visit_count_cdf([start_time, ...])Compute the complementary cumulative visit-count distribution.
compute_visit_count_histogram([start_time, ...])Compute the distribution of HEALPix pixels by visit count.
compute_visit_times([start_time, end_time, ...])Compute observation times for each HEALPix pixel.
from_disk(path, fov_path[, table_format])Read a schedule table and its companion instrument FOV back from disk.
get_healpix_coverage_index([nside, order, ...])Lazily build the HEALPix coverage index as a CSR (compressed-sparse-row) structure.
get_observation_indices_of(coord[, nside, ...])Row indices of observations whose footprint covers each query position.
get_observations_of(coord[, start_time, ...])Return the
"observe"rows whose footprint covers a sky position.get_observed_healpix_ids(start_time, end_time)Return the HEALPix pixel indices covered by observations in a time interval.
get_observed_region(start_time, end_time)Return the union of every instrument footprint observed during a time interval.
get_observed_regions(start_time, end_time)Return the instrument footprints observed during a time interval.
get_row_at_time(time)Return the scheduled action active at a given time.
get_rows_between_times(start_time, end_time)Return the scheduled actions overlapping a time window.
time_spent(action)Total duration spent on a given action across the whole survey.
to_disk(path[, fov_path, table_format, ...])Write the schedule table -- and, optionally, the instrument FOV -- to disk.
with_phase(phase)Return a copy of this schedule with every row labeled by
phase.Attributes
Per-action row counts and total durations, one row per action type present.
The action label of every row, as strings.
Angular radius of the smallest cone that fully contains
fov.The total elapsed time spanned by the survey.
The end of the latest scheduled action.
The instrument field of view at RA=0deg/Dec=0deg/PA=0deg.
The total number of scheduled actions.
The
"observe"subset oftable, in schedule order.Boolean mask, one per row of
table, flagging"observe"actions.Total time spent on
observeactions.The start of the earliest scheduled action.
A single-row overview of the whole survey (start/end time, action count, ...).
The underlying, validated schedule table.