process

process.simple

daxa.process.simple.full_process_xmm(obs_archive, lo_en=None, hi_en=None, process_unscheduled=True, find_mos_anom_state=False, num_cores=1, timeout=None)[source]

This is a convenience function that will fully process and prepare XMM data in an archive using the default configuration settings of all the cleaning steps. If you wish to exercise finer grained control over the processing of your data then you can copy the steps of this function and alter the various parameter values.

Parameters

  • obs_archive (Archive) – An archive object that contains at least one XMM mission to be processed.

  • lo_en (Quantity) – If an energy filter should be applied to the final cleaned event lists, this is the lower energy bound. The default is None, in which case NO ENERGY FILTER is applied.

  • hi_en (Quantity) – If an energy filter should be applied to the final cleaned event lists, this is the upper energy bound. The default is None, in which case NO ENERGY FILTER is applied.

  • process_unscheduled (bool) – Should unscheduled sub-exposures be processed and included in the final event lists. The default is True.

  • find_mos_anom_state (bool) – Whether the emanom task should be run to search for anomolous states of the MOS cameras. This is set to False by default, and you should be aware that I have not found it to be particularly reliable with the default settings, it tends to remove good chips.

  • num_cores (int) – The number of cores that can be used by the processing functions. The default is set to the DAXA NUM_CORES parameter, which is configured to be 90% of the system’s cores.

  • 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 processing stack, but a timeout for the individual processes of each stage, whether they are at the ObsID, ObsID-Inst, or ObsID-Inst-Subexposure level of granularity.

daxa.process.simple.full_process_erosita(obs_archive, lo_en=None, hi_en=None, num_cores=1, timeout=None)[source]

This is a convenience function that will fully process and prepare eROSITA data in an archive using the default configuration settings of all the cleaning steps. If you wish to exercise finer grained control over the processing of your data then you can copy the steps of this function and alter the various parameter values.

Parameters

  • obs_archive (Archive) – An archive object that contains at least one eROSITA mission to be processed.

  • lo_en (Quantity) – If an energy filter should be applied to the final cleaned event lists, this is the lower energy bound. The default is None, in which case NO ENERGY FILTER is applied.

  • hi_en (Quantity) – If an energy filter should be applied to the final cleaned event lists, this is the upper energy bound. The default is None, in which case NO ENERGY FILTER is applied.

  • num_cores (int) – The number of cores that can be used by the processing functions. The default is set to the DAXA NUM_CORES parameter, which is configured to be 90% of the system’s cores.

  • 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 processing stack, but a timeout for the individual processes of each stage.