cstsmapsplit.rst
3.9 KB
cstsmapsplit
Generate commands to split the Test Statistic map computation.
Synopsis
This script generates a sequence of commands to split the Test Statistic (TS) map computation into a distinct number of :ref:`cttsmap` computations. The sequence of commands is written into an ASCII file, where each line in the file corresponds to the command for an individual :ref:`cttsmap` run. Each TS map computed in that way will be suffixed with the command number, and the map can be combined into a single TS map using the :ref:`cstsmapmerge` script.
General parameters
- inobs [file]
- Input event list, counts cube or observation definition XML file.
- inmodel [file]
- Input model XML file.
- srcname [string]
- Name of source model for which the TS map should be computed.
- expcube [file]
- Input exposure cube file.
- psfcube [file]
- Input PSF cube file.
- edispcube [file]
- Input energy dispersion cube file.
- bkgcube [file]
- Input background cube file.
- caldb [string]
- Calibration database.
- irf [string]
- Instrumental response function.
- (edisp = no) [boolean]
- Applies energy dispersion to response computation?
- (errors = no) [boolean]
- Compute and store parameter errors?
- (statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]
- Optimization statistic. DEFAULT uses the default statistic for all observations, which is CSTAT or the statistic specified in the observation definition XML file. CSTAT uses the C statistic for all observations, WSTAT uses the W statistic for all On/Off observations, and CHI2 uses the Chi squared statistic for all binned or stacked observations.
- outmap [file]
- Output Test Statistic map file.
- bins_per_job [integer]
- Number of bins of the TS map that should be computed within one command.
- compute_null [boolean]
- Pre-computes the null hypothesis globally and passes the value to the individual commands. If the parameter is set to no, the null hypothesis will be computed in each run of :ref:`cttsmap` individually.
- (run_in_bkg = yes) [boolean]
- Append a & after each command in output file to simply execute the file by running all :ref:`cttsmap` jobs in the background.
- outfile [file]
- Output ASCII file name where the commands are written to.
- (usepnt = no) [boolean]
- Use CTA pointing direction for map centre instead of xref/yref parameters?
- nxpix [integer]
- Number of map pixels in Right Ascension or Galactic longitude.
- nypix [integer]
- Number of map pixels in Declination or Galactic latitude.
- binsz [real]
- Map pixel size (in degrees/pixel).
- coordsys <CEL|GAL> [string]
- Coordinate system (CEL - celestial, GAL - galactic).
- proj <AIT|AZP|CAR|GLS|MER|MOL|SFL|SIN|STG|TAN> [string]
- Projection method.
- xref [real]
- Right Ascension / Galactic longitude of map centre (J2000, in degrees).
- yref [real]
- Declination / Galactic latitude of map centre (J2000, in degrees).
Standard parameters
- (chatter = 2) [integer]
- Verbosity of the executable:
chatter = 0: no information will be logged
chatter = 1: only errors will be logged
chatter = 2: errors and actions will be logged
chatter = 3: report about the task execution
chatter = 4: detailed report about the task execution
- (clobber = yes) [boolean]
- Specifies whether an existing output TS map file should be overwritten.
- (debug = no) [boolean]
- Enables debug mode. In debug mode the executable will dump any log file output to the console.
- (mode = ql) [string]
- Mode of automatic parameters (default is ql, i.e. "query and learn").
- (logfile = cstsmapsplit.log) [string]
- Name of log file.