See gtbin:

Help | Examples

Also see:

gtbin

Synopsis: Bins GBM or LAT events list in time, energy, and/or space to produce light curves, spectra, count cubes, or count maps, respectively.

Usage: gtbin evfile scfile outfile algorithm ebinalg emin emax enumbins denergy ebinfile tbinalg tstart tstop dtime tbinfile snratio lcemin lcemax nxpix nypix binsz coordsys xref yref axisrot proj

Parameters

General Parameters

  algorithm [string: CCUBE|CMAP|LC|PHA1|PHA2]
   

Indicates which specific binning to perform by indicating the type of output file produced. Legal values are CCUBE (a data cube with one or more count maps binned in sky X-Y projected coordinates with the z-axis corresponding to different energy bins), CMAP (count map binned in sky X-Y projected coordinates), LC (light curve binned in time only), PHA1 (spectrum binned in energy), and PHA2 (spectra binned in energy for a series of time ranges/bins).

Note: CCUBE and CMAP are not applicable to GBM TTE data, since they do not have a spatial dependence. PHA1 does not provide time cuts, and thus bins all of the event data.

     
  evfile [file]
    Name of input event FITS file containing the event data.
     
  outfile [file]
    Name of output FITS file, whose contents are determined by the algorithm parameter: count map, light curve, or spectra.
     
  scfile [file]
   

Spacecraft data file containing information such as spacecraft pointing as a function of time. This file can be generated by gtorbsim for simulated observations (see the gtorbsim help for further explanation) or, more commonly, it can be obtained from SLAC's data portal.

Note: Binning GBM data does not require a spacecraft data file; therefore, this parameter should be set to "none".

Time Binning Parameters

  tbinalg = LIN [string: FILE|LIN|SNR]
   

Indicates how the time bins will be specified. Legal values are FILE (bins will be read from a bin definition file), LIN (linearly uniform bins), and SNR (signal-to-noise ratio) per time bin. This parameter is only used if the output type requires binning in the time domain; that is, if the "algorithm" parameter is LC or PHA2.

Note: SNR binning has not yet been implemented.

     
  tstart [double]
   

The start time of the first interval for linearly uniform bins in mission elapsed time (MET) seconds. Only used if tbinalg is LIN, and if the output type requires time binning (LC and PHA2; see tbinalg). If this parameter is set to "INDEF", the start value of the original event file is taken as tstart.

Note: tstart is not applicable to PHA1 binning.

     
  tstop [double]]
   

The stop time of the last interval for linearly uniform bins in MET seconds. Only used if tbinalg is LIN, and if the output type requires time binning (LC and PHA2;see tbinalg). If this parameter is set to "INDEF", the start value of the original event file is taken as tstop.

Note: tstop is not applicable to PHA1 binning.

     
  dtime [double]
    The width of linearly uniform bins in seconds. This option is used only if tbinalg is LIN, and if the output type requires time binning. (See tbinalg.)
     
  tbinfile [file]
   

The name of the optional time bin definition file. This file is created by the gtbindef tool. (See gtbindef documentation.) This option is used only if tbinalg is FILE, and if the output type requires time binning. (See tbinalg.)

Note: tbinfile is applicable to PHA2 binning, but not to PHA1 binning.

     
  snratio = 0 [double]
   

Signal-to-noise ratio per time bin. This parameter is only used if tbinalg is SNR, and if the output type requires time binning. (See tbinalg.)

Note: This option is not fully implemented yet.

     
  lcemin [double]
   

Lower bound of energy range (in MeV) used to determine the bins in signal-to-noise binning. Note that all events in the input file will be binned, but only events that are in the range [lcemin, lcemax] contribute to the signal statistics for purposes of determining when to start a new time bin. This option is used only if SNR was selected in tbinalg, and if the output type requires time binning. (See tbinalg.)

Note: SNR binning has not yet been implemented.

     
  lcemax [double]
    Upper bound of energy range (in MeV) used to determine the bins in signal-to-noise binning. Note that all events in the input file will be binned, but only events that are in the range [lcemin, lcemax] contribute to the signal statistics for purposes of determining when to start a new bin. This option is used only if SNR was selected in tbinalg, and if the output type requires time binning. (See tbinalg.)

