**************************************************** Seven Steps to the Suzaku HXD analysis **************************************************** Corresponding processing version: version 2.2.x.x Corresponding HEADAS version: version 6.5.1 Modified history August, 2006 by terada,kokubun (v0.7) Dec, 2006 by fukazawa,htakahashi,terada,kokubun (v1.2) Mar, 2007 by fukazawa Oct, 2007 by terada (v2.0) May, 2008 by terada,htakahashi (v2.x) / rev.4 Oct, 2008 by terada (v2.x)/ epoch 5 Please check the official document for the Suzaku analysis, "the ABC guide of Suzaku" (http://heasarc.gsfc.nasa.gov/docs/suzaku/analysis/abc/), or "the first step manual" (Only in Japanese as of 2008 Jan.) (http://cosmic.riken.jp/suzaku/help/guide/index_e.html). Before starting the Suzaku analysis, you need to install the latest version of the HEADAS package from the following URL. http://heasarc.gsfc.nasa.gov/docs/software/lheasoft/ This document is valid for the version 2.x products. Although the HXD team strongly recommends to analyse the v2.x data with the latest tools and CALDB, if you dare want to use v1.x products, please check the following URL. http://suzaku.gsfc.nasa.gov/docs/suzaku/analysis/v2soft.html 1. Obtain the data and information ----------------------------------- 1-a) Please check important information in the following WWW page. You can check observation log via following www page: http://darts.isas.jaxa.jp/astro/tables/SUZAKU_LOG.html Please check important events in the operation during your observation. http://www.astro.isas.jaxa.jp/suzaku/log/operation/ http://www.astro.isas.jaxa.jp/suzaku/log/hxd/ http://www.astro.isas.jaxa.jp/suzaku/log/xis/ Please check the limitation of the pipe-line products. http://www.astro.isas.jaxa.jp/suzaku/process/ It is better to check announcements from the detector's team. http://www.astro.isas.jaxa.jp/suzaku/analysis/hxd/ http://www.astro.isas.jaxa.jp/suzaku/analysis/xis/ 1-b) Obtain the desired data set of your observation from the DARTS at ISAS/JAXA, Japan (http://darts.isas.jaxa.jp) or the HEASARC FTP site (ftp:legacy.gsfc.nasa.gov). When your OBS_ID is 101005040, for example, you can download whole directory tree with the wget command as follows: unix% wget -rL -nH --cut-dirs=4 \ ftp://darts.isas.jaxa.jp/pub/suzaku/ver2.1/101005040 Then, you will get the following directory tree: (the "xis" subdirectory is omitted in this document) auxil/ ae101005040.att.gz ae101005040.cat.gz ae101005040.ehk.gz ae101005040.hk.gz ae101005040.mkf.gz ae101005040.orb.gz ae101005040.tim.gz hxd/hk/ ae101005040hxd_0.hk.gz (HXD House Keeping data) ae101005040hxd_0_pin.ghf.gz (PIN gain) ae101005040hxd_0_gso.ghf.gz (Tentative gain for GSO. Please don't use! ) ae101005040hxd_0_wam.ghf.gz (WAM Gain) ae101005040hxd_0_tel_uf.gti.gz (GTI of telemetry saturation for WEL) ae101005040hxd_0_wel_uf.gti.gz (GTI of target observation for WEL) hxd/event_uf/ ae101005040hxd_0_wel_uf.evt.gz (Un-filtered WEL events, including PIN,GSO,PSE, and noise) ae101005040hxd_0_wam_uf.evt.gz (WAM) ae101005040hxd_0_bst01_uf.evt.gz (WAM) ae101005040hxd_0_bstidt.fits.gz (WAM) hxd/event_cl/ ae101005040hxd_0_gsono_cl.evt.gz (GSO cleaned events. Please don't use!) ae101005040hxd_0_pinno_cl.evt.gz (PIN cleaned events) ae101005040hxd_0_pse_cl.evt.gz (PSEUDO events for dead time correction) hxd/products/ ae101005040hxd_0_gso.lc ae101005040hxd_0_gso.pi (light curves and spectra) ae101005040hxd_0_pin.lc ae101005040hxd_0_pin.pi ae101005040hxd_0_wel_lc.gif ae101005040hxd_0_wel_pi.gif 1-c) Please get CALDB files related to the HXD analysis from http://www.astro.isas.jaxa.jp/suzaku/caldb/ or http://heasarc.gsfc.nasa.gov/docs/heasarc/caldb/suzaku/ Please check the following CALDB files. ae_hxd_gsoart_20051126.fits (GSO arf table for hxdarfgen) ae_hxd_gsoght_2007xxxx.fits (GSO gain history table for hxdpi) ae_hxd_gsolin_20051209.fits (GSO non linearity table for hxdpi) ae_hxd_gsopsd_20071010.fits (GSO selection criteria for hxdgrade) ae_hxd_pinart_20070611.fits (PIN arf table for hxdarfgen) ae_hxd_pinghf_20051125.fits (PIN gain file for PIN) ae_hxd_pinlin_20060724.fits (PIN non linearity table for hxdpi) ae_hxd_pinthr_200xxxxx.fits (PIN lower threshold for hxdpi, see below) ae_hxd_teldef_20060810.fits (HXD teldef file for hxdarfgen) ae_hxd_wampht_20061027.fits (WAM) ae_hxd_bstidt_20070512.fits (WAM) The gain history file, ae_hxd_gsoght_XXXXXXXX.fits, is frequently updated by the HXD team every end of month, so please obtain the latest file that observation date of your favorite object is included for the step 2. (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. To analyse PIN data, we defined the following epochs as the high voltage (HV) of PIN diodes and their noise level. Please prepare ae_hxd_pinthr file(s) as an epoch of your observation. Note that you need not be care about these ae_hxd_pinthr files, if you set up the CALDB environment since the HXD ftools in HEADAS 6.3 automatically access the appropriate CALDB files. epoch 1) 2005.8.17 -- 2006.5.13 PIN HV = 500V/500V/500V/500V PIN thr = ae_hxd_pinthr_20060727.fits epoch 2) 2006.5.13 -- 2006.10.2 PIN HV = 400V/500V/500V/500V PIN thr = ae_hxd_pinthr_20060727.fits epoch 3) 2006.10.2 -- 2007.7.28 PIN HV = 400V/400V/500V/500V PIN thr = ae_hxd_pinthr_20070522.fits epoch 4) 2007.7.28 -- 2008.8.31 PIN HV = 400V/400V/500V/500V PIN thr = ae_hxd_pinthr_20070822.fits epoch 5) 2008.9.1 -- ** PIN HV = 400V/400V/500V/500V PIN thr = ae_hxd_pinthr_20080717.fits 1-d) Get response files from http://www.astro.isas.jaxa.jp/suzaku/caldb/hxd/ Version 2.0 products support the PIN datasets of HV=400V. Please use the PIN response files corresponds to your observation epoch. epoch 1) ae_hxd_pinXXnome1_20070914.rsp (XX=xi,hx) epoch 2) ae_hxd_pinXXnome2_20070914.rsp (XX=xi,hx) epoch 3) ae_hxd_pinXXnome3_20070914.rsp (XX=xi,hx) epoch 4) ae_hxd_pinXXnome4_20070914.rsp (XX=xi,hx), epoch 5) ae_hxd_pinXXnome5_20080716.rsp (XX=xi,hx), where XX=xi means xis-nominal position, and XX=hx hxd-nominal position. 1-e) Get Non X-ray background (NXB) files and documents via http://www.astro.isas.jaxa.jp/suzaku/analysis/hxd/, and see also the "Suzaku memo" documents in http://www.astro.isas.jaxa.jp/suzaku/doc/. The NXB files are also available from the following download area. ftp://legacy.gsfc.nasa.gov/suzaku/data/background/ In version 2.x, all PIN datasets including PIN-HV=400V and 500V are supported for scientific analyses. After January 2008, GSO NXB files are also provided. 2. Reprocessing with the latest CALDBs --------------------------------------- 2-a) All the GSO products must be reprocessed. If you want to analyze GSO data, please reprocess the GSO datasets from the unscreened event files with the latest CALDB (ae_hxd_gsoght_XXXX.fits), which covers your observation date, because the gain values of GSO events in the pipe-line processing are tentative values. Please see Appendix A "How to reprocess" for the GSO data. 2-b) Several PIN products must be reprocessed. In the early phase of version 2.0, some PIN products are not processed with the latest ae_hxd_pinthr file. Therefore, please check the process version and the epoch by unix% fkeyprint infile=ae101005040hxd_0_pinno_cl.evt+1 keynam=TSTART unix% fkeyprint infile=ae101005040hxd_0_pinno_cl.evt+1 keynam=PROCVER and if the values are TSTART > 238896001.0 (July 28, 2007) and PROCVER is 2.0.x.x (x is any), please reprocess your PIN cleaned event file(s). The way to reprocess PIN data is described in http://www.astro.isas.jaxa.jp/suzaku/analysis/hxd/, or Appendix A "How to reprocess" for the PIN data. ================================================= | ver 2.0.x.x | ver 2.1.x.x | ver 2.2.x.x ----+-------------+--------------+--------------- PIN | Reprocess | no need | no need GSO | Reprocess | Reprocess | Reprocess ------------------------------------------------- 3. Create GTI file: -------------------- In the following description, the clean event file is named as ae101005040hxd_0_pinno_cl2.evt.gz If you skip the step 2, replace it by ae101005040hxd_0_pinno_cl.evt.gz Since the background event files have own good time intervals (GTI), you should first create the "AND"ed GTI file from both of the source and background event files. This procedure can be done with the "mgtime" ftools (see fhelp): unix% mgtime ingtis="ae101005040hxd_0_pinno_cl2.evt.gz+2,ae101005040hxd_0_pinnxb.evt.gz+2" outgti="ae101005040hxd_wel_pin.gti" merge="AND" This creates a gti file named ae101005040hxd_wel_pin.gti. The same procedure is done for the GSO data. 4. Apply GTI and extract the spectrum: --------------------------------------- 4-a) PIN spectrum By use of the ANDed GTI in step 3, you can extract the spectra from the source and background event files with xselect: unix% xselect xsel > read event xsel > ./ xsel > ae101005040hxd_0_pinno_cl2.evt.gz xsel > filter time file ae101005040hxd_wel_pin.gti xsel > extract spec xsel > save spec ae101005040hxd_0_pinno_cl2.pha xsel > clear all xsel > yes xsel > read event xsel > ./ xsel > ae101005040hxd_0_pinnxb.evt.gz xsel > filter time file ae101005040hxd_wel_pin.gti xsel > extract spec xsel > save spec ae101005040hxd_wel_pin_bgd.pha xsel > exit This creates the source spectrum (ae101005040hxd_0_pinno_cl2.pha) and background spectrum (ae101005040hxd_wel_pin_bgd.pha). 4-b) GSO spectrum The procedure for the GSO data is the same, and furthermore the GSO spectrum should be binned as follows for the background subtraction, because the GSO BGD is created in 32 bins. The setting of the grouping of GSO is available from http://www.astro.isas.jaxa.jp/suzaku/analysis/hxd/gsonxb/, and get the file, gso_grp.dat. unix% grppha ae101005040hxd_gsono_cl2.pha ae101005040hxd_gsono_cl2bin.pha GRPPHA[] group "gso_grp.dat" GRPPHA[] shou group GRPPHA[] exit 5. Dead time correction: ------------------------- Before investigating the obtained spectra, you need to correct the dead time, using the tool 'hxddtcor'. Note that the dead time effect in the "PIN" background spectra are already taken into account, please do not apply this procedure to background spectra. This is not for the "GSO" background, and so the GSO background DOES need to be dead-time corrected. unix% hxddtcor event_fname="ae101005040hxd_0_wel_uf2.evt" \ pi_fname="ae101005040hxd_0_pinno_cl2.pha" \ save_pseudo=no chatter=2 If the parameter 'chatter' is set to non-zero value, you can check the exposures before and after the correction. (The ratio comes in typically about 95% for faint sources.) You can use "ae101005040hxd_0_pse_cl.evt.gz" instead of the un filtered file, "ae101005040hxd_0_wel_uf2.evt" as a value of event_fname. If you have two or more wel_uf files, please list these files in, for example, "ae101005040hxd_wel_uf2.list", and then type the following. unix% hxddtcor event_fname="@ae101005040hxd_wel_uf2.list" \ pi_fname="ae101005040hxd_0_pinno_cl2.pha" \ save_pseudo=no chatter=2 6. Correct the exposure of PIN background: ---------------------------------------- Since the background level of HXD-PIN is extremely low, the background event files are simulated with a ten times scaled level than the actual background to avoid introducing a large statistical error. Therefore, you have to re-scale the background level by modifying the EXPOSURE keyword: unix% cp ae101005040hxd_wel_pin_bgd.pha \ ae101005040hxd_wel_pin_bgd_expcor.pha unix% fkeyprint infile=ae101005040hxd_wel_pin_bgd_expcor.pha keynam=EXPOSURE ----- output --- # FILE: ae101005040hxd_wel_pin_bgd_expcor.pha # KEYNAME: EXPOSURE # EXTENSION: 0 EXPOSURE= 1.755875832736492E+03 / Exposure time # EXTENSION: 1 EXPOSURE= 1.755875832736492E+03 / Exposure time # EXTENSION: 2 EXPOSURE= 1.755875832736492E+03 / Exposure time ----------------- unix% fparkey value=1.755875832736492E+04 \ fitsfile="ae101005040hxd_wel_pin_bgd_expcor.pha+0" keyword=EXPOSURE unix% fparkey value=1.755875832736492E+04 \ fitsfile="ae101005040hxd_wel_pin_bgd_expcor.pha+1" keyword=EXPOSURE unix% fparkey value=1.755875832736492E+04 \ fitsfile="ae101005040hxd_wel_pin_bgd_expcor.pha+2" keyword=EXPOSURE unix% fkeyprint infile=ae101005040hxd_wel_pin_bgd_expcor.pha keynam=EXPOSURE ----- output --- # FILE: ae101005040hxd_wel_pin_bgd_expcor.pha # KEYNAME: EXPOSURE # EXTENSION: 0 EXPOSURE= 1.755875832736492E+04 / Exposure time # EXTENSION: 1 EXPOSURE= 1.755875832736492E+04 / Exposure time # EXTENSION: 2 EXPOSURE= 1.755875832736492E+04 / Exposure time ----------------- 7. Enjoy spectrum with XSPEC: --------------------------------- Please enjoy. Note that the PIN NXB does not contain the CXB. Therefore, you must consider the CXB in the spectral fitting. See the background page for detail For the GSO, the CXB can be ignored.. If you have a question, please do not hesitate to use the Suzaku Help desk, http://cosmic.riken.jp/suzaku/help (Japan, Europa, Asia) or http://heasarc.gsfc.nasa.gov/cgi-bin/Feedback (US) ============================================================================ Appendix ============================================================================ Appendix A. How to reprocess your data ------------------------------------------- A-a) Please check your CALDB environment. In addition to the Suzaku specific files (see step 1-c), we need the multiple-mission environment of CALDB (for example, files named caldb.config, alias_config.fits, and start up script, caldbinit.csh, etc. Note that we also need to edit caldbinit.csh.). Please follow the installation page. http://heasarc.gsfc.nasa.gov/docs/heasarc/caldb/caldb_install.html A-b) Reprocess your unscreened event file, ae101005040hxd_0_wel_uf.evt, for example, with the latest CALDB files. You will obtain a re-calibrated unscreened file, ae101005040hxd_0_wel_uf2.evt, after following operations. unix% mkdir event_cl2/; cd event_cl2/ unix% ln -s ../event_uf/ae101005040hxd_0_wel_uf.evt.gz unix% ln -s ../hk/ae101005040hxd_0.hk.gz . unix% ln -s ../../auxil/ae101005040.ehk.gz . unix% ln -s ../../auxil/ae101005040.tim.gz . unix% hxdtime input_name=ae101005040hxd_0_wel_uf.evt.gz \ create_name=ae101005040hxd_0_wel_uf2.evt \ tim_filename=ae101005040.tim.gz \ hklist_name=ae101005040hxd_0.hk.gz \ leapfile=CALDB \ read_iomode=create time_change=y grade_change=n pi_pmt_change=n \ pi_pin_change=n gtimode=y gti_time=S_TIME time_convert_mode=4 \ use_pwh_mode=n num_event=-1 event_freq=10000 anl_verbose=-1 anl_profile=yes (We can skip this stage, hxdtime, for v1.2/1.3 products) unix% cat > hk_file.list << EOF ae101005040hxd_0.hk.gz ae101005040.ehk.gz EOF unix% hxdpi input_name=ae101005040hxd_0_wel_uf2.evt \ hklist_name="@hk_file.list" \ hxd_gsoght_fname=CALDB hxd_gsolin_fname=CALDB \ hxd_pinghf_fname=CALDB hxd_pinlin_fname=CALDB \ create_name=hxdpi.out read_iomode=overwrite \ 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.1 \ read_iomode=overwrite create_name=hxdgrade.out \ 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 A-c) Screen the obtained re-calibrated unscreened-event file with xselect, with a criteria of DET_TYPE=1:1 for PIN and DET_TYPE=0:0 for GSO, and apply cleaned GTIs (i.e., 2nd extension of original cleaned event fits.) --> The default criteria is described in Appendix B, and if you want to change the limitation, please read an article in Appendix B. unix% cp ../../auxil/ae101005040.mkf.gz . unix% gunzip ae101005040.mkf.gz (need unzip the mkf file) unix% ln -s ../hk/ae101005040hxd_0_tel_uf.gti.gz . (which is telemetry unsaturated GTI, by hxdgtigen, see Appendix B) unix% wget http://suzaku.gsfc.nasa.gov/docs/suzaku/analysis/pin_mkf.sel unix% wget http://suzaku.gsfc.nasa.gov/docs/suzaku/analysis/gso_mkf.sel unix% xselect xsel > read event xsel > . xsel > ae101005040hxd_0_wel_uf2.evt xsel > select mkf @pin_mkf.sel (please use gso_mkf.sel for GSO data) xsel > . xsel > filter column xsel > "DET_TYPE=1:1" (please use "DET_TYPE=0:0" for GSO) xsel > filter time file ae101005040hxd_0_tel_uf.gti.gz xsel > show filter xsel > extract event xsel > save event xsel > ae101005040hxd_0_pinno_cl2.evt xsel > yes xsel > exit (Update DETNAM; the file consists only PIN cleaned event) unix% fparkey fitsfile="ae101005040hxd_0_pinno_cl2.evt+0" \ value="WELL_PIN" keyword="DETNAM" comm="detector name" add=no unix% fparkey fitsfile="ae101005040hxd_0_pinno_cl2.evt+1" \ value="WELL_PIN" keyword="DETNAM" comm="detector name" add=no (Please use value="WELL_GSO" for GSO data.) Note that some old version of 'hxdtime' may fail to caluculate 'TIMEDEL' value in the unscreened file, or default value of the pipe line product may be "-999". In that case, please fill the following value. 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 Finally, you will get re-calibrated cleaned-event files, ae101005040hxd_0_pinno_cl2.evt, and ae101005040hxd_0_gsono_cl2.evt in event_cl2/ directory. Appendix B. Criteria for Cleaned event in version 2.0 process -------------------------------------------------------------- The criteria to make GTIs for cleaned events in version-2.x products is as follows: "AOCU_HK_CNT3_NML_P==1", "ANG_DIST < 1.5", "HXD_DTRATE < 3", (GSO only) "SAA_HXD == 0", "T_SAA_HXD > 500", "TN_SAA_HXD > 180", "ELV > 5", "COR >6", "HXD_HV_Wn_CAL>700" (n=0,1,2,3) "HXD_HV_Tn_CAL>700" (n=0,1,2,3) For more detail and the exact expressions, please check the following URL. http://www.astro.isas.jaxa.jp/suzaku/process/v2changes/criteria_hxd.html The XSELECT compatible file of the criteria are available from http://suzaku.gsfc.nasa.gov/docs/suzaku/analysis/pin_mkf.sel, or http://suzaku.gsfc.nasa.gov/docs/suzaku/analysis/gso_mkf.sel, for PINs and GSOs, respectively. All items are AND logic. In addition, the period of the data transfer saturation is excluded. The GTI that does not contain such period is created as follows. ./hxdgtigen hk_dir="./" hk_file="ae101005040hxd_0.hk.gz" \ gti_fname="hxdgtigen.gti" if you use the hxdgtigen ver1.3(beta version for the next HEADAS release), ./hxdgtigen hk_dir="./" hk_file="ae101005040hxd_0.hk.gz" \ gti_fname="hxdgtigen.gti" WPU="0123" We, then, choose events with "DET_TYPE=0:0" or "DET_TYPE=1:1" events for GSO or PIN data, respectively. If you want to select events manually, please prepare an HXD HK file, EHK file, and unscreened events, and use the following xselect commands, instead of xsel > filter time file xsel > ae101005040hxd_0_pinno_cl.gti in the 2nd Step (2-b). xsel > read hk xsel > . xsel > ../auxil/ae101005040.hk.gz xsel > yes xsel > select hk xsel > AOCU_HK_CNT3_NML_P==1 xsel > extract event xsel > read hk xsel > . xsel > ../auxil/ae101005040.ehk.gz xsel > yes xsel > select hk xsel > ANG_DIST<1.5 && ELV>5 && SAA_HXD==0 && T_SAA_HXD>500 && TN_SAA_HXD>180 && COR>6 xsel > extract event xsel > clear hk xsel > read hk xsel > . xsel > ../hxd/hk/ae101005040hxd_0.hk.gz xsel > yes xsel > select hk xsel > HXD_HV_W0_CAL>700 && HXD_HV_W1_CAL>700 && HXD_HV_W2_CAL>700 && HXD_HV_W3_CAL>700 && HXD_HV_T0_CAL>700 && HXD_HV_T1_CAL>700 && HXD_HV_T2_CAL>700 && HXD_HV_T3_CAL>700 (Please add HXD_DTRATE < 3 criteria to GSO data) xsel > filter time file hxdgtigen.gti xsel > extract event Appendix C. Create NXB spectrum by yourself: ------------------------------------------- If you would like to examine the systematic error of the background model for your object, the best way is to extract the NXB spectrum by use of the earth-occulted period and compare it with the model. Please note that there is not always earth-occultation. You can estimate the duration with the EHK file: unix% fplot auxil/ae101005040.ehk.gz TIME ELV - /XW pltcmd=" " (In this example, there is no earth-occultation because this is a very short observation, actually, the step-point for the large maneuver.) When the elevation of the source (ELV) is less than -5 degree, the FOV of the detector is occulted by the earth and hence the spectrum during this period can be treated as same as the NXB component. Extraction of the earth-occulted data is almost the same procedure as Appendix B, but you must change the selection of ELV>5 by ELV<-5 . Do not forget to apply the dead time correction. For more detail on the systematics of the HXD NXB modeling, please check the Suzaku Documents on http://www.astro.isas.jaxa.jp/suzaku/doc/ . EOF