skip to content
 

There will be a network outage, Sunday, April 26 from 13:00 EDT - Monday April 27 01:00 EDT. All services, web sites, and systems that require access to the internet will be affected by this work.

Suzaku Guest Observer Facility

XISSIMARFGEN: Complete Parameter List


On this page, we describe all the explicit parameters and important hidden parameters (shown with braces) of xissimarfgen by category. Items with bold letters show options on the command line, and bullets under those items show possible values. Bold items under a parameter show additional parameters users must specify for that choice.

Parameter Listing

1. Telescope and detector calibration files

  • instrume : XIS detector name
    • XIS0
    • XIS1
    • XIS2
    • XIS3
  • rmffile : XIS response (rmf) file name
    • ``file name"

2. Setting energy steps of the arf table

  • estepfile : energy step file name, or names of internal energy step tables
    • full : calculate effective area in each RMF energy bins. Very slow.
    • dense or default : dense sampling (2303 steps). Slow.
    • medium : medium sampling (157 steps). Moderate.
    • sparse : sparse sampling (55 steps). Fast.
    • ``file name"

3. Distribution of incoming X-ray emission

  • source_mode : source mode
    • SKYFITS : FITS image in the sky coordinate
      • source_image : source FITS image file name
    • DETFITS : FITS image in the detector coordinate
      • source_image : source FITS image file name
    • J2000 : RA, DEC coordinate of an assumed point source
      • source_ra : right accension of the source position  (UNIT: deg)
      • source_dec : declination of the source position (UNIT: deg)
    • SKYXY : X/Y sky coordinate of an assumed point source
      • source_x : x coordinate of the source position (UNIT: pixel)
      • source_y : y coordinate of the source position (UNIT: pixel)
    • DETXY : DETX/DETY coordinate of an assumed point source
      • source_x : det x coordinate of the source position (UNIT: pixel)
      • source_y : det y coordinate of the source position (UNIT: pixel)
    • UNIFORM : flat emission inside an annulus region centered at the optical axis
      • source_rmin : inner radius of the annulus (UNIT: arcmin)
      • source_rmax : outer radius of the annulus (UNIT: arcmin)
Caveats: ARF is normalized to the flux from the whole emission region, (which can be outside of the event extraction region).

4. Event extraction regions and output arf file names

Users can generate arfs up to 200 different extracting regions, whose numbers are set up at the num_region parameter. Users have to specify the same numbers of source extracting regions and arf file names.
  • num_region : number of ARF files to be created
  • region_mode : region mode
    • SKYFITS (Input file must be unbinned - 1536x1536 pix FITS image)
      • regfile1 : region FITS file #1
      • regfile2 : region FITS file #2
      • .....
      • regfileN : region FITS file #N(b)
    • DETFITS (Input file must be unbinned - 1024x1024 pix FITS image)
      • regfile1 : region FITS file #1
      • regfile2 : region FITS file #2
      • .....
      • regfileN : region file #N(b)
    • SKYREG (ds9 region file in the sky coordinate - File Coordinate System: physical)
      • regfile1 : ds9 region file #1
      • regfile2 : ds9 region file #2
      • .....
      • regfileN : ds9 region file #N(b)
    • DETREG (ds9 region file in the detector coordinate - File Coordinate System: physical)
      • regfile1 : ds9 region file #1
      • regfile2 : ds9 region file #2
      • .....
      • regfileN : ds9 region file #N(b)
    • SKYCIRC (UNIT: unbinned pixels in the sky coordinate)
      • region_x1 : region x #1
      • ...
      • region_xN : region x #N(b)
      • region_y1 : region y #1
      • .....
      • region_yN : region y #N(b)
      • region_rmin1 : region inner radius #1
      • .....
      • region_rminN : region inner radius #N(b)
      • region_rmax1 : region outer radius #1
      • ......
      • region_rmaxN : region outer radius #N(b)
    • DETCIRC (UNIT: unbinned pixels in the detector coordinate)
      • region_x1 : region x #1
      • ...
      • region_xN : region x #N(b)
      • region_y1 : region y #1
      • .....
      • region_yN : region y #N(b)
      • region_rmin1 : region inner radius #1
      • .....
      • region_rminN : region inner radius #N(b)
      • region_rmax1 : region outer radius #1
      • ......
      • region_rmaxN : region outer radius #N(b)
  • arffile1 : output arf file #1
  • arffile2 : output arf file #2
  • ....
  • arffileN : output arf file #N(b)
  • detmask : mask image file. Useful to remove calibration source region, or bad pixels.
    • ``file name"
  • (pixq_min = 0) : Minimum value of pixel quality to be considered.
  • (pixq_min = 524287) : Maximum value of pixel quality to be considered.
  • (pixq_and = 65536) : Bit AND mask for pixel quality.
  • (pixq_eql = 0) : 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
Notes:
    (b): Number N is specified in the num_region parameter

Caveats:
    When you select
the SKYFITS or DETFITS options, the resultant arf files are weighted by intensity of the input image. If you only want to specify a source region, you have to put 1 on the source extracting region. A pixel with negative values are not counted in the calculation.

5. Set up the degree of precision

  • limit_mode : limit mode
    • ACCURACY
      • accuracy : calculation accuracy for each energy bin
    • NUM_PHOTON
      • num_photon : number of photons for each energy bin
    • MIXED
      • accuracy
      • num_photon
Caveates: Users are recommended to use num_photon mode. Put num_photon at least 100,000 (and more for sources extended outside of the FOV) to avoid interference of photon statistics.

6. Specify observation date

  • gtifile : GTI file of the observation
    • filename of FITS with a GTI extension
    • none
      • date_obs : Date of the observation (Format: mission time (s) or a formatted string of `YYYY-MM-DDThh:mm:ss')

7. Viewing window of the instrument

  • pointing : pointing type
    • AUTO : Sky reference position is read from regfileN, when region_mode=SKYFITS, or determined automatically from default euler angles. Read Ishisaki et al. (2007 PASJ, 59, 113) for details
    • USER
      • ref_alpha : R.A. of the sky reference position when the source mode is SKYXY
      • ref_delta : DEC. of the sky reference position when the source mode is SKYXY
      • ref_roll : roll angle of the sky refernce when the source mode is SKYXY
  • attitude :
    • ``attitude filename"
    • none
      • ea1 : default 1st Euler Angle alpha (UNIT: deg)
      • ea2 : default 2nd Euler Angle theta (UNIT: deg)
      • ea3 : default 3rd Euler Angle psi (UNIT: deg)
8. Others
  • phafile : input pha file


BACK: Tips for Reducing Run Time
UP: Xissimarfgen top page


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

This file was last modified on Wednesday, 19-Sep-2007 21:18:19 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.