get_lytaf_events

sunpy.instr.lyra.get_lytaf_events(start_time, end_time, lytaf_path=None, combine_files=('lyra', 'manual', 'ppt', 'science'), csvfile=None, force_use_local_lytaf=False)[source] [edit on github]

Extracts combined lytaf file for given time range.

Given a time range defined by start_time and end_time, this function extracts the segments of each LYRA annotation file and combines them.

Parameters:
  • start_time (datetime.datetime or str) – Start time of period for which annotation file is required.
  • end_time (datetime.datetime or str) – End time of period for which annotation file is required.
  • lytaf_path (str) – directory path where the LYRA annotation files are stored.
  • combine_files (tuple of strings) – States which LYRA annotation files are to be combined. Default is all four, i.e. lyra, manual, ppt, science. See Notes section for an explanation of each.
  • force_use_local_lytaf (bool) – Ensures current local version of lytaf files are not replaced by up-to-date online versions even if current local lytaf files do not cover entire input time range etc. Default=False
Returns:

lytaf (numpy.recarray) – Containing the various parameters stored in the LYTAF files.

Notes

There are four LYRA annotation files which mark different types of events or artifacts in the data. They are named annotation_suffix.db where suffix is a variable equalling either lyra, manual, ppt, or science.

annotation_lyra.db : contains entries regarding possible effects to
the data due to normal operation of LYRA instrument.
annotation_manual.db : contains entries regarding possible effects
to the data due to unusual or manually logged events.
annotation_ppt.db : contains entries regarding possible effects to
the data due to pointing or positioning of PROBA2.
annotation_science.db : contains events in the data scientifically
interesting, e.g. GOES flares.

References

Further documentation: http://proba2.oma.be/data/TARDIS

Examples

Get all events in the LYTAF files for January 2014
>>> from sunpy.instr.lyra import get_lytaf_events
>>> lytaf = get_lytaf_events('2014-01-01', '2014-02-01')  # doctest: +REMOTE_DATA