XISNXBGEN (Aug 2010) suzaku.xis XISNXBGEN (Aug 2010) NAME xisnxbgen -- estimate the non X-ray background spectrum or image of XIS USAGE xisnxbgen outfile phafile region_mode regfile orbit attitude DESCRIPTION 'xisnxbgen' estimates the non X-ray background (NXB) spectrum or image of XIS, by means of the weighted sum of the night Earth observations. Details of methods and reproducibility are described in Tawa et al (2008). Default indicator of the NXB is COR2 (revised cut-off rigidity) in the extended HK (EHK) file made by 'aemkehk'. Other indicators can be usable, e.g., obsolete cut-off rigidity COR, or PINUD rate in combination with 'aemkpinudhk'. Because the NXB database (night Earth observation event file) for each XIS sensor (XIS0, XIS1, XIS2 and XIS3) is common, event files of 5x5 and 3x3 editing modes should be merged together before applying 'xisnxbgen'. The 5x5 mode event file can be converted into the 3x3 mode event file by 'xis5x5to3x3'. XSELECT can handle both files together, however PHAS column of the 5x5 event files is broken when one would extract and save events. In order to catch up with the latest calibration, 'xisnxbgen' automatically applys 'xispi', 'xisputpixelquality', and 'cleansis' to the NXB database. This feature may be disabled by setting the "apply_xisftools=no". The GRADE selection can be done with the "grades" parameter, and the pixel quality (or STATUS column) selection is done with the "pixq_min", "pixq_max", "pixq_and", and "pixq_eql" parameters. See help file of 'xisputpixelquality' for details of the definition. Considering possible long-term change of the NXB and the steady decay of the 55Fe calibration isotope (2.73 year half-life), 'xisnxbgen' extracts events from the NXB database between (TSTART - 150 days) and (TSTOP + 150 days) of the input PHA file specified by the "phafile" parameter, by default. This time window may be changed by the "time_min" and "time_max" parameters. 'xisnxbgen' also detect whether the observation is done in Spaced-row Charge Injection ON (SCI-on) or SCI-off automatically with the CI header keyword, and switches the NXB database. In estimating the NXB spectrum, one can specify the accumulation region in the same way as 'xissimarfgen' with parameters of "region_mode", "regfile", and "detmask". The accumulation region may be specified in SKY coordinates (region_mode=SKYFITS/SKYREG/SKYEXPR) as well as the DET coordinates (region_mode=DETFITS/DETREG/DETEXPR). However, implementation of the SKY coordinate extraction is *** EXPERIMENTAL ***, and 'xisnxbgen' does not suppose large changes in the spacecraft attitude during the observation. The AREASCAL, BACKSCAL, and CORRSCAL keywords are copied from the input PHA file to the output spectrum file. EXPOSURE is set to the effective value, so that square root of the total count is equal to the statistical error of the total count. In estimating the NXB image, one can specify the energy range by the hidden parameters of "pi_min" and "pi_max". Note that energy scale of XIS is set to 3.65 eV/PI-ch, corresponding to the band-gap energy of Si. Strictly speaking, PI = 0 ch correspond to 0.0 <= E < 3.65 eV. These parameters do not affect the estimation of the NXB spectrum. The accumulation region by the "regfile" parameter is ignored, while the "detmask" parameter is considered in the NXB image estimation. The estimated NXB image in DET coordinates is always appended to the next extension of the NXB spectrum in the same output file specified by the "outfile" parameter. When region_mode=SKYFITS/SKYREG/SKYEXPR, the SKY coordinate image of the estimated NXB is appended to the next extension. This is a simple projection of the DET coordinate image to SKY coordinates in the same way as the 'xisexpmapgen'. After the XIS0 anomaly in 23 June 2009, we apply an area discrimination (AD) to all the XIS0 data starting from June 27, 2009 16:27 (UT). The discriminated area is in the segment A, covering about 1/8 of the entire chip. If (a) the duration covers after the XIS0 anomaly event and the subsequent AD operation, and (b) the source extraction region includes the AD-ed region, the resultant NXB spectrum may become inappropriate. See the web page of http://www.astro.isas.jaxa.jp/suzaku/analysis/xis/xis0_area_discriminaion/ for details. PARAMETERS outfile [file name] Name of output NXB file. phafile [file name] Name of the input spectrum (PHA) file to get observation mode. The AREASCAL, BACKSCAL, and CORRSCAL keywords are copied from this file. region_mode [string] Any of DETFITS, DETREG, DETEXPR, SKYFITS, SKYREG, or SKYEXPR. DET or SKY coordinates must be in unbinned size (1024x1024 or 1536x1536). SKYFITS, SKYREG, or SKYEXPR are *** EXPERIMENTAL ***. regfile [file name] DS9 format region file (DETREG/SKYREG), or FITS image file including WMAP (DETFITS/SKYFITS), or a boolean expression usable in CFITSIO library (DETEXPR/SKYEXPR). (detmask = none) [file name] Mask image file in DET or ACT coordinates. (pi_min = 0) [integer] Minimum PI value for output NXB image. (pi_max = 4095) [integer] Maximum PI value for output NXB image. orbit [file name] Name of input orbit file. attitude [file name] Name of input attitude file, or 'NONE'. Attitude file is only needed when region_mode=SKY**. (ehkfile = none) [file name] Name of EHK file, or 'NONE'. EHK file is only needed unless sortkey='COR' nor 'COR2'. (gtifile = none) [file name] Name of GTI file, or 'NONE'. When gtifile=NONE, which is default, phafile is used to read GTI. (teldef = CALDB) [file name] Name of input teldef file, or 'CALDB' to automatically read from the calibration database. The name is ae__teldef_YYYYMMDD.fits where is a string set to xi0, xi1, xi2, xi3 indicating the sensor and YYYYMMDD is the release date. (leapfile = CALDB;$ENV{LHEA_DATA}/leapsec.fits) [file name] Name of the leap second file. The default value is set to indicate that aemkehk will search for the file in CALDB first and then in the LHEA_DATA directory if necessary (the actual path for the HEADAS installation in use will be shown). (rigidity = CALDB;$ENV{LHEA_DATA}/rigidity_20060421.fits) [file name] Location of the FITS rigidity data file for COR2 column, specified similarly to the leap second file. (nxbevent = CALDB) [file name] Name of the NXB database file, or 'CALDB' to automatically read from the calibration database. The name is ae__nxbsciof_YYYYMMDD.fits (SCI-off) or ae__nxbscion_YYYYMMDD.fits (SCI-on). (nxborbit = CALDB) [file name] Name of the orbit file for the NXB database, or 'CALDB' to automatically read from the calibration database. The name is ae__nxborbit_YYYYMMDD.fits. (nxbvdchk = CALDB) [file name] Name of the video card HK file for the NXB database, or 'CALDB' to automatically read from the calibration database. The name is ae__nxbvdchk_YYYYMMDD.fits. (nxbcorhk = CALDB) [file name] Name of the COR and PINUD HK file for the NXB database, or 'CALDB' to automatically read from the calibration database. The name is ae__nxbcorhk_YYYYMMDD.fits. (sortkey = COR2) [string] Name of the NXB indicator. When sortkey=COR2 or COR, the revised or obsolete cut-off rigidity is calculated using orbit files, specified by the "orbit" and "nxborbit" parameters. Otherwise, specified keyword is searched in the EHK files, specified by the "ehkfile" and "nxbcorhk" parameters. (sortstep = "0,4,5,6,7,8,9,10,11,12,13,99") [string] Steps in sorting NXB database with the "sortkey" value. In combination with sortkey=PINUD, it is recommended to use sortstep="100,150,175,200,225,250,275,300,325,350,375,400,425,450,500". (gti_min_sec = 4.0) [real] Ignore GTI rows shorter than this number. (ehk_margin_sec = 30.0) [real] Time margin in second while reading the EHK files. (time_min = -150) [string] When starting with "+" or "-" sign, this parameter denote days before observation to extract from NXB database, relative to the TSTART header keyword of the input PHA file. Otherwise, CFITSIO date string format of 'YYYY-MM-DDThh:mm:ss' is assumed. (time_max = +150) [string] When starting with "+" or "-" sign, this parameter denote days after observation to extract from NXB database, relative to the TSTOP header keyword of the input PHA file. Otherwise, CFITSIO date string format of 'YYYY-MM-DDThh:mm:ss' is assumed. (grades = "0,2,3,4,6") [string] List of GRADE values to accept for the NXB database. (apply_xisftools = yes) [boolean] Flag to apply 'xispi', 'xisputpixelquality', and 'cleansis' to the NXB database. (enable_pixq = yes) [boolean] Enable the pixel quality selection with parameters: "pixq_min", "pixq_max", "pixq_and", and "pixq_eql". (pixq_min = 0) [real] Minimum value of allowed pixel quality. (pixq_max = 524287) [real] Maximum value of allowed pixel quality. (pixq_and = 65536) [real] Bit AND mask for pixel quality. The default value of 65536 is set to remove the 55Fe calibration source area. (pixq_eql = 0) [real] Allowed pixel quality after bit AND mask. The pixel quality, equivalent to the STATUS column of event files, are selected as: pixq_min <= STATUS && STATUS <= pixq_max && (STATUS & pixq_and) == pixq_eql (aberration = yes) [boolean] Correct aberration due to parallax, i.e. the revolution of the Earth around the Sun. (clobber = yes) [boolean] Overwrite output file if exists. (anl_verbose = 1) [integer] ANL verbose level (-1:full, 0:minimum). (anl_profile = yes) [boolean] Enable ANL module profiling. (num_event = -1) [integer] Number of event (-1=all, 0=exit). (event_freq = 1000) [integer] Event number printout frequency. (chatter = 2) [integer] Message chatter level (0:min,2:norm,5:max). EXAMPLES 1. Create an estimated NXB file 'xis1_nxb.pi' in the DET coordinates region 'ds9.reg' using an input spectrum file 'xis1_src.pi' with the default CALDB files and the default pixel quality selection. % xisnxbgen xis1_nxb.pi xis1_src.pi DETREG ds9.reg suzaku.orb none 2. Create an estimated NXB file 'xis1_nxb.pi' in the SKY coordinates region 'ds9.reg' using an input spectrum file 'xis1_src.pi', with the default CALDB files, including the calibration source area, and an image in the energy range of 274 <= PI <= 548 (1-2 keV). % xisnxbgen xis1_nxb.pi xis1_src.pi SKYREG ds9.reg \ suzaku.orb suzaku.att pixq_and=0 pi_min=274 pi_max=548 3. Create an estimated NXB file 'xis1_nxb.pi' by sorting PINUD. % xisnxbgen xis1_nxb.pi xis1_src.pi DETREG ds9.reg \ suzaku.orb none ehkfile=suzaku.ehk sortkey=PINUD \ sortstep="100,150,175,200,225,250,275,300,325,350,375,400,425,450,500" SEE ALSO aemkpinudhk, aemkehk, xis5x5to3x3, xispi, xisputpixelquality, cleansis, xissimarfgen, xisexpmapgen AUTHOR N.TAWA (Osaka Univ), Y.ISHISAKI (TMU), and the XIS team. LAST MODIFIED Aug 2010