uvex_transients.transients.base.ExtragalacticTransient.sample_event_count#

ExtragalacticTransient.sample_event_count(solid_angle: Quantity, duration: Quantity = None, t_start: Time = None, t_end: Time = None, seed: SeedSequence | int | None = None) → int[source]#

Sample the number of events in a given solid angle and duration.

Parameters:

  • solid_angle (Quantity) – The solid angle over which to sample events.

  • duration (Quantity, optional) – The duration over which to sample events. Mutually exclusive with t_start/t_end; see _resolve_duration.

  • t_start (Time, optional) – The start/end of the sampling window, used to derive duration if it isn’t supplied directly. See _resolve_duration.

  • t_end (Time, optional) – The start/end of the sampling window, used to derive duration if it isn’t supplied directly. See _resolve_duration.

  • seed (numpy.random.SeedSequence, int, or None, optional) – Root seed for reproducibility; see uvex_transients.utils.split_root_seed.

Returns:

The sampled number of events.

Return type:

int