Commit e00e0e361657f339330d1f0eaa0dcd5b7eb753e3
1 parent
2e5dab1a
Add reference manual pages for all ctools and csripts
Showing
13 changed files
with
542 additions
and
28 deletions
doc/source/reference_manual/cscaldb.rst
0 → 100644
| 1 | +cscaldb ======= Dumps available instrument response functions. Synopsis -------- This scripts dumps all instrument response functions that are available in the calidation database into a log file. General parameters ------------------ None 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 counts cube 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"). Related tools ------------- None | ||
| 0 | \ No newline at end of file | 2 | \ No newline at end of file |
doc/source/reference_manual/csresmap.rst
0 → 100644
| 1 | +csresmap ======== Generates residual counts map. Synopsis -------- This scripts generates a residual counts map. General parameters ------------------ ``inobs = obs.mlx [file]`` Input event list, cube or observation definition XML file. ``inmodel = crab.xml [file]`` Model XML file. ``outmap = resmap.fits [file]`` Output residual counts map file. ``binfile = binned.fits [file]`` Output binned file name (not used). ``modfile = model.fits [file]`` Output model file name (not used). ``caldb = dummy [string]`` Calibration database. ``irf = cta_dummy_irf [string]`` Response function. ``ebinalg = LOG <FILE|LIN|LOG> [string]`` Algorithm for defining energy bins. ``emin = 0.1 [double]`` Lower energy value for first energy bin (in TeV). ``emax = 100.0 [double]`` Upper energy value for last energy bin (in TeV). ``enumbins =20 [integer]`` Number of energy bins. ``ebinfile = NONE [file]`` Name of the file containing the energy bin definition. ``nxpix = 200 [integer]`` Number of cube bins in Right Ascension or Galactic longitude. ``nypix = 200 [integer]`` Number of cube bins in Declination or Galactic latitude. ``binsz = 0.02 [double]`` Cube bin size (in degrees/pixel). ``coordsys = CEL <CEL|GAL> [string]`` Coordinate system (CEL - celestial, GAL - galactic). ``xref = 83.63 [double]`` Right Ascension / Galactic longitude of cube centre (J2000, in degrees). ``yref = 22.01 [double]`` Declination / Galactic latitude of cube centre (J2000, in degrees). ``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` Projection method. ``algorithm = SUBDIV <SUB|SUBDIV|SUBDIVSQRT> [string]`` Algorithm used to generate the residual map. 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 counts cube 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"). Related tools ------------- None | ||
| 0 | \ No newline at end of file | 2 | \ No newline at end of file |
doc/source/reference_manual/ctbin.rst
| @@ -16,29 +16,25 @@ If an observation definition XML file containing several observations is | @@ -16,29 +16,25 @@ If an observation definition XML file containing several observations is | ||
| 16 | provided on input, the tool will stack all data into a single counts cube. | 16 | provided on input, the tool will stack all data into a single counts cube. |
| 17 | 17 | ||
| 18 | 18 | ||
| 19 | -Links | ||
| 20 | ------ | ||
| 21 | - | ||
| 22 | - | ||
| 23 | General parameters | 19 | General parameters |
| 24 | ------------------ | 20 | ------------------ |
| 25 | 21 | ||
| 26 | -``inobs [file]`` | 22 | +``inobs = events.fits [file]`` |
| 27 | Input event list or observation definition XML file. | 23 | Input event list or observation definition XML file. |
| 28 | 24 | ||
| 29 | -``outcube [file]`` | 25 | +``outcube = cntmap.fits [file]`` |
| 30 | Output counts cube file. | 26 | Output counts cube file. |
| 31 | 27 | ||
| 32 | ``ebinalg = LOG <FILE|LIN|LOG> [string]`` | 28 | ``ebinalg = LOG <FILE|LIN|LOG> [string]`` |
| 33 | Algorithm for defining energy bins. | 29 | Algorithm for defining energy bins. |
| 34 | 30 | ||
| 35 | -``emin [double]`` | 31 | +``emin = 0.1 [double]`` |
| 36 | Lower energy value for first energy bin (in TeV). | 32 | Lower energy value for first energy bin (in TeV). |
| 37 | 33 | ||
| 38 | -``emax [double]`` | 34 | +``emax = 100.0 [double]`` |
| 39 | Upper energy value for last energy bin (in TeV). | 35 | Upper energy value for last energy bin (in TeV). |
| 40 | 36 | ||
| 41 | -``enumbins [integer]`` | 37 | +``enumbins = 20 [integer]`` |
| 42 | Number of energy bins. | 38 | Number of energy bins. |
| 43 | 39 | ||
| 44 | ``ebinfile = NONE [file]`` | 40 | ``ebinfile = NONE [file]`` |
| @@ -47,28 +43,28 @@ General parameters | @@ -47,28 +43,28 @@ General parameters | ||
| 47 | ``(usepnt = no) [boolean]`` | 43 | ``(usepnt = no) [boolean]`` |
| 48 | Use CTA pointing direction for cube centre instead of xref/yref parameters? | 44 | Use CTA pointing direction for cube centre instead of xref/yref parameters? |
| 49 | 45 | ||
| 50 | -``nxpix [integer]`` | ||
| 51 | - Size of the Right Ascension / Galactic longitude axis (in pixels). | ||
| 52 | - | ||
| 53 | -``nypix [integer]`` | ||
| 54 | - Size of the Declination / Galactic latitude axis (in pixels). | 46 | +``nxpix = 200 [integer]`` |
| 47 | + Number of cube bins in Right Ascension or Galactic longitude. | ||
| 55 | 48 | ||
| 56 | -``binsz [double]`` | ||
| 57 | - Pixel size (in degrees/pixel). | 49 | +``nypix = 200 [integer]`` |
| 50 | + Number of cube bins in Declination or Galactic latitude. | ||
| 58 | 51 | ||
| 52 | +``binsz = 0.02 [double]`` | ||
| 53 | + Cube bin size (in degrees/pixel). | ||
| 54 | + | ||
| 59 | ``coordsys = CEL <CEL|GAL> [string]`` | 55 | ``coordsys = CEL <CEL|GAL> [string]`` |
| 60 | Coordinate system (CEL - celestial, GAL - galactic). | 56 | Coordinate system (CEL - celestial, GAL - galactic). |
| 61 | 57 | ||
| 62 | -``xref [double]`` | 58 | +``xref = 83.63 [double]`` |
| 63 | Right Ascension / Galactic longitude of cube centre (J2000, in degrees). | 59 | Right Ascension / Galactic longitude of cube centre (J2000, in degrees). |
| 64 | 60 | ||
| 65 | -``yref [double]`` | 61 | +``yref = 22.01 [double]`` |
| 66 | Declination / Galactic latitude of cube centre (J2000, in degrees). | 62 | Declination / Galactic latitude of cube centre (J2000, in degrees). |
| 67 | 63 | ||
| 68 | ``(axisrot = h) [double]`` | 64 | ``(axisrot = h) [double]`` |
| 69 | Rotation angle of image axes (in degrees). | 65 | Rotation angle of image axes (in degrees). |
| 70 | 66 | ||
| 71 | -``proj = CAR <AIT|AZP|CAR|MER|STG|TAN> [string]`` | 67 | +``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` |
| 72 | Projection method. | 68 | Projection method. |
| 73 | 69 | ||
| 74 | 70 |
doc/source/reference_manual/ctbkgcube.rst
0 → 100644
| 1 | +ctbkgcube | ||
| 2 | +========= | ||
| 3 | + | ||
| 4 | +Generate a background cube for binned maximum likelihood analysis. | ||
| 5 | + | ||
| 6 | + | ||
| 7 | +Synopsis | ||
| 8 | +-------- | ||
| 9 | + | ||
| 10 | +This tool generates a background cube for use in a binned maximum | ||
| 11 | +likelihood analysis. | ||
| 12 | + | ||
| 13 | + | ||
| 14 | +General parameters | ||
| 15 | +------------------ | ||
| 16 | + | ||
| 17 | +``inobs = NONE [file]`` | ||
| 18 | + Input event list, cube or observation definition XML file. | ||
| 19 | + | ||
| 20 | +``inmodel = NONE [file]`` | ||
| 21 | + Input (background) model XML file. | ||
| 22 | + | ||
| 23 | +``incube = NONE [file]`` | ||
| 24 | + Counts cube for background cube definition. | ||
| 25 | + | ||
| 26 | +``outcube = bkgcube.fits [file]`` | ||
| 27 | + Output background cube file. | ||
| 28 | + | ||
| 29 | +``caldb = dummy [string]`` | ||
| 30 | + Calibration database. | ||
| 31 | + | ||
| 32 | +``irf = cta_dummy_irf [string]`` | ||
| 33 | + Response function. | ||
| 34 | + | ||
| 35 | +``ebinalg = LOG <FILE|LIN|LOG> [string]`` | ||
| 36 | + Algorithm for defining energy bins. | ||
| 37 | + | ||
| 38 | +``emin = 0.1 [double]`` | ||
| 39 | + Lower energy value for first energy bin (in TeV). | ||
| 40 | + | ||
| 41 | +``emax = 100.0 [double]`` | ||
| 42 | + Upper energy value for last energy bin (in TeV). | ||
| 43 | + | ||
| 44 | +``enumbins =20 [integer]`` | ||
| 45 | + Number of energy bins. | ||
| 46 | + | ||
| 47 | +``ebinfile = NONE [file]`` | ||
| 48 | + Name of the file containing the energy bin definition. | ||
| 49 | + | ||
| 50 | +``(usepnt = no) [boolean]`` | ||
| 51 | + Use CTA pointing direction for cube centre instead of xref/yref parameters? | ||
| 52 | + | ||
| 53 | +``nxpix = 200 [integer]`` | ||
| 54 | + Number of cube bins in Right Ascension or Galactic longitude. | ||
| 55 | + | ||
| 56 | +``nypix = 200 [integer]`` | ||
| 57 | + Number of cube bins in Declination or Galactic latitude. | ||
| 58 | + | ||
| 59 | +``binsz = 0.02 [double]`` | ||
| 60 | + Cube bin size (in degrees/pixel). | ||
| 61 | + | ||
| 62 | +``coordsys = CEL <CEL|GAL> [string]`` | ||
| 63 | + Coordinate system (CEL - celestial, GAL - galactic). | ||
| 64 | + | ||
| 65 | +``xref = 83.63 [double]`` | ||
| 66 | + Right Ascension / Galactic longitude of cube centre (J2000, in degrees). | ||
| 67 | + | ||
| 68 | +``yref = 22.01 [double]`` | ||
| 69 | + Declination / Galactic latitude of cube centre (J2000, in degrees). | ||
| 70 | + | ||
| 71 | +``(axisrot = h) [double]`` | ||
| 72 | + Rotation angle of image axes (in degrees). | ||
| 73 | + | ||
| 74 | +``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` | ||
| 75 | + Projection method. | ||
| 76 | + | ||
| 77 | + | ||
| 78 | +Standard parameters | ||
| 79 | +------------------- | ||
| 80 | + | ||
| 81 | +``(chatter = 2) [integer]`` | ||
| 82 | + Verbosity of the executable: | ||
| 83 | + chatter = 0: no information will be logged | ||
| 84 | + | ||
| 85 | + chatter = 1: only errors will be logged | ||
| 86 | + | ||
| 87 | + chatter = 2: errors and actions will be logged | ||
| 88 | + | ||
| 89 | + chatter = 3: report about the task execution | ||
| 90 | + | ||
| 91 | + chatter = 4: detailed report about the task execution | ||
| 92 | + | ||
| 93 | +``(clobber = yes) [boolean]`` | ||
| 94 | + Specifies whether an existing output counts cube should be overwritten. | ||
| 95 | + | ||
| 96 | +``(debug = no) [boolean]`` | ||
| 97 | + Enables debug mode. In debug mode the executable will dump any log file output to the console. | ||
| 98 | + | ||
| 99 | +``(mode = ql) [string]`` | ||
| 100 | + Mode of automatic parameters (default is "ql", i.e. "query and learn"). | ||
| 101 | + | ||
| 102 | +``(logfile = ctbkgcube.log) [string]`` | ||
| 103 | + Name of log file. | ||
| 104 | + | ||
| 105 | + | ||
| 106 | +Related tools | ||
| 107 | +------------- | ||
| 108 | + | ||
| 109 | +None |
doc/source/reference_manual/ctcubemask.rst
0 → 100644
| 1 | +ctcubemask | ||
| 2 | +========== | ||
| 3 | + | ||
| 4 | +Filter a counts cube. | ||
| 5 | + | ||
| 6 | + | ||
| 7 | +Synopsis | ||
| 8 | +-------- | ||
| 9 | + | ||
| 10 | +This tool masks out specific regions from a counts cube by setting the | ||
| 11 | +corresponding pixels to negative values. | ||
| 12 | + | ||
| 13 | + | ||
| 14 | +General parameters | ||
| 15 | +------------------ | ||
| 16 | + | ||
| 17 | +``inobs = cntmap.fits [file]`` | ||
| 18 | + Input counts cube or observation definition XML file. | ||
| 19 | + | ||
| 20 | +``regfile = NONE [file]`` | ||
| 21 | + Exclusion region file in ds9 format. | ||
| 22 | + | ||
| 23 | +``outcube = filtered_cube.fits [file]`` | ||
| 24 | + Output counts cube or observation definition XML file. | ||
| 25 | + | ||
| 26 | +``(prefix = filtered_) [string]`` | ||
| 27 | + Prefix for output counts cube files in case that an observation | ||
| 28 | + definition XML file has been specified on input. | ||
| 29 | + | ||
| 30 | +``(usepnt = no) [boolean]`` | ||
| 31 | + Use CTA pointing direction instead of ra/dec parameters? | ||
| 32 | + | ||
| 33 | +``ra = 83.63 [double]`` | ||
| 34 | + Right Ascension of circular selection region centre (J2000, in degrees). | ||
| 35 | + | ||
| 36 | +``dec = 22.01 [double]`` | ||
| 37 | + Declination of circular selection region centre (J2000, in degrees). | ||
| 38 | + | ||
| 39 | +``rad = 3.0 [double]`` | ||
| 40 | + Radius of circular selection region (in degrees). | ||
| 41 | + | ||
| 42 | +``emin = 0.1 [double]`` | ||
| 43 | + Lower energy limit (in TeV). | ||
| 44 | + | ||
| 45 | +``emax = 100.0 [double]`` | ||
| 46 | + Upper energy limit (in TeV). | ||
| 47 | + | ||
| 48 | + | ||
| 49 | +Standard parameters | ||
| 50 | +------------------- | ||
| 51 | + | ||
| 52 | +``(chatter = 2) [integer]`` | ||
| 53 | + Verbosity of the executable: | ||
| 54 | + chatter = 0: no information will be logged | ||
| 55 | + | ||
| 56 | + chatter = 1: only errors will be logged | ||
| 57 | + | ||
| 58 | + chatter = 2: errors and actions will be logged | ||
| 59 | + | ||
| 60 | + chatter = 3: report about the task execution | ||
| 61 | + | ||
| 62 | + chatter = 4: detailed report about the task execution | ||
| 63 | + | ||
| 64 | +``(clobber = yes) [boolean]`` | ||
| 65 | + Specifies whether an existing output counts cube should be overwritten. | ||
| 66 | + | ||
| 67 | +``(debug = no) [boolean]`` | ||
| 68 | + Enables debug mode. In debug mode the executable will dump any log file output to the console. | ||
| 69 | + | ||
| 70 | +``(mode = ql) [string]`` | ||
| 71 | + Mode of automatic parameters (default is "ql", i.e. "query and learn"). | ||
| 72 | + | ||
| 73 | +``(logfile = ctexpcube.log) [string]`` | ||
| 74 | + Name of log file. | ||
| 75 | + | ||
| 76 | + | ||
| 77 | +Related tools | ||
| 78 | +------------- | ||
| 79 | + | ||
| 80 | +None |
doc/source/reference_manual/ctexpcube.rst
0 → 100644
| 1 | +ctexpcube | ||
| 2 | +========= | ||
| 3 | + | ||
| 4 | +Generate an exposure cube for binned maximum likelihood analysis. | ||
| 5 | + | ||
| 6 | + | ||
| 7 | +Synopsis | ||
| 8 | +-------- | ||
| 9 | + | ||
| 10 | +This tool generates an exposure cube for use in a binned maximum likelihood | ||
| 11 | +analysis. | ||
| 12 | + | ||
| 13 | + | ||
| 14 | +General parameters | ||
| 15 | +------------------ | ||
| 16 | + | ||
| 17 | +``inobs = NONE [file]`` | ||
| 18 | + Input event list or observation definition XML file. | ||
| 19 | + | ||
| 20 | +``incube = NONE [file]`` | ||
| 21 | + Counts cube for PSF cube definition. | ||
| 22 | + | ||
| 23 | +``outcube = expcube.fits [file]`` | ||
| 24 | + Output exposure cube file. | ||
| 25 | + | ||
| 26 | +``caldb = dummy [string]`` | ||
| 27 | + Calibration database. | ||
| 28 | + | ||
| 29 | +``irf = cta_dummy_irf [string]`` | ||
| 30 | + Response function. | ||
| 31 | + | ||
| 32 | +``(edisp = no) [boolean]`` | ||
| 33 | + Apply energy dispersion for response computation? | ||
| 34 | + | ||
| 35 | +``ebinalg = LOG <FILE|LIN|LOG> [string]`` | ||
| 36 | + Algorithm for defining energy bins. | ||
| 37 | + | ||
| 38 | +``emin = 0.1 [double]`` | ||
| 39 | + Lower energy value for first energy bin (in TeV). | ||
| 40 | + | ||
| 41 | +``emax = 100.0 [double]`` | ||
| 42 | + Upper energy value for last energy bin (in TeV). | ||
| 43 | + | ||
| 44 | +``enumbins =20 [integer]`` | ||
| 45 | + Number of energy bins. | ||
| 46 | + | ||
| 47 | +``ebinfile = NONE [file]`` | ||
| 48 | + Name of the file containing the energy bin definition. | ||
| 49 | + | ||
| 50 | +``(usepnt = no) [boolean]`` | ||
| 51 | + Use CTA pointing direction for cube centre instead of xref/yref parameters? | ||
| 52 | + | ||
| 53 | +``nxpix = 200 [integer]`` | ||
| 54 | + Number of cube bins in Right Ascension or Galactic longitude. | ||
| 55 | + | ||
| 56 | +``nypix = 200 [integer]`` | ||
| 57 | + Number of cube bins in Declination or Galactic latitude. | ||
| 58 | + | ||
| 59 | +``binsz = 0.02 [double]`` | ||
| 60 | + Cube bin size (in degrees/pixel). | ||
| 61 | + | ||
| 62 | +``coordsys = CEL <CEL|GAL> [string]`` | ||
| 63 | + Coordinate system (CEL - celestial, GAL - galactic). | ||
| 64 | + | ||
| 65 | +``xref = 83.63 [double]`` | ||
| 66 | + Right Ascension / Galactic longitude of cube centre (J2000, in degrees). | ||
| 67 | + | ||
| 68 | +``yref = 22.01 [double]`` | ||
| 69 | + Declination / Galactic latitude of cube centre (J2000, in degrees). | ||
| 70 | + | ||
| 71 | +``(axisrot = 0.0) [double]`` | ||
| 72 | + Rotation angle of image axes (in degrees). | ||
| 73 | + | ||
| 74 | +``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` | ||
| 75 | + Projection method. | ||
| 76 | + | ||
| 77 | + | ||
| 78 | +Standard parameters | ||
| 79 | +------------------- | ||
| 80 | + | ||
| 81 | +``(chatter = 2) [integer]`` | ||
| 82 | + Verbosity of the executable: | ||
| 83 | + chatter = 0: no information will be logged | ||
| 84 | + | ||
| 85 | + chatter = 1: only errors will be logged | ||
| 86 | + | ||
| 87 | + chatter = 2: errors and actions will be logged | ||
| 88 | + | ||
| 89 | + chatter = 3: report about the task execution | ||
| 90 | + | ||
| 91 | + chatter = 4: detailed report about the task execution | ||
| 92 | + | ||
| 93 | +``(clobber = yes) [boolean]`` | ||
| 94 | + Specifies whether an existing output counts cube should be overwritten. | ||
| 95 | + | ||
| 96 | +``(debug = no) [boolean]`` | ||
| 97 | + Enables debug mode. In debug mode the executable will dump any log file output to the console. | ||
| 98 | + | ||
| 99 | +``(mode = ql) [string]`` | ||
| 100 | + Mode of automatic parameters (default is "ql", i.e. "query and learn"). | ||
| 101 | + | ||
| 102 | +``(logfile = ctexpcube.log) [string]`` | ||
| 103 | + Name of log file. | ||
| 104 | + | ||
| 105 | + | ||
| 106 | +Related tools | ||
| 107 | +------------- | ||
| 108 | + | ||
| 109 | +None |
doc/source/reference_manual/ctpsfcube.rst
0 → 100644
| 1 | +ctpsfcube | ||
| 2 | +========= | ||
| 3 | + | ||
| 4 | +Generate a point spread function cube for binned maximum likelihood | ||
| 5 | +analysis. | ||
| 6 | + | ||
| 7 | + | ||
| 8 | +Synopsis | ||
| 9 | +-------- | ||
| 10 | + | ||
| 11 | +This tool generates a point spread function cube for use in a binned | ||
| 12 | +maximum likelihood analysis. | ||
| 13 | + | ||
| 14 | + | ||
| 15 | +General parameters | ||
| 16 | +------------------ | ||
| 17 | + | ||
| 18 | +``inobs = NONE [file]`` | ||
| 19 | + Input event list or observation definition XML file. | ||
| 20 | + | ||
| 21 | +``incube = NONE [file]`` | ||
| 22 | + Counts cube for PSF cube definition. | ||
| 23 | + | ||
| 24 | +``outcube = psfcube.fits [file]`` | ||
| 25 | + Output PSF cube file. | ||
| 26 | + | ||
| 27 | +``caldb = dummy [string]`` | ||
| 28 | + Calibration database. | ||
| 29 | + | ||
| 30 | +``irf = cta_dummy_irf [string]`` | ||
| 31 | + Response function. | ||
| 32 | + | ||
| 33 | +``(edisp = no) [boolean]`` | ||
| 34 | + Apply energy dispersion for response computation. | ||
| 35 | + | ||
| 36 | +``ebinalg = LOG <FILE|LIN|LOG> [string]`` | ||
| 37 | + Algorithm for defining energy bins. | ||
| 38 | + | ||
| 39 | +``emin = 0.1 [double]`` | ||
| 40 | + Lower energy value for first energy bin (in TeV). | ||
| 41 | + | ||
| 42 | +``emax = 100.0 [double]`` | ||
| 43 | + Upper energy value for last energy bin (in TeV). | ||
| 44 | + | ||
| 45 | +``enumbins =20 [integer]`` | ||
| 46 | + Number of energy bins. | ||
| 47 | + | ||
| 48 | +``ebinfile = NONE [file]`` | ||
| 49 | + Name of the file containing the energy bin definition. | ||
| 50 | + | ||
| 51 | +``(usepnt = no) [boolean]`` | ||
| 52 | + Use CTA pointing direction for cube centre instead of xref/yref parameters? | ||
| 53 | + | ||
| 54 | +``nxpix = 200 [integer]`` | ||
| 55 | + Number of cube bins in Right Ascension or Galactic longitude. | ||
| 56 | + | ||
| 57 | +``nypix = 200 [integer]`` | ||
| 58 | + Number of cube bins in Declination or Galactic latitude. | ||
| 59 | + | ||
| 60 | +``binsz = 0.02 [double]`` | ||
| 61 | + Cube bin size (in degrees/pixel). | ||
| 62 | + | ||
| 63 | +``coordsys = CEL <CEL|GAL> [string]`` | ||
| 64 | + Coordinate system (CEL - celestial, GAL - galactic). | ||
| 65 | + | ||
| 66 | +``xref = 83.63 [double]`` | ||
| 67 | + Right Ascension / Galactic longitude of cube centre (J2000, in degrees). | ||
| 68 | + | ||
| 69 | +``yref = 22.01 [double]`` | ||
| 70 | + Declination / Galactic latitude of cube centre (J2000, in degrees). | ||
| 71 | + | ||
| 72 | +``(axisrot = 0.0) [double]`` | ||
| 73 | + Rotation angle of image axes (in degrees). | ||
| 74 | + | ||
| 75 | +``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` | ||
| 76 | + Projection method. | ||
| 77 | + | ||
| 78 | +``(amax = 0.3) [double]`` | ||
| 79 | + Upper bound of angular separation between true and measued photon | ||
| 80 | + direction (in degrees). | ||
| 81 | + | ||
| 82 | +``(anumbins = 200) [integer]`` | ||
| 83 | + Number of angular separation bins. | ||
| 84 | + | ||
| 85 | + | ||
| 86 | +Standard parameters | ||
| 87 | +------------------- | ||
| 88 | + | ||
| 89 | +``(chatter = 2) [integer]`` | ||
| 90 | + Verbosity of the executable: | ||
| 91 | + chatter = 0: no information will be logged | ||
| 92 | + | ||
| 93 | + chatter = 1: only errors will be logged | ||
| 94 | + | ||
| 95 | + chatter = 2: errors and actions will be logged | ||
| 96 | + | ||
| 97 | + chatter = 3: report about the task execution | ||
| 98 | + | ||
| 99 | + chatter = 4: detailed report about the task execution | ||
| 100 | + | ||
| 101 | +``(clobber = yes) [boolean]`` | ||
| 102 | + Specifies whether an existing output counts cube should be overwritten. | ||
| 103 | + | ||
| 104 | +``(debug = no) [boolean]`` | ||
| 105 | + Enables debug mode. In debug mode the executable will dump any log file output to the console. | ||
| 106 | + | ||
| 107 | +``(mode = ql) [string]`` | ||
| 108 | + Mode of automatic parameters (default is "ql", i.e. "query and learn"). | ||
| 109 | + | ||
| 110 | +``(logfile = ctpsfcube.log) [string]`` | ||
| 111 | + Name of log file. | ||
| 112 | + | ||
| 113 | + | ||
| 114 | +Related tools | ||
| 115 | +------------- | ||
| 116 | + | ||
| 117 | +None |
doc/source/reference_manual/cttsmap.rst
0 → 100644
| 1 | +cttsmap | ||
| 2 | +======= | ||
| 3 | + | ||
| 4 | +Generate a Test Statistics map. | ||
| 5 | + | ||
| 6 | + | ||
| 7 | +Synopsis | ||
| 8 | +-------- | ||
| 9 | + | ||
| 10 | +This tool generates a test statistics map. | ||
| 11 | + | ||
| 12 | + | ||
| 13 | +General parameters | ||
| 14 | +------------------ | ||
| 15 | + | ||
| 16 | +``inobs = events [file]`` | ||
| 17 | + Input event list, cube or observation definition XML file. | ||
| 18 | + | ||
| 19 | +``inmodel = $CTOOLS/share/models/crab.xml [file]`` | ||
| 20 | + Input source model XML file. | ||
| 21 | + | ||
| 22 | +``srcname = Crab [string]`` | ||
| 23 | + Name of the source in the source model XML file for which the Test | ||
| 24 | + Statistic map should be computed. | ||
| 25 | + | ||
| 26 | +``incube = NONE [file]`` | ||
| 27 | + Counts cube for background cube definition. | ||
| 28 | + | ||
| 29 | +``caldb = dummy [string]`` | ||
| 30 | + Calibration database. | ||
| 31 | + | ||
| 32 | +``irf = cta_dummy_irf [string]`` | ||
| 33 | + Response function. | ||
| 34 | + | ||
| 35 | +``outmap = tsmap.fits [file]`` | ||
| 36 | + Output Test Statistics map file. | ||
| 37 | + | ||
| 38 | +``(usepnt = no) [boolean]`` | ||
| 39 | + Use CTA pointing direction for map centre instead of xref/yref parameters? | ||
| 40 | + | ||
| 41 | +``nxpix = 200 [integer]`` | ||
| 42 | + Number of map pixels in Right Ascension or Galactic longitude. | ||
| 43 | + | ||
| 44 | +``nypix = 200 [integer]`` | ||
| 45 | + Number of map pixels in Declination or Galactic latitude. | ||
| 46 | + | ||
| 47 | +``binsz = 0.02 [double]`` | ||
| 48 | + Map pixel size (in degrees/pixel). | ||
| 49 | + | ||
| 50 | +``coordsys = CEL <CEL|GAL> [string]`` | ||
| 51 | + Coordinate system (CEL - celestial, GAL - galactic). | ||
| 52 | + | ||
| 53 | +``xref = 83.63 [double]`` | ||
| 54 | + Right Ascension / Galactic longitude of map centre (J2000, in degrees). | ||
| 55 | + | ||
| 56 | +``yref = 22.01 [double]`` | ||
| 57 | + Declination / Galactic latitude of map centre (J2000, in degrees). | ||
| 58 | + | ||
| 59 | +``proj = CAR <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]`` | ||
| 60 | + Projection method. | ||
| 61 | + | ||
| 62 | + | ||
| 63 | +Standard parameters | ||
| 64 | +------------------- | ||
| 65 | + | ||
| 66 | +``(chatter = 2) [integer]`` | ||
| 67 | + Verbosity of the executable: | ||
| 68 | + chatter = 0: no information will be logged | ||
| 69 | + | ||
| 70 | + chatter = 1: only errors will be logged | ||
| 71 | + | ||
| 72 | + chatter = 2: errors and actions will be logged | ||
| 73 | + | ||
| 74 | + chatter = 3: report about the task execution | ||
| 75 | + | ||
| 76 | + chatter = 4: detailed report about the task execution | ||
| 77 | + | ||
| 78 | +``(clobber = yes) [boolean]`` | ||
| 79 | + Specifies whether an existing output counts cube should be overwritten. | ||
| 80 | + | ||
| 81 | +``(debug = no) [boolean]`` | ||
| 82 | + Enables debug mode. In debug mode the executable will dump any log file output to the console. | ||
| 83 | + | ||
| 84 | +``(mode = ql) [string]`` | ||
| 85 | + Mode of automatic parameters (default is "ql", i.e. "query and learn"). | ||
| 86 | + | ||
| 87 | +``(logfile = cttsmap.log) [string]`` | ||
| 88 | + Name of log file. | ||
| 89 | + | ||
| 90 | + | ||
| 91 | +Related tools | ||
| 92 | +------------- | ||
| 93 | + | ||
| 94 | +None |
doc/source/reference_manual/index.rst
| @@ -14,12 +14,17 @@ ctools | @@ -14,12 +14,17 @@ ctools | ||
| 14 | :maxdepth: 1 | 14 | :maxdepth: 1 |
| 15 | 15 | ||
| 16 | ctbin --- Generates counts cube <ctbin> | 16 | ctbin --- Generates counts cube <ctbin> |
| 17 | + ctbkgcube --- Generates background cube <ctbkgcube> | ||
| 17 | ctbutterfly --- Compute butterfly <ctbutterfly> | 18 | ctbutterfly --- Compute butterfly <ctbutterfly> |
| 19 | + ctcubemask --- Filter counts cube <ctcubemask> | ||
| 20 | + ctexpcube --- Generates exposure cube <ctexpcube> | ||
| 18 | ctlike --- Performs maximum likelihood fitting <ctlike> | 21 | ctlike --- Performs maximum likelihood fitting <ctlike> |
| 19 | ctmodel --- Computes model counts cube <ctmodel> | 22 | ctmodel --- Computes model counts cube <ctmodel> |
| 20 | ctobssim --- Simulate CTA observations <ctobssim> | 23 | ctobssim --- Simulate CTA observations <ctobssim> |
| 24 | + ctpsfcube --- Generates point spread function cube <ctpsfcube> | ||
| 21 | ctselect --- Selects event data <ctselect> | 25 | ctselect --- Selects event data <ctselect> |
| 22 | - ctskymap --- Generate sky map <ctskymap> | 26 | + ctskymap --- Generates sky map <ctskymap> |
| 27 | + cttsmap --- Generates Test Statistics map <cttsmap> | ||
| 23 | 28 | ||
| 24 | 29 | ||
| 25 | cscripts | 30 | cscripts |
| @@ -28,6 +33,8 @@ cscripts | @@ -28,6 +33,8 @@ cscripts | ||
| 28 | .. toctree:: | 33 | .. toctree:: |
| 29 | :maxdepth: 1 | 34 | :maxdepth: 1 |
| 30 | 35 | ||
| 31 | - cspull --- Generate pull distribution <cspull> | 36 | + cscaldb --- Lists available instrument response functions <cscaldb> |
| 37 | + cspull --- Generates pull distribution <cspull> | ||
| 32 | cssens --- Computes CTA sensitivity <cssens> | 38 | cssens --- Computes CTA sensitivity <cssens> |
| 33 | - cstsdist --- Generate TS distribution <cstsdist> | 39 | + csresmap --- Generates residual map <csresmap> |
| 40 | + cstsdist --- Generates TS distribution <cstsdist> |
scripts/csresmap.py
| @@ -101,11 +101,11 @@ class csresmap(gammalib.GApplication): | @@ -101,11 +101,11 @@ class csresmap(gammalib.GApplication): | ||
| 101 | # Create default parfile | 101 | # Create default parfile |
| 102 | pars = gammalib.GApplicationPars() | 102 | pars = gammalib.GApplicationPars() |
| 103 | pars.append(gammalib.GApplicationPar("inobs","f","a","obs.xml","","","Observation definition")) | 103 | pars.append(gammalib.GApplicationPar("inobs","f","a","obs.xml","","","Observation definition")) |
| 104 | - pars.append(gammalib.GApplicationPar("inmodel","f","a","crab.xml","","","model file name")) | 104 | + pars.append(gammalib.GApplicationPar("inmodel","f","a","crab.xml","","","Model file name")) |
| 105 | pars.append(gammalib.GApplicationPar("outmap","f","a","resmap.fits","","","Output file name")) | 105 | pars.append(gammalib.GApplicationPar("outmap","f","a","resmap.fits","","","Output file name")) |
| 106 | pars.append(gammalib.GApplicationPar("binfile","f","h","binned.fits","","","Output binned file name")) | 106 | pars.append(gammalib.GApplicationPar("binfile","f","h","binned.fits","","","Output binned file name")) |
| 107 | pars.append(gammalib.GApplicationPar("modfile","f","h","model.fits","","","Output model file name")) | 107 | pars.append(gammalib.GApplicationPar("modfile","f","h","model.fits","","","Output model file name")) |
| 108 | - pars.append(gammalib.GApplicationPar("caldb","s","a","$GAMMALIB/share/caldb/cta","","","Calibration database")) | 108 | + pars.append(gammalib.GApplicationPar("caldb","s","a","dummy","","","Calibration database")) |
| 109 | pars.append(gammalib.GApplicationPar("irf","s","a","cta_dummy_irf","","","Instrument response function")) | 109 | pars.append(gammalib.GApplicationPar("irf","s","a","cta_dummy_irf","","","Instrument response function")) |
| 110 | pars.append(gammalib.GApplicationPar("emin","r","h","0.1","0.0","","Lower energy limit (TeV)")) | 110 | pars.append(gammalib.GApplicationPar("emin","r","h","0.1","0.0","","Lower energy limit (TeV)")) |
| 111 | pars.append(gammalib.GApplicationPar("emax","r","h","100.0","0.0","","Upper energy limit (TeV)")) | 111 | pars.append(gammalib.GApplicationPar("emax","r","h","100.0","0.0","","Upper energy limit (TeV)")) |
src/ctcubemask/ctcubemask.par
| @@ -19,7 +19,7 @@ | @@ -19,7 +19,7 @@ | ||
| 19 | #================= | 19 | #================= |
| 20 | inobs, f, a, "cntmap.fits",,,"Input counts cube or observation definition file" | 20 | inobs, f, a, "cntmap.fits",,,"Input counts cube or observation definition file" |
| 21 | regfile, f, a, "NONE",,,"Exclusion region file in ds9 format" | 21 | regfile, f, a, "NONE",,,"Exclusion region file in ds9 format" |
| 22 | -outcube, f, a, "filtered_cube.fits",,,"Output event cube or observation definition file" | 22 | +outcube, f, a, "filtered_cube.fits",,,"Output counts cube or observation definition file" |
| 23 | prefix, s, h, "filtered_",,,"Prefix for counts cube in observation definition file" | 23 | prefix, s, h, "filtered_",,,"Prefix for counts cube in observation definition file" |
| 24 | # | 24 | # |
| 25 | # Selection parameters | 25 | # Selection parameters |
src/ctexpcube/ctexpcube.par
| @@ -18,7 +18,7 @@ | @@ -18,7 +18,7 @@ | ||
| 18 | # Observational parameters | 18 | # Observational parameters |
| 19 | #=================== | 19 | #=================== |
| 20 | inobs, f, a, "NONE",,, "Event list or observation definition file" | 20 | inobs, f, a, "NONE",,, "Event list or observation definition file" |
| 21 | -incube, f, a, "NONE",,, "Counts map for exposure cube definition" | 21 | +incube, f, a, "NONE",,, "Counts cube for exposure cube definition" |
| 22 | outcube, f, a, "expcube.fits",,, "Output exposure cube file" | 22 | outcube, f, a, "expcube.fits",,, "Output exposure cube file" |
| 23 | caldb, s, a, "dummy",,, "Calibration database" | 23 | caldb, s, a, "dummy",,, "Calibration database" |
| 24 | irf, s, a, "cta_dummy_irf",,, "Instrument response function" | 24 | irf, s, a, "cta_dummy_irf",,, "Instrument response function" |
src/cttsmap/cttsmap.par
| @@ -19,10 +19,10 @@ | @@ -19,10 +19,10 @@ | ||
| 19 | #=================== | 19 | #=================== |
| 20 | inobs, f, a, "events.fits",,, "Input event list, cube or observation definition file" | 20 | inobs, f, a, "events.fits",,, "Input event list, cube or observation definition file" |
| 21 | inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" | 21 | inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model" |
| 22 | -srcname, s, a, "TestSource",,, "Test source" | 22 | +srcname, s, a, "Crab",,, "Test source" |
| 23 | caldb, s, a, "dummy",,, "Calibration database" | 23 | caldb, s, a, "dummy",,, "Calibration database" |
| 24 | irf, s, a, "cta_dummy_irf",,, "Instrument response function" | 24 | irf, s, a, "cta_dummy_irf",,, "Instrument response function" |
| 25 | -outmap, f, a, "tsmap.fits",,, "Output counts cube" | 25 | +outmap, f, a, "tsmap.fits",,, "Output Test Statistics map" |
| 26 | 26 | ||
| 27 | # | 27 | # |
| 28 | # Spatial binning parameters | 28 | # Spatial binning parameters |