get_lytaf_events#

sunkit_instruments.lyra.get_lytaf_events(start_time, end_time, combine_files=('lyra', 'manual', 'ppt', 'science'), csvfile=None, force_use_local_lytaf=False)[source]#

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 (astropy.time.Time or str) – Start time of period for which annotation file is required.
end_time (astropy.time.Time or str) – End time of period for which annotation file is required.
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 – Containing the various parameters stored in the LYTAF files.

Return type:

numpy.recarray

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.dbcontains entries regarding possible effects to: the data due to normal operation of LYRA instrument.
annotation_manual.dbcontains entries regarding possible effects: to the data due to unusual or manually logged events.
annotation_ppt.dbcontains entries regarding possible effects to: the data due to pointing or positioning of PROBA2.
annotation_science.dbcontains 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 sunkit_instruments.lyra import get_lytaf_events
>>> lytaf = get_lytaf_events('2014-01-01', '2014-02-01')  