skip to content
Suzaku Guest Observer Facility

User Reprocessing of HXD Data

Users who wish to analyze GSO data must reprocess their own unscreened event files. Users who have PIN data taken after 2007 July 28 and processed with pipeline v2.0.6.13 also need to reprocess their own unscreened event files.


We assume that the users have downloaded V2.x processed data files and are familiar with the directory structure and the file naming convention. We also assume that they have installed the latest Suzaku FTOOLS and can access the latest Suzaku calibration data base.

In particular, the GSO gain history table file, ae_hxd_gsoght_XXXXXXXX.fits, is updated by the HXD team at the end of every month (please note that the old gain history files, ae_hxd_gsoghf_XXXXXXXX.fits, are not used on version 2.0 products, and are not maintained now). The gain history of each observation is released with a delay of 1--2 months, and therefore please check whether your observation date is included in the history file. The date in the file name is not related with the data content, and it is just the date when the history file is created.

How to Reprocess the HXD Data

In general, it is not necessary to run hxdtime on pipeline processed data. This is because the only calibration item necessary for this process is the clock correction (or TIM) file, which, once generated, is not updated.

In the following example, we start from the original unscreened event file ae101005040hxd_0_wel_uf.evt and produce a re-calibrated unscreened file, ae101005040hxd_0_wel_uf2.evt. It is strongly recommended to uncompress the event file(s) before reprocessing; attempts to reprocess directry from gzipped files often fail.

unix% mkdir event_cl2/; cd event_cl2/
unix% cat > hk_file.list << EOF

unix% hxdpi input_name=../event_uf/ae101005040hxd_0_wel_uf.evt \
    hklist_name=@hk_file.list \
    hxd_gsoght_fname=CALDB hxd_gsolin_fname=CALDB \
    hxd_pinghf_fname=CALDB hxd_pinlin_fname=CALDB \
    create_name=ae101005040hxd_0_wel_uf2.evt read_iomode=create \
    time_change=n grade_change=n pi_pmt_change=y pi_pin_change=y \
    gtimode=n gti_time=S_TIME rand_seed=7 rand_skip=0 use_pwh_mode=n \
    num_event=-1 event_freq=10000 anl_verbose=-1 anl_profile=yes
(If the gsoght does not include the observation date of event fits, the process of hxdpi does not work. Please check CALDB area.)
unix% hxdgrade input_name=ae101005040hxd_0_wel_uf2.evt \
    hxdgrade_psdsel_fname=CALDB \
    hxdgrade_pinthres_fname=CALDB \
    leapfile=CALDB \
    hxdgrade_psdsel_criteria=2 read_iomode=overwrite \
    time_change=n grade_change=y pi_pmt_change=n pi_pin_change=n \
    gtimode=n gti_time=S_TIME use_pwh_mode=n num_event=-1 \
    event_freq=10000 anl_verbose=-1 anl_profile=yes

How to Screen the Reprocessed Data

First, obtain the file containing screening criteria for the GSO (gso_mkf.sel) and/or the PIN (pin_mkf.sel). These contain the standard criteria used in Version 2 processing; experienced users can edit these files to modify some of the criteria. Also, uncompress the mkf file foundin the ../../auxil directory (note that, by default, XSELECT expects the mkf files in ../../auxil relative to the data file directory). Then:

unix% xselect
xsel > set datadir .
xsel > read event ae101005040hxd_0_wel_uf2.evt
xsel > select mkf @gso_mkf.sel
xsel > filter column
> Enter filter on column(s) in the event file >[] DET_TYPE=0:0

xsel > filter time file ../hk/ae101005040hxd_0_tel_uf.gti.gz

xsel > show filter

xsel > extract event
xsel > save event
xsel > ae101005040hxd_0_gsono_cl2.evt
xsel > yes
xsel > exit

The above example is for screening of GSO events; for PIN events, change the file name in the select mkf command and change the criterion for filter column to "DET_TYPE=1:1". Now that the file consists of only GSO cleaned event, the DETNAM keyword should be updated.

unix% fparkey fitsfile="ae101005040hxd_0_pinno_cl2.evt+0" \
      value="WELL_GSO" keyword="DETNAM" comm="detector name" add=no 
unix% fparkey fitsfile="ae101005040hxd_0_pinno_cl2.evt+1" \
      value="WELL_GSO" keyword="DETNAM" comm="detector name" add=no 
Again, this example is for GSO data; use value="WELL_PIN" instead for PIN data.

If the TIMEDEL in the unfiltered file is -999, manually update the keyword as follows.

unix% fparkey fitsfile="ae101005040hxd_0_pinno_cl2.evt+0" \
      value="6.1E-05" keyword="TIMEDEL" \
      comm="finest time resolution (time between frames)" add=no
unix% fparkey fitsfile="ae101005040hxd_0_pinno_cl2.evt+1" \
      value="6.1E-05" keyword="TIMEDEL" \
      comm="finest time resolution (time between frames)" add=no

If you have any questions concerning Suzaku, visit the Feedback form.

This file was last modified on Friday, 10-Oct-2008 19:25:58 EDT

NASA Astrophysics

  • FAQ/Comments/Feedback
  • Education Resources
  • Download Adobe Acrobat
  • A service of the Astrophysics Science Division (ASD) at NASA/ GSFC

    Suzaku Project Scientist: Dr. Robert Petre
    Responsible NASA Official: Phil Newman

    Privacy Policy and Important Notices.