process.erosita

process.erosita.assemble

daxa.process.erosita.assemble.cleaned_evt_lists(obs_archive, lo_en=<Quantity 0.2 keV>, hi_en=<Quantity 10. keV>, flag=3221225472, flag_invert=True, pattern=15, num_cores=1, disable_progress=False, timeout=None)[source]

The function wraps the eROSITA eSASS task evtool, which is used for selecting events. This has been tested up to evtool v2.10.1

This function is used to apply the soft-proton filtering (along with any other filtering you may desire, including the setting of energy limits) to eROSITA event lists, resulting in the creation of sets of cleaned event lists which are ready to be analysed.

Parameters:

  • obs_archive (Archive) – An Archive instance containing eROSITA mission instances with observations for which cleaned event lists should be created. This function will fail if no eROSITA missions are present in the archive.

  • lo_en (Quantity) – The lower bound of an energy filter to be applied to the cleaned, filtered, event lists. If ‘lo_en’ is set to an Astropy Quantity, then ‘hi_en’ must be as well. Default is 0.2 keV, which is the minimum allowed by the eROSITA toolset. Passing None will result in the default value being used.

  • hi_en (Quantity) – The upper bound of an energy filter to be applied to the cleaned, filtered, event lists. If ‘hi_en’ is set to an Astropy Quantity, then ‘lo_en’ must be as well. Default is 10 keV, which is the maximum allowed by the eROSITA toolset. Passing None will result in the default value being used.

  • flag (int) – FLAG parameter to select events based on owner, information, rejection, quality, and corrupted data. The eROSITA website contains the full description of event flags in section 1.1.2 of the following link: https://erosita.mpe.mpg.de/edr/DataAnalysis/prod_descript/EventFiles_edr.html. The default parameter will select all events flagged as either singly corrupt or as part of a corrupt frame.

  • flag_invert (bool) – If set to True, this function will discard all events selected by the flag parameter. This is the default behaviour.

  • pattern (int) – Selects events of a certain pattern chosen by the integer key. The default of 15 selects all four of the recognized legal patterns.

  • num_cores (int) – The number of cores to use, default is set to 90% of available.

  • disable_progress (bool) – Setting this to true will turn off the eSASS generation progress bar.

  • timeout (Quantity) – The amount of time each individual process is allowed to run for, the default is None. Please note that this is not a timeout for the entire cleaned_evt_lists process, but a timeout for individual ObsID-Inst-subexposure processes.

process.erosita.clean

daxa.process.erosita.clean.flaregti(obs_archive, pimin=<Quantity 200. eV>, pimax=<Quantity 10000. eV>, mask_pimin=<Quantity 200. eV>, mask_pimax=<Quantity 10000. eV>, binsize=1200, detml=10, timebin=<Quantity 20. s>, source_size=<Quantity 25. arcsec>, source_like=10, threshold=<Quantity -1. ct / (s deg2)>, max_threshold=<Quantity -1. ct / (s deg2)>, mask_iter=3, num_cores=1, disable_progress=False, timeout=None)[source]

The DAXA wrapper for the eROSITA eSASS task flaregti, which attempts to identify good time intervals with minimal flaring. This has been tested up to flaregti v1.20.

This function does not generate final event lists, but instead is used to create good-time-interval files which are then applied to the creation of final event lists, along with other user-specified filters, in the ‘cleaned_evt_lists’ function.

Parameters:

  • obs_archive (Archive) – An Archive instance containing eROSITA mission instances with observations for which flaregti should be run. This function will fail if no eROSITA missions are present in the archive.

  • pimin (float) – Lower PI bound of energy range for lightcurve creation.

  • pimax (float) – Upper PI bound of energy range for lightcurve creation.

  • mask_pimin (float) – Lower PI bound of energy range for finding sources to mask.

  • mask_pimax (float) – Upper PI bound of energy range for finding sources to mask.

  • binsize (int) – Bin size of mask image (unit: sky pixels).

  • detml (int) – Likelihood threshold for mask creation.

  • timebin (int) – Bin size for lightcurve (unit: seconds).

  • source_size (int) – Diameter of source extraction area for dynamic threshold calculation (unit: arcsec); this is the most important parameter if optimizing for extended sources.

  • source_like (int) – Source likelihood for automatic threshold calculation.

  • threshold (float) – Flare threshold; dynamic if negative (unit: counts/deg^2/sec).

  • max_threshold (float) – Maximum threshold rate, if positive (unit: counts/deg^2/sec), if set this forces the threshold to be this rate or less.

  • mask_iter (int) – Number of repetitions of source masking and GTI creation.

  • num_cores (int) – The number of cores to use, default is set to 90% of available.

  • disable_progress (bool) – Setting this to true will turn off the SAS generation progress bar.

  • timeout (Quantity) – The amount of time each individual process is allowed to run for, the default is None. Please note that this is not a timeout for the entire flaregti process, but a timeout for individual ObsID-Inst-subexposure processes.

Returns:

Information required by the eSASS decorator that will run commands. Top level keys of any dictionaries are internal DAXA mission names, next level keys are ObsIDs. The return is a tuple containing a) a dictionary of bash commands, b) a dictionary of final output paths to check, c) a dictionary of extra info (in this case obs and analysis dates), d) a generation message for the progress bar, e) the number of cores allowed, and f) whether the progress bar should be hidden or not.

Return type:

Tuple[dict, dict, dict, str, int, bool, Quantity]

process.erosita.setup