NAME

USAGE

DESCRIPTION

Create a simulated PSF event file for a specific GSC camera and sky location. Events are generated for time intervals defined by an input GTI file and within a given range of energy. Events are mapped to an event file with a tangent plane centered on a sky location and distributed within a specified radius around that location. The event rate is increased by a simulation factor to ensure adequate statistical sampling.

PARAMETERS

gscid [integer]

GSC camera id (0-11).

gtifname [filename]

Name of the input GTI file matching the specified camera and time interval.

outfname [filename]

Output simulated PSF event file name.

object [string]

String value for the OBJECT keyword in the output event file.

target_ra [real] (J2000; degrees)

Right Ascension of the simulation target.

target_dec [real] (J2000; degrees)

Declination of the simulation target.

center_ra [real] (J2000; degrees)

Right Ascension of the image center.

center_dec [real] (J2000; degrees)

Declination of the image center.

ene_lo [real] (keV)

Lower energy boundary for the simulation.

ene_hi [real] (keV)

Upper energy boundary for the simulation.

(radi = 8.0) [real] (degrees)

Radius of the region within which simulation events are produced. Default value is 8.0 degrees.

(nx = 200) [integer]

Number of the pixels in the x-direction of the simulated sky area. Default value is 200 pixels.

(ny = 200) [integer]

Number of the pixels in the y-direction of the simulated sky area. Default value is 200 pixels.

(pixsize = 0.1) [real] (degrees)

Pixel size. The default value is 0.1 degrees.

(sim_scale = 10) [integer]

Simulation scale factor, such that the simulated events are made 'sim_scale' times the simulated observation data rate. A higher value provides better statistical accuracy, but takes longer to compute. The default value is 10.

(auxpath = "trend") [string]

Path to the auxiliary files. Default value is "trend".

(attlist = "iatlist.fits") [filename])

Name of the attitude file list to be used. The default is "iatlist.fits".

(vclist = "vclist.fits") [filename]

Name of the veto carbon (GSC housekeeping) file list. The default is "vclist.fits".

(leapsecfile = "REFDATA") [string]

If set to "REFDATA" (default), use the built-in reference file for defining leap seconds. If set to "CALDB", use the reference file in the MAXI calibration database. Otherwise, use the specified file name.

(teldefgsc = "CALDB") [string]

The telescope definition (TELDEF) file for the specific GSC camera. The default setting of "CALDB" will obtain this information from the MAXI calibration database.

(hvhistfile = "CALDB") [file list]

The high voltage history file for the specific GSC camera. The default setting of "CALDB" will obtain this information from the MAXI calibration database.

(crabratefile = "CALDB") [filename]

Name of the Crab rate map file, which gives the observed Crab spectra at different locations of the detector and used to compute a modeled spectra. If set to "CALDB" (default), the file is obtained from the MAXI calibration database.

(bexsigmafile = "CALDB") [filename]

Name of the file containing the position-dependent one dimensional point spread function (the X direction at the Beryllium window). If set to "CALDB" (default), the file is obtained from the MAXI calibration database.

(clobber = "yes") [boolean]

Overwrites the existing output file (yes) nor (not).

(history=yes) [boolean]

Records tool parameters in HISTORY keywords if set to yes (default).

(chatter = 1) [integer]

Chatter level for output. Set to 0 to suppress output. Higher values up to 50 support increased amount of output. The default value is 1.

(mode = "ql") [string ql|hl|q]

Mode to query the parameter file. Acceptable values include: "ql" (query and learn/remember), "hl" (hidden and learn/remember), "q" (query but don’t remember), "h" (hidden).

EXAMPLES

Generate a simulated point spread function event file centered on the Crab for GSC camera 1. Use the GTI file 'crab_g1_fov.gti' to define the time intervals of interest, and write the result event file to 'crab_g1_psf.evt'.
The event file projects these events into a 200 x 200 pixel tangent plane image with 0.1 degree square pixels centered on the Crab, covering the energy range 2.0 - 20.0 keV and computed with a simulation scale factor of 10. The OBJECT keyword in the event file will be set to "Crab".

mxsim_psf gscid=1  gtifname=crab_g1_fov.gti outfname=crab_g1_psf.evt \
    object="Crab" target_ra=83.63  target_dec=22.01 center_ra=83.63 center_dec=22.01 \
    ene_lo=2.0 ene_hi=20.0 radi=8.0 nx=200 ny=200 pixsize=0.1 sim_scale=10

Cavueats

The values for 'nx' and 'ny' should be at least 2 x 'radi' / 'pixsize' or the simulation may be truncated by image plane sampling effects. For example, for the default settings of 'radi' = 8.0 degrees and 'pixsize' = 0.1 degrees (default sizes), 'nx' and 'ny' should be at least 160 pixels (the default for each is 200).

SEE ALSO

LAST MODIFIED