Print Version

gtexpcube: Archived

Please see the new gtexpcube2 parameters documentation.
See gtexpcube:

Help | Examples

Also see:

Synopsis:

Generates an exposure map, or a set of exposure maps for different energies, from a livetime cube written by gtltcube.

Usage: gtexpcube infile cmfile outfile irfs nxpix nypix pixscale coordsys xref yref axisrot proj emin emax enumbins

Prerequisites

Input Files:
  • Livetime or Exposure cube FITS file from gtltcube
  • Optionally, a counts map FITS file from gtbin, for which gtexpcube should match the coordinate projection and gridding.  The counts map also specifies the effective area response functions for gtexpcube to use.
Links

General Parameters

  infile [file]
    Exposure or Livetime cube file. FITS file containing livetime as a function of sky position and off-axis angle. This file can be generated by gtltcube, or obtained from SLAC's Data Portal. (See gtltcube help.)
     
 
evfile [file] 
    Name of the input event FITS file, which can be obtained from SLAC's data portal.
     
  cmfile [file]
    Count map input FITS file. This file is generated using gtbin. (See gtbin help.) Select "NONE" if you wish to specify the map geometry from parameters (nxpix, nypix, xref, yref, enumbins, etc).
     
  outfile [file]
    Exposure map output FITS file name.
     
  irfs [string]
    The instrument response (PSF, effective area, energy resolution) is a function of energy, inclination angle (the angle between the source and the LAT normal), and photon category. Since the LAT usually surveys the sky, a source is observed at different inclination angles. Each count is therefore characterized by a different instrument response function (IRF).
     
  nxpix = 1 [int]
    Number of pixels in the horizontal dimension in the output image. If proj is "CAR","AIT", or "ZEA", you can use the default value "1" for full sky.
     
  nypix = 1 [int]
    Number of pixels in the vertical dimension in the output image. If proj is "CAR","AIT", or "ZEA", you can use the default value "1" to create a full sky, or you can use the same value as specified for nxpix.
     
  pixscale = 0.5 [float]
    Image scale (in degrees/pixel). (default: 0.5)
     
  coordsys = "CEL" [string: CEL|GAL]
    Coordinate system. If you choose CEL, you will be prompted for RA and DEC (J2000) in the xref and yref parameters; if you choose GAL you will be prompted for l and b coordinates.
     
  xref = 0. [float]
    Horizontal position of the center of the image; either RA in celestial coordinates or l in Galactic coordinates (decimal degrees). (default: 0)
     
  yref = 0. [float]
    Vertical position of the center of the image; either DEC in celestial coordinates or b in Galactic coordinates (decimal degrees). (default: 0)
     
  axisrot = 0. [float]
    Rotation angle desired for the image in degrees. (default: 0)
     
proj = "AIT" [string: AIT|ARC|CAR|ZEA|GLS|MER|NCP|SIN|STG|TAN]
    Desired coordinate projection: Aitoff [AIT], Zenithal equal- area [ZEA], Zenithal equidistant [ARC], Plate Carree [CAR], Sanson-Flamsteed [GLS], Mercator [MER], North-Celestial-Pole [NCP], Slant orthographic [SIN], Stereographic [STG], Gnomonic [TAN]. See Calabretta & Greisen 2002, A&A, 395, 1077 for definitions of the projections. Must be AIT, ZEA, or CAR for auto full sky. The default value is AIT.
     
  emin = 30 [float]
    Lower boundary for first energy bin in MeV. It must be larger than, or equal
to, 30 MeV. (default: 30 MeV)
     
  emax = 200000 [float]
    Upper boundary for last energy bin in MeV. It must be less than, or equal to,
200 GeV. (default: 200 GeV)
     
  enumbins = 8 [int]
    Number of logarithmically spaced energy bins spanning emin to emax.
(default: 8)
Hidden parameters
  (bincalc = "CENTER") [string: CENTER|EDGE]
   

Allows you to choose how energy layers are computed from the count map (cmfile parameter) energy bounds. The options are CENTER and EDGE.This is a hidden parameter. (default: as of 11/30/2010 the default was set to CENTER, but will be changed to EDGE in a future release)

Troubleshooting Tip (11-30-2010): If you are experiencing a failure when running gtsrcmaps while performing a binned likelihood analysis, check that this hidden parameter is set to EDGE at the command line when computing the 3D exposure map using gtexpcube. If necessary, you can set this parameter from the command line when you launch gtexpcube; for example:

prompt> gtexpcube bincalc=EDGE

Update (12-17-2010) — When performing a binned likelihood analysis: A new tool, gtexpcube2 has been added for use in binned analysis with the Likelihood tools. This application replaces the "on-the-fly" binned exposure map calculation that was provided by gtsrcmaps, and it replaces the gtexpcube application from the map_tools package. The old gtexpcube application should not be used for Likelihood analysis any longer. (See ScienceTools-09-20-00 New Feature Summary in confluence.)

     
  (table = "Exposure") 
   

Exposure cube extension. This is a hidden parameter. (default: "Exposure")

     
  (evtable = "EVENTS")
    FT1 events extension.
   
  (chatter = 2)
    Output verbosity. This is a hidden parameter. (default: 2)
     
  (clobber = yes)
    If true, an existing file of the same name will be overwritten. This is a hidden parameter. yes)
     
  (debug = no)
   

Activate debugging mode. This is a hidden parameter. (default:no)

When debug is "no", all exceptions that are not caught and handled by individual tool-specific code are caught by a top-level exception handler that displays information about the exception and then exits.

When debug is "yes", such exceptions are not caught by the top level code. Instead the tool produces a segmentation violation, which is more useful for debugging. When debugging mode is enabled, the tool produces more verbose output describing any errors or exceptions that are encountered.

     
  (gui = no)
    If "yes" is specified, the Graphical User Interface (GUI) mode is activated.
This is a hidden parameter. (default: no)
     
  (mode = "ql")
    Mode of automatic parameters. This is a hidden parameter. (default: ql)

Owned by: Toby Burnett
Last updated by: Analia Cillis and Chuck Patterson 03/20/2006