Spatial Binning Parameters

  nxpix [integer]
    The number of pixels in the horizontal dimension in output image. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.
     
  nypix [integer]
    The number of pixels in the vertical dimension in output image. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.
     
  binsz [double]
    The number of degrees per pixel at the center of the image. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.
     
  xref [double]
    The horizontal position of the center of the image, either RA in celestial coordinates, or l in galactic coordinates. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.
     
  yref [double]
    The vertical position of the center of the image, either DEC in celestial coordinates, or b in galactic coordinates. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.
     
  axisrot = 0. [double]
    The rotation angle desired for the image. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.
     
  proj = AIT [string: AIT|ZEA|ARC|CAR|GLS|MER|NCP|SIN|STG|TAN, or any three letter identifier recognized by wcslib]
    Coordinate projection (AIT|ZEA|ARC|CAR|GLS|MER|NCP|SIN|STG|TAN); see
Calabretta & Greisen 2002, A&A, 395, 1077 for definitions of the projections. Must be AIT, ZEA, or CAR for auto full sky. This parameter is only used if the parameter "algorithm" is CMAP or CCUBE.
     
  coordsys = CEL [bool: CEL|GAL]
    Coordinate system. If you choose CEL, you will be prompted for ra and dec (J2000); if you choose GAL, you will be prompted for l and b coordinates. This parameter is used only if the parameter "algorithm" is CMAP or CCUBE.

Energy Binning Parameters

  ebinalg = LOG [string: FILE|LIN|LOG]
    Indicates how the energy bins will be specified. Legal values are FILE (bins will be read from a bin definition file), LIN (linearly uniform bins), or LOG (logarithmically uniform bins). This is applicable only if the output type requires energy binning; that is, if the "algorithm" parameter is PHA1, PHA2, or CCUBE.
     
  emin [double]
    The lowest energy of the first interval for linearly or logarithmically uniform bins. Only used if ebinalg is LIN or LOG, and if the output type requires energy binning. (See ebinalg.)
     
  emax [double]
    The highest energy of the last interval for linearly or logarithmically uniform bins. Only used if ebinalg is LIN or LOG, and if the output type requires energy binning (see ebinalg).
     
  enumbins [integer]
    The number of bins for logarithmically uniform bins. Only used if ebinalg is LOG, and if the output type requires energy binning. (See ebinalg.)
     
  denergy [double]
    The width of linearly uniform bins. Only used if ebinalg is LIN, and if the output type requires energy binning. (See ebinalg.)
     
  ebinfile [file]
    The name of the energy bin definition file. Only used if ebinalg is FILE, and if the output type requires energy binning. (See ebinalg.)

Hidden Parameters

  (efield = ENERGY) [string]
    This is the name of the field containing the energy values for energy binning. The default value is consistent with the FERMI/LAT event file format.
     
  (tfield = TIME) [string]
    This is the name of the field containing the time values for time binning. The default value is consistent with the FFERMI/LAT event file format.
     
  (rafield = RA) [string]
    The field in the input file which contains the RA (count maps only). The default value is the one used in FERMI/LAT event files.
     
  (decfield = DEC) [string]
    The field in the input file which contains the DEC (count maps only). The default value is the one used in FERMI/LAT event files.
     
  (evtable = EVENTS) [string]
    Event table extension name. The default value is consistent with the FERMI/LAT event file format.
     
  (sctable = SC_DATA) [string]
    Spacecraft data extension. The default value is consistent with the FERMI/LAT event file format.
     
  (chatter = 2) [integer]
    This parameter fixes the output verbosity: no screen output (0), nominal screen output (2), maximum verbosity (4). (default: 2)
     
  (clobber = yes) [string]
    Overwrite or do not overwrite existing output files. (default: yes)
     
  (debug = no) [string]
   

Activate debugging mode. (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 the parameter specified is "yes", the Graphical User Interface (GUI) mode is activated. (default: no)
     
  (mode = ql)
    Mode of automatic parameters. (default: ql)
     

Owned by: Yasushi Ikebe ikebe@milkyway.gsfc.nasa.gov
  James Peachey peachey@lheamail.gsfc.nasa.gov
Last updated by: Chuck Patterson 12/16/2010