pint.event_toas.get_event_TOAs

pint.event_toas.get_event_TOAs(eventname, mission, weights=None, minmjd=-inf, maxmjd=inf, ephem=None, planets=False, include_bipm=False, include_gps=False, errors=<Quantity 1. us>)[source]

Read photon event times out of a FITS file as a pint.toa.TOAs object

Correctly handles raw event files, or ones processed with axBary to have barycentered TOAs. Different conditions may apply to different missions.

The minmjd/maxmjd parameters can be used to avoid instantiation of TOAs we don’t want, which can otherwise be very slow.

Parameters:
  • eventname (str) – File name of the FITS event list

  • mission (str) – Name of the mission (e.g. RXTE, XMM)

  • weights (array or None) – The array has to be of the same size as the event list. Overwrites possible weight lists from mission-specific FITS files

  • minmjd (float, default "-infinity") – minimum MJD timestamp to return

  • maxmjd (float, default "infinity") – maximum MJD timestamp to return

  • ephem (str, optional) – The name of the solar system ephemeris to use; defaults to “DE421”.

  • planets (bool, optional) – Whether to apply Shapiro delays based on planet positions. Note that a long-standing TEMPO2 bug in this feature went unnoticed for years. Defaults to False.

  • include_bipm (bool, optional) – Use TT(BIPM) instead of TT(TAI)

  • include_gps (bool, optional) – Apply GPS to UTC clock corrections

  • errors (astropy.units.Quantity or float, optional) – The uncertainty on the TOA; if it’s a float it is assumed to be in microseconds

Return type:

pint.toa.TOAs