XMM-Newton Science Analysis System


emchain (emchain-12.0.1) [xmmsas_20230412_1735-21.0.0]

Examples

emchain takes some time to run. It is usually better run as a batch job (at command). Here are a few examples of how to use it. They assume that the SAS_CCF environment variable was set to the relevant Calibration Index File.

• Standard run (get calibrated event files from an ODF located in your_odf_dir), sending the output to a log file:

        emchain odf=your_odf_dir > emchain.log 2> emchain.err (sh shell)
        emchain odf=your_odf_dir > emchain.log >& emchain.err (csh shell)
  

• Same, but getting the bad pixels from the CCF instead of the data and applying attitude and HK GTIs:

        emchain odf=your_odf_dir badpixfindalgo=NO filteratt=Y filterhk=Y
  

• Select particular exposure, instrument and CCDs, keep intermediate files and stop at first error:

        emchain instruments=M2 exposures=S002 ccds='1 3 4' stoponerror=Y  \
                keepintermediate=Y
  

• Keep events flagged for rejection and all original columns in the ODF, apply user GTI and no TIME randomization:

        emchain rejectbadevents=N fulloutput=Y randomize='PE' ingtiset=hkgti.ds
  

• Rebuild the flare GTI files with different settings, keep them exposure specific and add the WEIGHT column:

        emchain runccdloop=N runevlistcomb=N addvigweight=Y  \
                globalflare=N flaretimebin=104 flaremaxrate=1.2
  

• Run attcalc with fixed attitude:

        emchain attcalc:attitudelabel=fixed attcalc:fixedra=204.6877  \
                attcalc:fixeddec=-27.6984 attcalc:fixedposangle=59.378
  

• Specify source position manually (instead of using RA_OBJ and DEC_OBJ) for Timing mode:

        emchain emframes:withsrccoords=Y  \
                emframes:srcra=204.6877 emframes:srcdec=-27.6984
  

• Run bad pixels finder on existing intermediate files:

        rm *BPXFLI* *IMAGPR*
        emchain startfromodf=N clobber=N stopafterbadpixfind=Y
  

• Regenerate event files, using new bad pixels files and intermediate files (this will remove the intermediate files on successful output):

        rm T*M*EVLI*.FIT
        emchain startfromodf=N
  

• Relaunch emchain after an error which occurred on MOS 2, exposure 4, using already existing intermediate files:

        rm PooooooooooM2S004*.FIT 
        emchain instruments=M2 exposures=4 clobber=N
  

• Revert to simple pre-v12 names of intermediate files (see Sect. 8) overwritten at each exposure (avoids creating too many files, but risks interference if several instances of emchain are called at the same time in the same directory):

        emchain usecanonicalnames=N