XMM-Newton Science Analysis System


eimsimprep (eimsim-2.4) [xmmsas_20190531_1155-18.0.0]

Detection-specific preparations

This function may be performed alone by calling the script with entrystage and finalstage=`detprep'.

Task eimsim is designed to allow the user to supply their own source-detection script. (See the eimsim documentation for a description of the requirements of such a script.) As with other parts of the eimsim functionality, there may be source-detection functions or jobs which only need to be done once and others (eg to do with the actual detection) which need to be done anew during each simulation run. The `once-only' jobs can be separated and placed into another script which is called at the present stage of eimsimprep. At present, the eimsim package contains two example det prep scripts: eimsimdetprep1xmm and eimsimdetprep2xmm, corresponding to the respective detection scripts and template sets.

A user-written det prep script must fulfil the following requirements:

• The name of the detection-preparation script should be supplied via parameter detpreptask.

• The detection-preparation script should accept command-line parameters
  • obsidroots
  • prdssubdir
  • simopsubdir
  • astest
  • refband
  • srcspecset
  The values passed to these parameters by eimsimprep are the same values supplied to eimsimprep itself via the parameters of the same names - eimsimprep just feeds them through.

• As described in the eimsim task documentation, the user should supply eimsimprep (and eimsimbatch) with a list of directory names via the parameter obsidroots. The eimsim tasks expect to find SSC product files in subdirectories whose name is supplied in parameter prdssubdir off each of these obsidroots, and write their output files to subdirectories whose name is supplied in parameter simopsubdir off the obsidroots. The detection-preparation script should do the same.

It is helpful to construct the script so that it has an optional entry point named `cleanup'. The function of this portion of the det prep script should be just to delete all intermediate files. In other words, the det prep script should be so designed, that it deletes all its intermediate files if invoked as follows:

  <det prep task> entrystage=cleanup