HXDGRADE (July 2008) suzaku.hxd HXDGRADE (July 2008) NAME hxdgrade -- fill the GRADE columns for the WELL FITS USAGE hxdgrade input_name hxdgrade_psdsel_fname hxdgrade_pinthr_fname DESCRIPTION Fill the GRADE columns, (1) GRADE_QUALTY (data quality) (2) GRADE_PMTTRG (tag for a PMT triggerd event) (3) GRADE_PINTRG (tag for a PIN triggerd event) (4) GRADE_PSDSEL (GSO likelihood in the Slow Fast diagram) (5) GRADE_HITPAT (hit pattern grade) The event type which the HXD team recommend is summerized in the 'DET_TYPE' column (0=GSO, 1=PIN, and 255=others). For PIN events (with single trigger pattern of 'TRG'), the detector id (0,1,2,3) in a Well unit is filled into the 'PIN_ID' column. The 'PI_PIN' column is copied by the value of 'PI_PINn' (n=0,1,2,3) of the corresponding 'PIN_ID', when 'DET_TYPE' value is 1 (recommened PIN event). PARAMETERS (read_iomode = overwrite) HXD event fits input I/O mode : overwrite or create ? (time_change = no) HXD event fits update TIME : yes or no ? (grade_change = yes) HXD event fits update GRADE : yes or no ? (pi_pmt_change = no) HXD event fits update PI_FAST PI_SLOW : yes or no ? (pi_pin_change = no) HXD event fits update PI_PIN0 PI_PIN1 PI_PIN2 PI_PIN3 : yes or no ? (gtimode = no) HXD event fits using GTI : yes or no ? (gti_time = S_TIME) Name of the column in the event file from where the task read the time. Either TIME or S_TIME. input_name HXD event fits file name ? create_name File name of HXD event fits file created. valid only when read_iomode = 'create'. (hxdgrade_psdsel_fname = CALDB) Settings for PSD selection, used for GRADE_PSDSEL. This file is located in CALDB. The name is ae_hxd_gsopsd_YYYYMMDD.fits where the string YYYYMMDD If the value is set to "CALDB", the tool automatically access the latest psdsel file in the CALDB area. (hxdgrade_pinthres_fname = CALDB) Settings for PIN lower threshold, used for GRADE_PINTRG. This file is located in CALDB. The name is ae_hxd_pinthr_YYYYMMDD.fits where the string YYYYMMDD. If the value is set to "CALDB", the tool automatically access the latest pinthr file in the CALDB area. (hxdgrade_psdsel_criteria) PSD selection criteria. (use_pwh_mode = n) Use PWH in time assignment ? (num_event = -1) number of event (-1=all, 0=exit) (event_freq = 10000) Event number printout frequency (anl_verbose = -1) ANL verbose level (-1:full, 0:minimum) (anl_profile = yes) Enable ANL module profiling (chatter = 2) message chatter level (0:min, 2:norm, 5:max) EXAMPLES 1. Fill the GRADE columns for the event file named "ae20040824_1853_1959_hxd_wel.uff", using psdsel caldb FITS file, "ae_hxd_gsopsd_20050907.fits" and "ae_hxd_pinthr_20050907.fits" % hxdgrade input_name="ae20040824_1853_1959_hxd_wel.uff" \ hxdgrade_psdsel_fname="ae_hxd_gsopsd_20050907.fits" \ hxdgrade_pinthr_fname="ae_hxd_pinthr_20050907.fits" BUGS SEE ALSO AUTHOR Takao KITAGUCHI (Univ. of Tokyo), Yukikatsu TERADA (Saitama Univ), and the HXD team LAST MODIFIED July 2008