Veronika Vodeb / ctools

Commit c65f2ac943105bd49220763672a2e5e8334d0aaf

Authored by Jürgen Knödlseder
1 parent 7c7ef2af

Update ctools reference manual

Inline Side-by-side
Showing 63 changed files with 391 additions and 312 deletions
cscripts/cscaldb.par
  View file @c65f2ac
... ... @@ -18,6 +18,6 @@
18 18 #====================
19 19 chatter, i, h, 2,0,4, "Chattiness of output"
20 20 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
21   -debug, b, h, no,,, "Debugging mode activated"
  21 +debug, b, h, no,,, "Activate debugging mode?"
22 22 mode, s, h, ql,,, "Mode of automatic parameters"
23 23 logfile, f, h, cscaldb.log,,, "Log filename"
... ...
cscripts/csebins.par
  View file @c65f2ac
... ... @@ -34,6 +34,6 @@ bkgthres, r, h, 0.5,,, "Fractional background rate change threshold"
34 34 #====================
35 35 chatter, i, h, 2,0,4, "Chattiness of output"
36 36 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
37   -debug, b, h, no,,, "Debugging mode activated"
  37 +debug, b, h, no,,, "Activate debugging mode?"
38 38 mode, s, h, ql,,, "Mode of automatic parameters"
39 39 logfile, f, h, csebins.log,,, "Log filename"
... ...
cscripts/csfindobs.par
  View file @c65f2ac
... ... @@ -35,7 +35,7 @@ master_indx, s, h, master.json,,, "Name of master index file"
35 35 #====================
36 36 chatter, i, h, 2,0,4, "Chattiness of output"
37 37 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
38   -debug, b, h, no,,, "Debugging mode activated"
  38 +debug, b, h, no,,, "Activate debugging mode?"
39 39 mode, s, h, ql,,, "Mode of automatic parameters"
40 40 logfile, f, h, csfindobs.log,,, "Log filename"
41 41  
... ...
cscripts/csiactcopy.par
  View file @c65f2ac
... ... @@ -26,6 +26,6 @@ outpath, s, a, /path/to/fits,,, "Destination path of FITS data"
26 26 #====================
27 27 chatter, i, h, 2,0,4, "Chattiness of output"
28 28 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
29   -debug, b, h, no,,, "Debugging mode activated"
  29 +debug, b, h, no,,, "Activate debugging mode?"
30 30 mode, s, h, ql,,, "Mode of automatic parameters"
31 31 logfile, f, h, csiactcopy.log,,, "Log filename"
... ...
cscripts/csiactdata.par
  View file @c65f2ac
... ... @@ -24,7 +24,7 @@ master_indx, s, h, master.json,,, "Name of master index file"
24 24 #====================
25 25 chatter, i, h, 2,0,4, "Chattiness of output"
26 26 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
27   -debug, b, h, no,,, "Debugging mode activated"
  27 +debug, b, h, no,,, "Activate debugging mode?"
28 28 mode, s, h, ql,,, "Mode of automatic parameters"
29 29 logfile, f, h, csiactdata.log,,, "Log filename"
30 30  
... ...
cscripts/csiactobs.par
  View file @c65f2ac
... ... @@ -47,7 +47,7 @@ bkg_range_factor, r, h, 100.0,,, "Factor to determine range of background normal
47 47 #====================
48 48 chatter, i, h, 2,0,4, "Chattiness of output"
49 49 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
50   -debug, b, h, no,,, "Debugging mode activated"
  50 +debug, b, h, no,,, "Activate debugging mode?"
51 51 mode, s, h, ql,,, "Mode of automatic parameters"
52 52 logfile, f, h, csiactobs.log,,, "Log filename"
53 53  
... ...
cscripts/cslightcrv.par
  View file @c65f2ac
... ... @@ -64,7 +64,7 @@ fix_bkg, b, h, no,,, "Fix background model parameters?"
64 64 publish, b, h, no,,, "Publish light curve on VO Hub?"
65 65 chatter, i, h, 2,0,4, "Chattiness of output"
66 66 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
67   -debug, b, h, no,,, "Debugging mode activated"
  67 +debug, b, h, no,,, "Activate debugging mode?"
68 68 mode, s, h, ql,,, "Mode of automatic parameters"
69 69 logfile, f, h, cslightcrv.log,,, "Log filename"
70 70  
... ...
cscripts/csmodelinfo.par
  View file @c65f2ac
... ... @@ -39,6 +39,6 @@ fixed_color, s, h, magenta,,, "Color for source without free parameters (any D
39 39 #====================
40 40 chatter, i, h, 2,0,4, "Chattiness of output"
41 41 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
42   -debug, b, h, no,,, "Debugging mode activated"
  42 +debug, b, h, no,,, "Activate debugging mode?"
43 43 mode, s, h, ql,,, "Mode of automatic parameters"
44 44 logfile, f, h, csmodelinfo.log,,, "Log filename"
... ...
cscripts/csmodelmerge.par
  View file @c65f2ac
... ... @@ -24,6 +24,6 @@ outmodel, f, a, NONE,,, "Output model definition XML file"
24 24 #====================
25 25 chatter, i, h, 2,0,4, "Chattiness of output"
26 26 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
27   -debug, b, h, no,,, "Debugging mode activated"
  27 +debug, b, h, no,,, "Activate debugging mode?"
28 28 mode, s, h, ql,,, "Mode of automatic parameters"
29 29 logfile, f, h, csmodelmerge.log,,, "Log filename"
... ...
cscripts/csmodelselect.par
  View file @c65f2ac
... ... @@ -36,6 +36,6 @@ fit_shape, b, h, no,,, "Fit source shapes?"
36 36 #====================
37 37 chatter, i, h, 2,0,4, "Chattiness of output"
38 38 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
39   -debug, b, h, no,,, "Debugging mode activated"
  39 +debug, b, h, no,,, "Activate debugging mode?"
40 40 mode, s, h, ql,,, "Mode of automatic parameters"
41 41 logfile, f, h, csmodelselect.log,,, "Log filename"
... ...
cscripts/csmodelsois.par
  View file @c65f2ac
... ... @@ -50,6 +50,6 @@ glat, r, a, -5.80,-90,90, "Galactic latitude of image center (in degrees)"
50 50 publish, b, h, no,,, "Publish map cube on VO Hub?"
51 51 chatter, i, h, 2,0,4, "Chattiness of output"
52 52 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
53   -debug, b, h, no,,, "Debugging mode activated"
54   -mode, s, h, "ql",,, "Mode of automatic parameters"
55   -logfile, f, h, "csmodelsois.log",,, "Log filename"
  53 +debug, b, h, no,,, "Activate debugging mode?"
  54 +mode, s, h, ql,,, "Mode of automatic parameters"
  55 +logfile, f, h, csmodelsois.log,,, "Log filename"
... ...
cscripts/csobs2caldb.par
  View file @c65f2ac
... ... @@ -28,6 +28,6 @@ index, i, h, 0,,, "Index of observation to be used from XML file"
28 28 #====================
29 29 chatter, i, h, 2,0,4, "Chattiness of output"
30 30 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
31   -debug, b, h, no,,, "Debugging mode activated"
  31 +debug, b, h, no,,, "Activate debugging mode?"
32 32 mode, s, h, ql,,, "Mode of automatic parameters"
33 33 logfile, f, h, csobs2caldb.log,,, "Log filename"
... ...
cscripts/csobsdef.par
  View file @c65f2ac
... ... @@ -36,6 +36,6 @@ deadc, r, h, 0.98,,, "Deadtime correction factor"
36 36 #====================
37 37 chatter, i, h, 2,0,4, "Chattiness of output"
38 38 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
39   -debug, b, h, no,,, "Debugging mode activated"
  39 +debug, b, h, no,,, "Activate debugging mode?"
40 40 mode, s, h, ql,,, "Mode of automatic parameters"
41 41 logfile, f, h, csobsdef.log,,, "Log filename"
... ...
cscripts/csobsinfo.par
  View file @c65f2ac
... ... @@ -31,6 +31,6 @@ dec, r, a, 0.0,,, "Target Declination (deg)")
31 31 #====================
32 32 chatter, i, h, 2,0,4, "Chattiness of output"
33 33 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
34   -debug, b, h, no,,, "Debugging mode activated"
  34 +debug, b, h, no,,, "Activate debugging mode?"
35 35 mode, s, h, ql,,, "Mode of automatic parameters"
36 36 logfile, f, h, csobsinfo.log,,, "Log filename"
... ...
cscripts/csobsselect.par
  View file @c65f2ac
... ... @@ -37,6 +37,6 @@ height, r, a, 10.0,0,180, "Height of selection box (deg)"
37 37 #====================
38 38 chatter, i, h, 2,0,4, "Chattiness of output"
39 39 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
40   -debug, b, h, no,,, "Debugging mode activated"
  40 +debug, b, h, no,,, "Activate debugging mode?"
41 41 mode, s, h, ql,,, "Mode of automatic parameters"
42 42 logfile, f, h, csobsselect.log,,, "Log filename"
... ...
cscripts/csphagen.par
  View file @c65f2ac
... ... @@ -26,10 +26,10 @@ prefix, s, h, onoff,,, "Prefix for output files"
26 26 #
27 27 # Script parameters
28 28 #==================
29   -emin, r, a, 0.1,,, "Lower energy limit (TeV)"
30   -emax, r, a, 100.0,,, "Upper energy limit (TeV)"
  29 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
  30 +emin, r, a, 0.1,,, "Start value for first energy bin in TeV"
  31 +emax, r, a, 100.0,,, "Stop value for last energy bin in TeV"
31 32 enumbins, i, a, 120,,, "Number of energy bins"
32   -ebinalg, s, a, LOG,LIN|LOG|FILE,, "Binning algorithm"
33 33 ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
34 34 srcshape, s, h, CIRCLE,CIRCLE,, "Shape of the source region"
35 35 coordsys, s, a, CEL,CEL|GAL,, "Coordinate system (CEL - celestial, GAL - galactic)"
... ... @@ -53,6 +53,6 @@ etruebins, i, h, 30,,, "Number of bins per decade for true energy bins"
53 53 #====================
54 54 chatter, i, h, 2,0,4, "Chattiness of output"
55 55 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
56   -debug, b, h, no,,, "Debugging mode activated"
  56 +debug, b, h, no,,, "Activate debugging mode?"
57 57 mode, s, h, ql,,, "Mode of automatic parameters"
58 58 logfile, f, h, csphagen.log,,, "Log filename"
... ...
cscripts/csphasecrv.par
  View file @c65f2ac
... ... @@ -58,7 +58,7 @@ statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
58 58 publish, b, h, no,,, "Publish phase curve on VO Hub?"
59 59 chatter, i, h, 2,0,4, "Chattiness of output"
60 60 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
61   -debug, b, h, no,,, "Debugging mode activated"
  61 +debug, b, h, no,,, "Activate debugging mode?"
62 62 mode, s, h, ql,,, "Mode of automatic parameters"
63 63 logfile, f, h, csphasecrv.log,,, "Log filename"
64 64  
... ...
cscripts/cspull.par
  View file @c65f2ac
... ... @@ -51,6 +51,6 @@ seed, i, h, 1,,, "Initial random number generator seed"
51 51 #====================
52 52 chatter, i, h, 2,0,4, "Chattiness of output"
53 53 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
54   -debug, b, h, no,,, "Debugging mode activated"
  54 +debug, b, h, no,,, "Activate debugging mode?"
55 55 mode, s, h, ql,,, "Mode of automatic parameters"
56 56 logfile, f, h, cspull.log,,, "Log filename"
... ...
cscripts/csresmap.par
  View file @c65f2ac
... ... @@ -31,7 +31,7 @@ outmap, f, a, resmap.fits,,, "Output residual map file"
31 31 #
32 32 # Script parameters
33 33 #==================
34   -ebinalg, s, h, LOG,LIN|LOG|FILE,, "Binning algorithm"
  34 +ebinalg, s, h, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
35 35 emin, r, a, 0.1,,, "Lower energy limit (TeV)"
36 36 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
37 37 enumbins, i, h, 20,,, "Number of model cube energy bins"
... ... @@ -51,6 +51,6 @@ algorithm, s, a, SIGNIFICANCE,SUB|SUBDIV|SUBDIVSQRT|SIGNIFICANCE,, "Residual map
51 51 publish, b, h, no,,, "Publish residual map on VO Hub?"
52 52 chatter, i, h, 2,0,4, "Chattiness of output"
53 53 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
54   -debug, b, h, no,,, "Debugging mode activated"
  54 +debug, b, h, no,,, "Activate debugging mode?"
55 55 mode, s, h, ql,,, "Mode of automatic parameters"
56 56 logfile, f, h, csresmap.log,,, "Log filename"
... ...
cscripts/csresspec.par
  View file @c65f2ac
... ... @@ -34,9 +34,9 @@ outfile, f, a, resspec.fits,,, "Output residual spectrum file"
34 34 statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
35 35 components,b, h, no,,, "Calculate model for individual components?"
36 36 ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
37   -emin, r, a, 0.1,,, "Lower energy limit (TeV)"
38   -emax, r, a, 100.0,,, "Upper energy limit (TeV)"
39   -enumbins, i, a, 20,,, "Number of model cube energy bins"
  37 +emin, r, a, 0.1,,, "Start value for first energy bin in TeV"
  38 +emax, r, a, 100.0,,, "Stop value for last energy bin in TeV"
  39 +enumbins, i, a, 20,1,200, "Number of energy bins"
40 40 ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
41 41 stack, b, a, no,,, "Stack observations?"
42 42 coordsys, s, a, CEL,CEL|GAL,, "Coordinate System"
... ... @@ -59,6 +59,6 @@ algorithm, s, a, SIGNIFICANCE,SUB|SUBDIV|SUBDIVSQRT|SIGNIFICANCE,, "Residuals co
59 59 publish, b, h, no,,, "Publish residual map on VO Hub?"
60 60 chatter, i, h, 2,0,4, "Chattiness of output"
61 61 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
62   -debug, b, h, no,,, "Debugging mode activated"
  62 +debug, b, h, no,,, "Activate debugging mode?"
63 63 mode, s, h, ql,,, "Mode of automatic parameters"
64 64 logfile, f, h, csresspec.log,,, "Log filename"
... ...
cscripts/csroot2caldb.par
  View file @c65f2ac
... ... @@ -41,6 +41,6 @@ bgdinfill, b, h, no,,, "Infill of background template?"
41 41 #====================
42 42 chatter, i, h, 2,0,4, "Chattiness of output"
43 43 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
44   -debug, b, h, no,,, "Debugging mode activated"
  44 +debug, b, h, no,,, "Activate debugging mode?"
45 45 mode, s, h, ql,,, "Mode of automatic parameters"
46 46 logfile, f, h, csroot2caldb.log,,, "Log filename"
... ...
cscripts/cssens.par
  View file @c65f2ac
... ... @@ -33,7 +33,7 @@ duration, r, a, 180000.0,,, "Effective exposure time (s)"
33 33 rad, r, a, 5.0,,, "Radius of ROI (deg)"
34 34 emin, r, a, 0.03163,,, "Lower energy limit (TeV)"
35 35 emax, r, a, 125.8925,,, "Upper energy limit (TeV)"
36   -bins, i, a, 18,,, "Number of energy bins for differential sensitivity computation"
  36 +bins, i, a, 18,,, "Number of energy bins for sensitivity computation"
37 37 enumbins, i, h, 0,,, "Number of energy bins for binned analysis (0=unbinned)"
38 38 npix, i, h, 200,,, "Number of pixels for binned analysis"
39 39 binsz, r, h, 0.05,,, "Pixel size for binned analysis (deg/pixel)"
... ... @@ -47,7 +47,7 @@ statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
47 47 #====================
48 48 chatter, i, h, 2,0,4, "Chattiness of output"
49 49 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
50   -debug, b, h, no,,, "Debugging mode activated"
  50 +debug, b, h, no,,, "Activate debugging mode?"
51 51 mode, s, h, ql,,, "Mode of automatic parameters"
52 52 logfile, f, h, cssens.log,,, "Log filename"
53 53  
... ...
cscripts/csspec.par
  View file @c65f2ac
... ... @@ -32,10 +32,10 @@ outfile, f, a, spectrum.fits,,, "Output spectrum file"
32 32 # Script parameters
33 33 #==================
34 34 method, s, a, AUTO,SLICE|NODES|AUTO,, "Spectrum generation method"
35   -emin, r, a, 0.1,,, "Lower energy limit (TeV)"
36   -emax, r, a, 100.0,,, "Upper energy limit (TeV)"
37   -enumbins, i, a, 20,,, "Number of energy bins"
38   -ebinalg, s, a, LOG,LIN|LOG|FILE,, "Binning algorithm"
  35 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
  36 +emin, r, a, 0.1,,, "Start value for first energy bin in TeV"
  37 +emax, r, a, 100.0,,, "Stop value for last energy bin in TeV"
  38 +enumbins, i, a, 20,1,200, "Number of energy bins"
39 39 ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
40 40 statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
41 41 calc_ts, b, h, yes,,, "Compute TS value in each bin"
... ... @@ -49,6 +49,6 @@ fix_bkg, b, h, no,,, "Fix background parameters"
49 49 publish, b, h, no,,, "Publish spectrum on VO Hub?"
50 50 chatter, i, h, 2,0,4, "Chattiness of output"
51 51 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
52   -debug, b, h, no,,, "Debugging mode activated"
  52 +debug, b, h, no,,, "Activate debugging mode?"
53 53 mode, s, h, ql,,, "Mode of automatic parameters"
54 54 logfile, f, h, csspec.log,,, "Log filename"
... ...
cscripts/cssrcdetect.par
  View file @c65f2ac
... ... @@ -36,6 +36,6 @@ fit_shape, b, h, yes,,, "Fit source shapes?"
36 36 #====================
37 37 chatter, i, h, 2,0,4, "Chattiness of output"
38 38 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
39   -debug, b, h, no,,, "Debugging mode activated"
  39 +debug, b, h, no,,, "Activate debugging mode?"
40 40 mode, s, h, ql,,, "Mode of automatic parameters"
41 41 logfile, f, h, cssrcdetect.log,,, "Log filename"
... ...
cscripts/cstsdist.par
  View file @c65f2ac
... ... @@ -40,6 +40,6 @@ statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
40 40 #====================
41 41 chatter, i, h, 2,0,4, "Chattiness of output"
42 42 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
43   -debug, b, h, no,,, "Debugging mode activated"
  43 +debug, b, h, no,,, "Activate debugging mode?"
44 44 mode, s, h, ql,,, "Mode of automatic parameters"
45 45 logfile, f, h, cstsdist.log,,, "Log filename"
... ...
cscripts/cstsmapmerge.par
  View file @c65f2ac
... ... @@ -30,7 +30,7 @@ delete, b, h, no,,, "Delete merged files?"
30 30 #====================
31 31 chatter, i, h, 2,0,4, "Chattiness of output"
32 32 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
33   -debug, b, h, no,,, "Debugging mode activated"
  33 +debug, b, h, no,,, "Activate debugging mode?"
34 34 mode, s, h, ql,,, "Mode of automatic parameters"
35 35 logfile, f, h, cstsmapmerge.log,,, "Log filename"
36 36  
... ...
cscripts/cstsmapsplit.par
  View file @c65f2ac
... ... @@ -52,6 +52,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DE
52 52 publish, b, h, no,,, "Publish Test Statistic map on VO Hub?"
53 53 chatter, i, h, 2,0,4, "Chattiness of output"
54 54 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
55   -debug, b, h, no,,, "Debugging mode activated"
  55 +debug, b, h, no,,, "Activate debugging mode?"
56 56 mode, s, h, ql,,, "Mode of automatic parameters"
57 57 logfile, f, h, cstsmapsplit.log,,, "Log filename"
... ...
cscripts/csviscube.par
  View file @c65f2ac
... ... @@ -37,6 +37,6 @@ zmax, r, h, 60.0,,, "Maximum zenith angle (deg)"
37 37 publish, b, h, no,,, "Publish visibility cube on VO Hub?"
38 38 chatter, i, h, 2,0,4, "Chattiness of output"
39 39 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
40   -debug, b, h, no,,, "Debugging mode activated"
  40 +debug, b, h, no,,, "Activate debugging mode?"
41 41 mode, s, h, ql,,, "Mode of automatic parameters"
42 42 logfile, f, h, csviscube.log,,, "Log filename"
... ...
cscripts/csworkflow.par
  View file @c65f2ac
... ... @@ -23,6 +23,6 @@ inflow, f, a, workflow.xml,,, "Input workflow XML file"
23 23 #====================
24 24 chatter, i, h, 2,0,4, "Chattiness of output"
25 25 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
26   -debug, b, h, no,,, "Debugging mode activated"
  26 +debug, b, h, no,,, "Activate debugging mode?"
27 27 mode, s, h, ql,,, "Mode of automatic parameters"
28 28 logfile, f, h, csworkflow.log,,, "Log filename"
... ...
doc/source/users/reference_manual/csmodelsois.rst
  View file @c65f2ac
... ... @@ -47,7 +47,10 @@ General parameters
47 47 Output model XML file (not generated if set to ``NONE``).
48 48  
49 49 ``ebinalg <FILE|LIN|LOG> [string]``
50   - Algorithm for defining energy bins.
  50 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  51 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  52 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  53 + logarithmically between ``emin`` and ``emax``, respectively.
51 54  
52 55 ``emin [real]``
53 56 Lower energy value for first energy bin (in TeV).
... ... @@ -59,7 +62,8 @@ General parameters
59 62 Number of energy bins.
60 63  
61 64 ``ebinfile [file]``
62   - Name of the file containing the energy bin definition.
  65 + Name of the file containing the energy bin definition. You may use :ref:`csebins`
  66 + to generate a file with appropriate energy bins.
63 67  
64 68 ``nxpix [integer]``
65 69 Number of map cube bins in Right Ascension or Galactic longitude.
... ...
doc/source/users/reference_manual/csphagen.rst
  View file @c65f2ac
... ... @@ -48,24 +48,28 @@ General parameters
48 48 ``(prefix = onoff) [string]``
49 49 Prefix of the file name for output PHA, ARF, RMF, XML, and DS9 region files.
50 50  
  51 +``ebinalg <FILE|LIN|LOG> [string]``
  52 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  53 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  54 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  55 + logarithmically between ``emin`` and ``emax``, respectively.
  56 +
51 57 ``emin [real]``
52   - Lower energy limit (TeV) if ``LIN`` or ``LOG`` binning algorithms are used.
  58 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  59 + energy binning algorithms are used.
53 60  
54 61 ``emax [real]``
55   - Upper energy limit (TeV) if ``LIN`` or ``LOG`` binning algorithms are used.
  62 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  63 + energy binning algorithms are used.
56 64  
57 65 ``enumbins [integer]``
58   - Number of energy bins. At least 30 bins per decade are recommended for
59   - proper evaluation of the instrument response.
60   -
61   -``ebinalg <FILE|LIN|LOG> [string]``
62   - Algorithm for defining energy bins (``FILE``: energy bounds retrieved from
63   - file, see ``ebinfile`` parameter; ``LIN``: linearly spaced energy bins;
64   - ``LOG``: logarithmically spaced energy bins).
  66 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are used.
  67 + At least 30 bins per decade are recommended for proper evaluation of the
  68 + instrument response.
65 69  
66 70 ``ebinfile [file]``
67   - Name of the file containing the energy bin definition if ``FILE`` algorithm
68   - is used.
  71 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  72 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
69 73  
70 74 ``(srcshape = CIRCLE) <CIRCLE> [string]``
71 75 Shape of the source region (``CIRCLE``: circular region around given position).
... ...
doc/source/users/reference_manual/csresmap.rst
  View file @c65f2ac
... ... @@ -63,19 +63,20 @@ General parameters
63 63 Output residual counts map file.
64 64  
65 65 ``(ebinalg = LOG) <FILE|LIN|LOG> [string]``
66   - Algorithm for defining energy bins.
  66 + Algorithm for defining energy bins for internal residual map computation.
67 67  
68 68 ``emin [real]``
69   - Lower energy value for first energy bin (in TeV).
  69 + Lower energy value for residual map (in TeV).
70 70  
71 71 ``emax [real]``
72   - Upper energy value for last energy bin (in TeV).
  72 + Upper energy value for residual map (in TeV).
73 73  
74 74 ``(enumbins = 20) [integer]``
75   - Number of model cube energy bins.
  75 + Number of model cube energy bins for internal residual map computation.
76 76  
77 77 ``ebinfile [file]``
78   - Name of the file containing the energy bin definition.
  78 + Name of the file containing the energy bin definition for internal residual
  79 + map computation.
79 80  
80 81 ``coordsys <CEL|GAL> [string]``
81 82 Coordinate system (CEL - celestial, GAL - galactic).
... ...
doc/source/users/reference_manual/csresspec.rst
  View file @c65f2ac
... ... @@ -88,19 +88,26 @@ General parameters
88 88 Calculate model for individual components?
89 89  
90 90 ``ebinalg <FILE|LIN|LOG> [string]``
91   - Algorithm for defining energy bins.
  91 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  92 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  93 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  94 + logarithmically between ``emin`` and ``emax``, respectively.
92 95  
93 96 ``emin [real]``
94   - Lower energy value for first energy bin (in TeV).
  97 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  98 + energy binning algorithms are used.
95 99  
96 100 ``emax [real]``
97   - Upper energy value for last energy bin (in TeV).
  101 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  102 + energy binning algorithms are used.
98 103  
99 104 ``enumbins [integer]``
100   - Number of energy bins.
  105 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  106 + used.
101 107  
102 108 ``ebinfile [file]``
103   - Name of the file containing the energy bin definition.
  109 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  110 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
104 111  
105 112 ``stack [boolean]``
106 113 Stack multiple observations for residual calculation?
... ...
doc/source/users/reference_manual/cssens.rst
  View file @c65f2ac
... ... @@ -83,7 +83,7 @@ General parameters
83 83 Number of energy bins for sensitivity computation.
84 84  
85 85 ``(enumbins = 0) [integer]``
86   - Number of energy bins (0=unbinned).
  86 + Number of energy bins for binned analysis (``0`` = unbinned analysis).
87 87  
88 88 ``(npix = 200) [integer]``
89 89 Number of pixels for binned analysis.
... ...
doc/source/users/reference_manual/csspec.rst
  View file @c65f2ac
... ... @@ -98,20 +98,27 @@ General parameters
98 98 data. For CTA-only observations ``SLICE`` will be used, otherwise ``NODES``
99 99 will be used.
100 100  
  101 +``ebinalg <FILE|LIN|LOG> [string]``
  102 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  103 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  104 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  105 + logarithmically between ``emin`` and ``emax``, respectively.
  106 +
101 107 ``emin [real]``
102   - Lower energy limit of events (in TeV).
  108 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  109 + energy binning algorithms are used.
103 110  
104 111 ``emax [real]``
105   - Upper energy limit of events (in TeV).
  112 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  113 + energy binning algorithms are used.
106 114  
107 115 ``enumbins [integer]``
108   - Number of energy bins.
109   -
110   -``ebinalg <FILE|LIN|LOG> [string]``
111   - Algorithm for defining energy bins.
  116 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  117 + used.
112 118  
113 119 ``ebinfile [file]``
114   - Name of the file containing the energy bin definition.
  120 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  121 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
115 122  
116 123 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]``
117 124 Optimization statistic. ``DEFAULT`` uses the default statistic for all
... ...
doc/source/users/reference_manual/ctbin.rst
  View file @c65f2ac
... ... @@ -18,7 +18,7 @@ specified in an observation definition file. In case that multiple event
18 18 lists are given in an observation definition file, the tool will loop over
19 19 all event lists and fill all events into a single counts cube.
20 20  
21   -ctbin generates a counts cube FITS file comprising three extensions. The
  21 +:ref:`ctbin` generates a counts cube FITS file comprising three extensions. The
22 22 primary extension contains a 3-dimensional image that contains the counts
23 23 cube values. The next extension named ``EBOUNDS`` contains a binary table
24 24 that defines the energy boundaries of the counts cube. The last extension
... ... @@ -36,19 +36,26 @@ General parameters
36 36 Output counts cube file.
37 37  
38 38 ``ebinalg <FILE|LIN|LOG> [string]``
39   - Algorithm for defining energy bins.
  39 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  40 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  41 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  42 + logarithmically between ``emin`` and ``emax``, respectively.
40 43  
41 44 ``emin [real]``
42   - Lower energy value for first energy bin (in TeV).
  45 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  46 + energy binning algorithms are used.
43 47  
44 48 ``emax [real]``
45   - Upper energy value for last energy bin (in TeV).
  49 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  50 + energy binning algorithms are used.
46 51  
47 52 ``enumbins [integer]``
48   - Number of energy bins.
  53 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  54 + used.
49 55  
50 56 ``ebinfile [file]``
51   - Name of the file containing the energy bin definition.
  57 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  58 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
52 59  
53 60 ``(usepnt = no) [boolean]``
54 61 Use CTA pointing direction for cube centre instead of xref/yref parameters?
... ...
doc/source/users/reference_manual/ctbkgcube.rst
  View file @c65f2ac
... ... @@ -72,19 +72,26 @@ General parameters
72 72 Output model XML file.
73 73  
74 74 ``ebinalg <FILE|LIN|LOG> [string]``
75   - Algorithm for defining energy bins.
  75 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  76 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  77 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  78 + logarithmically between ``emin`` and ``emax``, respectively.
76 79  
77 80 ``emin [real]``
78   - Lower energy value for first energy bin (in TeV).
  81 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  82 + energy binning algorithms are used.
79 83  
80 84 ``emax [real]``
81   - Upper energy value for last energy bin (in TeV).
  85 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  86 + energy binning algorithms are used.
82 87  
83 88 ``enumbins [integer]``
84   - Number of energy bins.
  89 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  90 + used.
85 91  
86 92 ``ebinfile [file]``
87   - Name of the file containing the energy bin definition.
  93 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  94 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
88 95  
89 96 ``(addbounds = no) [boolean]``
90 97 Add energies to the background cube at the observation energy boundaries?
... ...
doc/source/users/reference_manual/ctbutterfly.rst
  View file @c65f2ac
... ... @@ -97,20 +97,27 @@ General parameters
97 97 ``(matrix = "NONE") [file]``
98 98 Input covariance matrix file (not used)
99 99  
100   -``(ebinalg = "LOG") <FILE|LIN|LOG> [string]``
101   - Butterfly energy binning algorithm.
  100 +``(ebinalg = LOG) <FILE|LIN|LOG> [string]``
  101 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  102 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  103 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  104 + logarithmically between ``emin`` and ``emax``, respectively.
102 105  
103 106 ``emin [real]``
104   - Minimum energy of butterfly (in TeV).
  107 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  108 + energy binning algorithms are used.
105 109  
106 110 ``emax [real]``
107   - Maximum energy of butterfly (in TeV).
  111 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  112 + energy binning algorithms are used.
108 113  
109   -``(enumbins = 100) [string]``
110   - Number of energy bins of butterfly.
  114 +``(enumbins = 100) [integer]``
  115 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  116 + used.
111 117  
112   -``(ebinfile = "NONE") [string]``
113   - File for energy binning algorithm.
  118 +``ebinfile [file]``
  119 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  120 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
114 121  
115 122  
116 123 Standard parameters
... ...
doc/source/users/reference_manual/ctedispcube.rst
  View file @c65f2ac
... ... @@ -56,19 +56,26 @@ General parameters
56 56 Output energy dispersion cube file.
57 57  
58 58 ``ebinalg <FILE|LIN|LOG> [string]``
59   - Algorithm for defining energy bins.
  59 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  60 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  61 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  62 + logarithmically between ``emin`` and ``emax``, respectively.
60 63  
61 64 ``emin [real]``
62   - Lower energy value for first energy bin (in TeV).
  65 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  66 + energy binning algorithms are used.
63 67  
64 68 ``emax [real]``
65   - Upper energy value for last energy bin (in TeV).
  69 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  70 + energy binning algorithms are used.
66 71  
67 72 ``enumbins [integer]``
68   - Number of energy bins.
  73 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  74 + used.
69 75  
70 76 ``ebinfile [file]``
71   - Name of the file containing the energy bin definition.
  77 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  78 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
72 79  
73 80 ``(addbounds = no) [boolean]``
74 81 Add energies to the energy dispersion cube at the observation energy boundaries?
... ...
doc/source/users/reference_manual/ctexpcube.rst
  View file @c65f2ac
... ... @@ -63,19 +63,26 @@ General parameters
63 63 Output exposure cube file.
64 64  
65 65 ``ebinalg <FILE|LIN|LOG> [string]``
66   - Algorithm for defining energy bins.
  66 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  67 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  68 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  69 + logarithmically between ``emin`` and ``emax``, respectively.
67 70  
68 71 ``emin [real]``
69   - Lower energy value for first energy bin (in TeV).
  72 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  73 + energy binning algorithms are used.
70 74  
71 75 ``emax [real]``
72   - Upper energy value for last energy bin (in TeV).
  76 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  77 + energy binning algorithms are used.
73 78  
74 79 ``enumbins [integer]``
75   - Number of energy bins.
  80 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  81 + used.
76 82  
77 83 ``ebinfile [file]``
78   - Name of the file containing the energy bin definition.
  84 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  85 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
79 86  
80 87 ``(addbounds = no) [boolean]``
81 88 Add energies to the exposure cube at the observation energy boundaries?
... ...
doc/source/users/reference_manual/ctmapcube.rst
  View file @c65f2ac
... ... @@ -35,19 +35,26 @@ General parameters
35 35 Sigma of Gaussian to be used for point sources (in arcmin).
36 36  
37 37 ``ebinalg <FILE|LIN|LOG> [string]``
38   - Algorithm for defining energy bins.
  38 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  39 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  40 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  41 + logarithmically between ``emin`` and ``emax``, respectively.
39 42  
40 43 ``emin [real]``
41   - Lower energy value for first energy bin (in TeV).
  44 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  45 + energy binning algorithms are used.
42 46  
43 47 ``emax [real]``
44   - Upper energy value for last energy bin (in TeV).
  48 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  49 + energy binning algorithms are used.
45 50  
46 51 ``enumbins [integer]``
47   - Number of energy bins.
  52 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  53 + used.
48 54  
49 55 ``ebinfile [file]``
50   - Name of the file containing the energy bin definition.
  56 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  57 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
51 58  
52 59 ``nxpix [integer]``
53 60 Number of cube bins in Right Ascension or Galactic longitude.
... ...
doc/source/users/reference_manual/ctmodel.rst
  View file @c65f2ac
... ... @@ -98,20 +98,27 @@ General parameters
98 98 ``(deadc = 0.95) [real]``
99 99 Average deadtime correction factor.
100 100  
101   -``(ebinalg = LOG) <FILE|LIN|LOG> [string]``
102   - Algorithm for defining energy bins.
  101 +``ebinalg <FILE|LIN|LOG> [string]``
  102 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  103 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  104 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  105 + logarithmically between ``emin`` and ``emax``, respectively.
103 106  
104 107 ``emin [real]``
105   - Lower energy value for first energy bin (in TeV).
  108 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  109 + energy binning algorithms are used.
106 110  
107 111 ``emax [real]``
108   - Upper energy value for last energy bin (in TeV).
  112 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  113 + energy binning algorithms are used.
109 114  
110 115 ``enumbins [integer]``
111   - Number of energy bins.
  116 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  117 + used.
112 118  
113   -``(ebinfile = NONE) [file]``
114   - Name of the file containing the energy bin definition.
  119 +``ebinfile [file]``
  120 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  121 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
115 122  
116 123 ``(usepnt = no) [boolean]``
117 124 Use pointing instead of xref/yref parameters?
... ...
doc/source/users/reference_manual/ctpsfcube.rst
  View file @c65f2ac
... ... @@ -55,19 +55,26 @@ General parameters
55 55 Output point spread function cube file.
56 56  
57 57 ``ebinalg <FILE|LIN|LOG> [string]``
58   - Algorithm for defining energy bins.
  58 + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined
  59 + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN``
  60 + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or
  61 + logarithmically between ``emin`` and ``emax``, respectively.
59 62  
60 63 ``emin [real]``
61   - Lower energy value for first energy bin (in TeV).
  64 + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG``
  65 + energy binning algorithms are used.
62 66  
63 67 ``emax [real]``
64   - Upper energy value for last energy bin (in TeV).
  68 + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG``
  69 + energy binning algorithms are used.
65 70  
66 71 ``enumbins [integer]``
67   - Number of energy bins.
  72 + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are
  73 + used.
68 74  
69 75 ``ebinfile [file]``
70   - Name of the file containing the energy bin definition.
  76 + Name of the file containing the energy binning definition if ``ebinalg=FILE``.
  77 + You may use :ref:`csebins` to generate a file with appropriate energy binning.
71 78  
72 79 ``(addbounds = no) [boolean]``
73 80 Add energies to the point spread function cube at the observation energy boundaries?
... ...
doc/source/users/reference_manual/ctselect.rst
  View file @c65f2ac
... ... @@ -52,37 +52,37 @@ General parameters
52 52  
53 53 ``ra [real]``
54 54 Right Ascension of acceptance cone (or ROI) centre (J2000, in degrees).
55   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no ROI
  55 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no ROI
56 56 selection will be performed.
57 57  
58 58 ``dec [real]``
59 59 Declination of acceptance cone (or ROI) centre (J2000, in degrees).
60   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no ROI
  60 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no ROI
61 61 selection will be performed.
62 62  
63 63 ``rad [real]``
64 64 Radius of acceptance cone (or ROI) centre (in degrees).
65   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no ROI
  65 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no ROI
66 66 selection will be performed.
67 67  
68 68 ``tmin [time]``
69 69 Start time (UTC string, JD, MJD or time in seconds).
70   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no time
  70 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no time
71 71 selection will be performed.
72 72  
73 73 ``tmax [time]``
74 74 Stop time (UTC string, JD, MJD or time in seconds).
75   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no time
  75 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no time
76 76 selection will be performed.
77 77  
78 78 ``emin [real]``
79 79 Lower energy limit of events (in TeV).
80   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no energy
  80 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no energy
81 81 selection will be performed.
82 82  
83 83 ``emax [real]``
84 84 Upper energy limit of events (in TeV).
85   - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no energy
  85 + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no energy
86 86 selection will be performed.
87 87  
88 88 ``(phase = NONE) [string]``
... ...
doc/source/users/reference_manual/cttsmap.rst
  View file @c65f2ac
... ... @@ -104,7 +104,7 @@ General parameters
104 104 ``(binmax = -1) [integer]``
105 105 Last bin to compute.
106 106  
107   -``(logLO = -1) [real]``
  107 +``(logL0 = -1) [real]``
108 108 LogLikelihood value of null hypothesis.
109 109  
110 110  
... ...
src/ctbin/ctbin.par
  View file @c65f2ac
... ... @@ -23,8 +23,8 @@ outcube, f, a, cntcube.fits,,, &quot;Output counts cube file&quot;
23 23 # Energy binning parameters
24 24 #==========================
25 25 ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
26   -emin, r, a, 0.1,,, "Start value for first energy bin in TeV"
27   -emax, r, a, 100.0,,, "Stop value for last energy bin in TeV"
  26 +emin, r, a, 0.1,,, "Lower energy limit (TeV)"
  27 +emax, r, a, 100.0,,, "Upper energy limit (TeV)"
28 28 enumbins, i, a, 20,1,200, "Number of energy bins"
29 29 ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
30 30  
... ... @@ -46,6 +46,6 @@ yref, r, a, 22.01,-90,90, &quot;Second coordinate of image center in degrees (DEC
46 46 publish, b, h, no,,, "Publish counts cube on VO Hub?"
47 47 chatter, i, h, 2,0,4, "Chattiness of output"
48 48 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
49   -debug, b, h, no,,, "Debugging mode activated"
  49 +debug, b, h, no,,, "Activate debugging mode?"
50 50 mode, s, h, ql,,, "Mode of automatic parameters"
51 51 logfile, f, h, ctbin.log,,, "Log filename"
... ...
src/ctbkgcube/ctbkgcube.par
  View file @c65f2ac
... ... @@ -16,22 +16,22 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "NONE",,, "Input event list or observation definition XML file"
20   -inmodel, f, a, "NONE",,, "Input model definition XML file"
21   -incube, f, a, "NONE",,, "Input counts cube file to extract background cube definition"
22   -caldb, s, a, "prod2",,, "Calibration database"
23   -irf, s, a, "South_0.5h",,, "Instrument response function"
24   -outcube, f, a, "bkgcube.fits",,, "Output background cube file"
25   -outmodel, f, a, "NONE",,, "Output model definition XML file"
  19 +inobs, f, a, NONE,,, "Input event list or observation definition XML file"
  20 +inmodel, f, a, NONE,,, "Input model definition XML file"
  21 +incube, f, a, NONE,,, "Input counts cube file to extract background cube definition"
  22 +caldb, s, a, prod2,,, "Calibration database"
  23 +irf, s, a, South_0.5h,,, "Instrument response function"
  24 +outcube, f, a, bkgcube.fits,,, "Output background cube file"
  25 +outmodel, f, a, NONE,,, "Output model definition XML file"
26 26  
27 27 #
28 28 # Energy binning parameters
29 29 #==========================
30   -ebinalg, s, h, "LOG",FILE|LIN|LOG,, "Algorithm for defining energy bins"
  30 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
31 31 emin, r, a, 0.1,,, "Lower energy limit (TeV)"
32 32 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
33   -enumbins, i, a, 20,,, "Number of energy bins"
34   -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
  33 +enumbins, i, a, 20,1,200, "Number of energy bins"
  34 +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
35 35 addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
36 36  
37 37 #
... ... @@ -52,6 +52,6 @@ yref, r, a, 22.01,-90,90, &quot;Second coordinate of image center in degrees (DEC
52 52 publish, b, h, no,,, "Publish sky map on VO Hub?"
53 53 chatter, i, h, 2,0,4, "Chattiness of output"
54 54 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
55   -debug, b, h, no,,, "Debugging mode activated"
56   -mode, s, h, "ql",,, "Mode of automatic parameters"
57   -logfile, f, h, "ctbkgcube.log",,, "Log filename"
  55 +debug, b, h, no,,, "Activate debugging mode?"
  56 +mode, s, h, ql,,, "Mode of automatic parameters"
  57 +logfile, f, h, ctbkgcube.log,,, "Log filename"
... ...
src/ctbutterfly/ctbutterfly.par
  View file @c65f2ac
... ... @@ -16,17 +16,17 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,,"Input event list, counts cube or observation definition XML file"
20   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
21   -srcname, s, a, "Crab",,,"Source of interest"
22   -expcube, f, a, "NONE",,, "Input exposure cube file"
23   -psfcube, f, a, "NONE",,, "Input PSF cube file"
24   -edispcube, f, a, "NONE",,, "Input energy dispersion cube file"
25   -bkgcube, f, a, "NONE",,, "Input background cube file"
26   -caldb, s, a, "prod2",,, "Calibration database"
27   -irf, s, a, "South_0.5h",,, "Instrument response function"
  19 +inobs, f, a, events.fits,,,"Input event list, counts cube or observation definition XML file"
  20 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  21 +srcname, s, a, Crab,,,"Source of interest"
  22 +expcube, f, a, NONE,,, "Input exposure cube file"
  23 +psfcube, f, a, NONE,,, "Input PSF cube file"
  24 +edispcube, f, a, NONE,,, "Input energy dispersion cube file"
  25 +bkgcube, f, a, NONE,,, "Input background cube file"
  26 +caldb, s, a, prod2,,, "Calibration database"
  27 +irf, s, a, South_0.5h,,, "Instrument response function"
28 28 edisp, b, h, no,,, "Apply energy dispersion?"
29   -outfile, f, a, "butterfly.txt",,, "Output ASCII file"
  29 +outfile, f, a, butterfly.txt,,, "Output ASCII file"
30 30 method, s, h, GAUSSIAN, GAUSSIAN|ENVELOPE,,"Butterfly computation method"
31 31  
32 32 #
... ... @@ -35,22 +35,22 @@ method, s, h, GAUSSIAN, GAUSSIAN|ENVELOPE,,&quot;Butterfly computation method&quot;
35 35 fit, b, h, no,,, "Perform maximum likelihood fitting?"
36 36 confidence, r, h, 0.68,0.0,1.0, "Confidence level"
37 37 statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
38   -matrix, f, h, "NONE",,, "Input covariance Matrix FITS file"
  38 +matrix, f, h, NONE,,, "Input covariance Matrix FITS file"
39 39  
40 40 #
41 41 # Energy binning parameters
42 42 #==========================
43   -ebinalg, s, h, "LOG", FILE|LIN|LOG,,"Algorithm for defining energy bins"
44   -emin, r, a, 0.1,,,"Lower energy limit (TeV)"
45   -emax, r, a, 100.0,,,"Upper energy limit (TeV)"
46   -enumbins, i, h, 100,,,"Number of energy bins"
47   -ebinfile, f, h, "NONE",,,"Name of the file containing the energy bin definition"
  43 +ebinalg, s, h, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
  44 +emin, r, a, 0.1,,, "Lower energy limit (TeV)"
  45 +emax, r, a, 100.0,,, "Upper energy limit (TeV)"
  46 +enumbins, i, h, 100,1,1000, "Number of energy bins"
  47 +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
48 48  
49 49 #
50 50 # Standard parameters
51 51 #====================
52 52 chatter, i, h, 2,0,4, "Chattiness of output"
53 53 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
54   -debug, b, h, no,,, "Debugging mode activated"
55   -mode, s, h, "ql",,, "Mode of automatic parameters"
56   -logfile, f, h, "ctbutterfly.log",,, "Log filename"
  54 +debug, b, h, no,,, "Activate debugging mode?"
  55 +mode, s, h, ql,,, "Mode of automatic parameters"
  56 +logfile, f, h, ctbutterfly.log,,, "Log filename"
... ...
src/ctcubemask/ctcubemask.par
  View file @c65f2ac
... ... @@ -16,9 +16,9 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "cntcube.fits",,, "Input counts cube or observation definition XML file"
20   -outcube, f, a, "cntcube_filtered.fits",,, "Output counts cube or observation definition XML file"
21   -prefix, s, h, "filtered_",,, "Prefix for counts cube in observation definition XML file"
  19 +inobs, f, a, cntcube.fits,,, "Input counts cube or observation definition XML file"
  20 +outcube, f, a, cntcube_filtered.fits,,, "Output counts cube or observation definition XML file"
  21 +prefix, s, h, filtered_,,, "Prefix for counts cube in observation definition XML file"
22 22  
23 23 #
24 24 # Selection parameters
... ... @@ -27,7 +27,7 @@ usepnt, b, h, no,,, &quot;Use pointing instead of RA/DEC parameters?&quot;
27 27 ra, r, a, 83.63,0,360, "RA for ROI centre (degrees)"
28 28 dec, r, a, 22.01,-90,90, "Dec for ROI centre (degrees)"
29 29 rad, r, a, 3.0,0,180, "Radius of ROI (degrees)"
30   -regfile, f, a, "NONE",,, "Input exclusion region file in ds9 format"
  30 +regfile, f, a, NONE,,, "Input exclusion region file in ds9 format"
31 31 emin, r, a, 0.1,,, "Lower energy limit (TeV)"
32 32 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
33 33  
... ... @@ -37,6 +37,6 @@ emax, r, a, 100.0,,, &quot;Upper energy limit (TeV)&quot;
37 37 publish, b, h, no,,, "Publish counts cube on VO Hub?"
38 38 chatter, i, h, 2,0,4, "Chattiness of output"
39 39 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
40   -debug, b, h, no,,, "Debugging mode activated"
41   -mode, s, h, "ql",,, "Mode of automatic parameters"
42   -logfile, f, h, "ctcubemask.par.log",,, "Log filename"
  40 +debug, b, h, no,,, "Activate debugging mode?"
  41 +mode, s, h, ql,,, "Mode of automatic parameters"
  42 +logfile, f, h, ctcubemask.log,,, "Log filename"
... ...
src/ctedispcube/ctedispcube.par
  View file @c65f2ac
... ... @@ -16,20 +16,20 @@
16 16 #
17 17 # Observational parameters
18 18 #===================
19   -inobs, f, a, "NONE",,, "Input event list or observation definition XML file"
20   -incube, f, a, "NONE",,, "Input counts cube file to extract energy dispersion cube definition"
21   -caldb, s, a, "prod2",,, "Calibration database"
22   -irf, s, a, "South_0.5h",,, "Instrument response function"
23   -outcube, f, a, "edispcube.fits",,, "Output energy dispersion cube file"
  19 +inobs, f, a, NONE,,, "Input event list or observation definition XML file"
  20 +incube, f, a, NONE,,, "Input counts cube file to extract energy dispersion cube definition"
  21 +caldb, s, a, prod2,,, "Calibration database"
  22 +irf, s, a, South_0.5h,,, "Instrument response function"
  23 +outcube, f, a, edispcube.fits,,, "Output energy dispersion cube file"
24 24  
25 25 #
26 26 # Energy binning parameters
27 27 #==========================
28   -ebinalg, s, h, "LOG", FILE|LIN|LOG,, "Algorithm for defining energy bins"
  28 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
29 29 emin, r, a, 0.1,,, "Lower energy limit (TeV)"
30 30 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
31   -enumbins, i, a, 20,,, "Number of energy bins"
32   -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
  31 +enumbins, i, a, 20,1,200, "Number of energy bins"
  32 +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
33 33 addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
34 34  
35 35 #
... ... @@ -55,6 +55,6 @@ migrabins, i, h, 100,,, &quot;Number of migration bins&quot;
55 55 #====================
56 56 chatter, i, h, 2,0,4, "Chattiness of output"
57 57 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
58   -debug, b, h, no,,, "Debugging mode activated"
59   -mode, s, h, "ql",,, "Mode of automatic parameters"
60   -logfile, f, h, "ctedispcube.log",,, "Log filename"
  58 +debug, b, h, no,,, "Activate debugging mode?"
  59 +mode, s, h, ql,,, "Mode of automatic parameters"
  60 +logfile, f, h, ctedispcube.log,,, "Log filename"
... ...
src/cterror/cterror.par
  View file @c65f2ac
... ... @@ -17,17 +17,17 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definiton XML file"
22   -srcname, s, a, "Crab",,, "Source of interest"
23   -expcube, f, a, "NONE",,, "Input exposure cube file"
24   -psfcube, f, a, "NONE",,, "Input PSF cube file"
25   -edispcube,f, a, "NONE",,, "Input energy dispersion cube file"
26   -bkgcube, f, a, "NONE",,, "Input background cube file"
27   -caldb, s, a, "prod2",,, "Calibration database"
28   -irf, s, a, "South_0.5h",,, "Instrument response function"
  20 +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file"
  21 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definiton XML file"
  22 +srcname, s, a, Crab,,, "Source of interest"
  23 +expcube, f, a, NONE,,, "Input exposure cube file"
  24 +psfcube, f, a, NONE,,, "Input PSF cube file"
  25 +edispcube,f, a, NONE,,, "Input energy dispersion cube file"
  26 +bkgcube, f, a, NONE,,, "Input background cube file"
  27 +caldb, s, a, prod2,,, "Calibration database"
  28 +irf, s, a, South_0.5h,,, "Instrument response function"
29 29 edisp, b, h, no,,, "Apply energy dispersion?"
30   -outmodel, f, a, "results.xml",,, "Output model definiton XML file"
  30 +outmodel, f, a, results.xml,,, "Output model definiton XML file"
31 31  
32 32 #
33 33 # Error calculation parameters
... ... @@ -42,6 +42,6 @@ max_iter, i, h, 50,1,1000, &quot;Maximum number of iterations&quot;
42 42 #====================
43 43 chatter, i, h, 2,0,4, "Chattiness of output"
44 44 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
45   -debug, b, h, no,,, "Debugging mode activated"
46   -mode, s, h, "ql",,, "Mode of automatic parameters"
47   -logfile, f, h, "cterror.log",,, "Log filename"
  45 +debug, b, h, no,,, "Activate debugging mode?"
  46 +mode, s, h, ql,,, "Mode of automatic parameters"
  47 +logfile, f, h, cterror.log,,, "Log filename"
... ...
src/ctexpcube/ctexpcube.par
  View file @c65f2ac
... ... @@ -16,20 +16,20 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "NONE",,, "Input event list or observation definition XML file"
20   -incube, f, a, "NONE",,, "Input counts cube file to extract exposure cube definition"
21   -caldb, s, a, "prod2",,, "Calibration database"
22   -irf, s, a, "South_0.5h",,, "Instrument response function"
23   -outcube, f, a, "expcube.fits",,, "Output exposure cube file"
  19 +inobs, f, a, NONE,,, "Input event list or observation definition XML file"
  20 +incube, f, a, NONE,,, "Input counts cube file to extract exposure cube definition"
  21 +caldb, s, a, prod2,,, "Calibration database"
  22 +irf, s, a, South_0.5h,,, "Instrument response function"
  23 +outcube, f, a, expcube.fits,,, "Output exposure cube file"
24 24  
25 25 #
26 26 # Energy binning parameters
27 27 #==========================
28   -ebinalg, s, h, "LOG", FILE|LIN|LOG,,"Algorithm for defining energy bins"
29   -emin, r, a, 0.1,,,"Lower energy limit (TeV)"
  28 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
  29 +emin, r, a, 0.1,,, "Lower energy limit (TeV)"
30 30 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
31   -enumbins, i, a, 20,,, "Number of energy bins"
32   -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
  31 +enumbins, i, a, 20,1,200, "Number of energy bins"
  32 +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
33 33 addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
34 34  
35 35 #
... ... @@ -50,6 +50,6 @@ yref, r, a, 22.01,-90,90, &quot;Second coordinate of image center in degrees (DEC
50 50 publish, b, h, no,,, "Publish sky map on VO Hub?"
51 51 chatter, i, h, 2,0,4, "Chattiness of output"
52 52 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
53   -debug, b, h, no,,, "Debugging mode activated"
54   -mode, s, h, "ql",,, "Mode of automatic parameters"
55   -logfile, f, h, "ctexpcube.log",,, "Log filename"
  53 +debug, b, h, no,,, "Activate debugging mode?"
  54 +mode, s, h, ql,,, "Mode of automatic parameters"
  55 +logfile, f, h, ctexpcube.log,,, "Log filename"
... ...
src/ctlike/ctlike.par
  View file @c65f2ac
... ... @@ -16,17 +16,17 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
20   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
21   -expcube, f, a, "NONE",,, "Input exposure cube file"
22   -psfcube, f, a, "NONE",,, "Input PSF cube file"
23   -edispcube, f, a, "NONE",,, "Input energy dispersion cube file"
24   -bkgcube, f, a, "NONE",,, "Input background cube file"
25   -caldb, s, a, "prod2",,, "Calibration database"
26   -irf, s, a, "South_0.5h",,, "Instrument response function"
  19 +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file"
  20 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  21 +expcube, f, a, NONE,,, "Input exposure cube file"
  22 +psfcube, f, a, NONE,,, "Input PSF cube file"
  23 +edispcube, f, a, NONE,,, "Input energy dispersion cube file"
  24 +bkgcube, f, a, NONE,,, "Input background cube file"
  25 +caldb, s, a, prod2,,, "Calibration database"
  26 +irf, s, a, South_0.5h,,, "Instrument response function"
27 27 edisp, b, h, no,,, "Apply energy dispersion?"
28   -outmodel, f, a, "crab_results.xml",,, "Output model definition XML file"
29   -outcovmat, f, h, "NONE",,, "Output covariance matrix FITS file"
  28 +outmodel, f, a, crab_results.xml,,, "Output model definition XML file"
  29 +outcovmat, f, h, NONE,,, "Output covariance matrix FITS file"
30 30  
31 31 #
32 32 # Maximisation parameters
... ... @@ -40,6 +40,6 @@ fix_spat_for_ts, b, h, no,,, &quot;Fix spatial parameters for TS computation?&quot;
40 40 #====================
41 41 chatter, i, h, 2,0,4, "Chattiness of output"
42 42 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
43   -debug, b, h, no,,, "Debugging mode activated"
44   -mode, s, h, "ql",,, "Mode of automatic parameters"
45   -logfile, f, h, "ctlike.log",,, "Log filename"
  43 +debug, b, h, no,,, "Activate debugging mode?"
  44 +mode, s, h, ql,,, "Mode of automatic parameters"
  45 +logfile, f, h, ctlike.log,,, "Log filename"
... ...
src/ctmapcube/ctmapcube.par
  View file @c65f2ac
... ... @@ -16,16 +16,16 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
20   -outcube, f, a, "mapcube.fits",,, "Output map cube file"
  19 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  20 +outcube, f, a, mapcube.fits,,, "Output map cube file"
21 21 ptsrcsig, r, h, 1.0,0,60, "Point source Gaussian sigma in arcmin"
22 22  
23 23 #
24 24 # Energy binning parameters
25 25 #==========================
26 26 ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
27   -emin, r, a, 0.1,,, "Start value for first energy bin in TeV"
28   -emax, r, a, 100.0,,, "Stop value for last energy bin in TeV"
  27 +emin, r, a, 0.1,,, "Lower energy limit (TeV)"
  28 +emax, r, a, 100.0,,, "Upper energy limit (TeV)"
29 29 enumbins, i, a, 20,1,200, "Number of energy bins"
30 30 ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
31 31  
... ... @@ -46,6 +46,6 @@ yref, r, a, 22.01,-90,90, &quot;Second coordinate of image center in degrees (DEC
46 46 publish, b, h, no,,, "Publish map cube on VO Hub?"
47 47 chatter, i, h, 2,0,4, "Chattiness of output"
48 48 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
49   -debug, b, h, no,,, "Debugging mode activated"
50   -mode, s, h, "ql",,, "Mode of automatic parameters"
51   -logfile, f, h, "ctmapcube.log",,, "Log filename"
  49 +debug, b, h, no,,, "Activate debugging mode?"
  50 +mode, s, h, ql,,, "Mode of automatic parameters"
  51 +logfile, f, h, ctmapcube.log,,, "Log filename"
... ...
src/ctmodel/ctmodel.par
  View file @c65f2ac
... ... @@ -16,17 +16,17 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "NONE",,, "Input event list, counts cube or observation definition XML file"
20   -incube, f, a, "NONE",,, "Input counts cube file to extract model cube definition"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
22   -expcube, f, a, "NONE",,, "Input exposure cube file"
23   -psfcube, f, a, "NONE",,, "Input PSF cube file"
24   -edispcube,f, a, "NONE",,, "Input energy dispersion cube file"
25   -bkgcube, f, a, "NONE",,, "Input background cube file"
26   -caldb, s, a, "prod2",,, "Calibration database"
27   -irf, s, a, "South_0.5h",,, "Instrument response function"
  19 +inobs, f, a, NONE,,, "Input event list, counts cube or observation definition XML file"
  20 +incube, f, a, NONE,,, "Input counts cube file to extract model cube definition"
  21 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  22 +expcube, f, a, NONE,,, "Input exposure cube file"
  23 +psfcube, f, a, NONE,,, "Input PSF cube file"
  24 +edispcube,f, a, NONE,,, "Input energy dispersion cube file"
  25 +bkgcube, f, a, NONE,,, "Input background cube file"
  26 +caldb, s, a, prod2,,, "Calibration database"
  27 +irf, s, a, South_0.5h,,, "Instrument response function"
28 28 edisp, b, h, no,,, "Apply energy dispersion?"
29   -outcube, f, a, "modcube.fits",,, "Output model cube file"
  29 +outcube, f, a, modcube.fits,,, "Output model cube file"
30 30  
31 31 #
32 32 # Observation parameters
... ... @@ -41,11 +41,11 @@ deadc, r, h, 0.98,0,1, &quot;Average deadtime correction factor&quot;
41 41 #
42 42 # Energy binning parameters
43 43 #==========================
44   -ebinalg, s, h, "LOG",FILE|LIN|LOG,, "Algorithm for defining energy bins"
45   -emin, r, a, 0.1,,, "Start value for first energy bin in TeV"
46   -emax, r, a, 100.0,,, "Stop value for last energy bin in TeV"
47   -enumbins, i, a, 20,,, "Number of energy bins"
48   -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
  44 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
  45 +emin, r, a, 0.1,,, "Lower energy limit (TeV)"
  46 +emax, r, a, 100.0,,, "Upper energy limit (TeV)"
  47 +enumbins, i, a, 20,1,200, "Number of energy bins"
  48 +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
49 49  
50 50 #
51 51 # Spatial binning parameters
... ... @@ -65,6 +65,6 @@ yref, r, a, 22.01,-90,90, &quot;Second coordinate of image center in degrees (DEC
65 65 publish, b, h, no,,, "Publish model cube on VO Hub?"
66 66 chatter, i, h, 2,0,4, "Chattiness of output"
67 67 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
68   -debug, b, h, no,,, "Debugging mode activated"
69   -mode, s, h, "ql",,, "Mode of automatic parameters"
70   -logfile, f, h, "ctmodel.log",,, "Log filename"
  68 +debug, b, h, no,,, "Activate debugging mode?"
  69 +mode, s, h, ql,,, "Mode of automatic parameters"
  70 +logfile, f, h, ctmodel.log,,, "Log filename"
... ...
src/ctobssim/ctobssim.par
  View file @c65f2ac
... ... @@ -46,6 +46,6 @@ eslices, i, h, 10,1,100, &quot;Number of energy slices&quot;
46 46 publish, b, h, no,,, "Publish event list on VO Hub?"
47 47 chatter, i, h, 2,0,4, "Chattiness of output"
48 48 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
49   -debug, b, h, no,,, "Debugging mode activated"
  49 +debug, b, h, no,,, "Activate debugging mode?"
50 50 mode, s, h, ql,,, "Mode of automatic parameters"
51 51 logfile, f, h, ctobssim.log,,, "Log filename"
... ...
src/ctphase/ctphase.par
  View file @c65f2ac
... ... @@ -16,11 +16,11 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file"
20   -outobs, f, a, "phased_events.fits",,, "Output event list or observation definition XML file"
21   -prefix, s, h, "phased_",,, "Prefix for event lists in observation definition XML file"
22   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Model definition XML file"
23   -srcname, s, a, "Crab",,, "Source in model definition XML file to use for phase computation"
  19 +inobs, f, a, events.fits,,, "Input event list or observation definition XML file"
  20 +outobs, f, a, phased_events.fits,,, "Output event list or observation definition XML file"
  21 +prefix, s, h, phased_,,, "Prefix for event lists in observation definition XML file"
  22 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Model definition XML file"
  23 +srcname, s, a, Crab,,, "Source in model definition XML file to use for phase computation"
24 24  
25 25 #
26 26 # Phase information parameters
... ... @@ -37,6 +37,6 @@ f2, r, a, 0.01,,, &quot;Second frequency derivative at reference MJD (s^-3)&quot;
37 37 publish, b, h, no,,, "Publish event list on VO Hub?"
38 38 chatter, i, h, 2,0,4, "Chattiness of output"
39 39 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
40   -debug, b, h, no,,, "Debugging mode activated"
41   -mode, s, h, "ql",,, "Mode of automatic parameters"
42   -logfile, f, h, "ctphase.log",,, "Log filename"
  40 +debug, b, h, no,,, "Activate debugging mode?"
  41 +mode, s, h, ql,,, "Mode of automatic parameters"
  42 +logfile, f, h, ctphase.log,,, "Log filename"
... ...
src/ctprob/ctprob.par
  View file @c65f2ac
... ... @@ -16,12 +16,12 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file"
20   -outobs, f, a, "prob_events.fits",,, "Output event list or observation definition XML file"
21   -prefix, s, h, "prob_",,, "Prefix for event lists in observation definition XML file"
22   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
23   -caldb, s, a, "prod2",,, "Calibration database"
24   -irf, s, a, "South_0.5h",,, "Instrument response function"
  19 +inobs, f, a, events.fits,,, "Input event list or observation definition XML file"
  20 +outobs, f, a, prob_events.fits,,, "Output event list or observation definition XML file"
  21 +prefix, s, h, prob_,,, "Prefix for event lists in observation definition XML file"
  22 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  23 +caldb, s, a, prod2,,, "Calibration database"
  24 +irf, s, a, South_0.5h,,, "Instrument response function"
25 25 edisp, b, h, no,,, "Apply energy dispersion?"
26 26  
27 27 #
... ... @@ -30,6 +30,6 @@ edisp, b, h, no,,, &quot;Apply energy dispersion?&quot;
30 30 publish, b, h, no,,, "Publish event list on VO Hub?"
31 31 chatter, i, h, 2,0,4, "Chattiness of output"
32 32 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
33   -debug, b, h, no,,, "Debugging mode activated"
34   -mode, s, h, "ql",,, "Mode of automatic parameters"
35   -logfile, f, h, "ctprob.log",,, "Log filename"
  33 +debug, b, h, no,,, "Activate debugging mode?"
  34 +mode, s, h, ql,,, "Mode of automatic parameters"
  35 +logfile, f, h, ctprob.log,,, "Log filename"
... ...
src/ctpsfcube/ctpsfcube.par
  View file @c65f2ac
... ... @@ -16,20 +16,20 @@
16 16 #
17 17 # Observational parameters
18 18 #===================
19   -inobs, f, a, "NONE",,, "Input event list or observation definition XML file"
20   -incube, f, a, "NONE",,, "Input counts cube file to extract PSF cube definition"
21   -caldb, s, a, "prod2",,, "Calibration database"
22   -irf, s, a, "South_0.5h",,, "Instrument response function"
23   -outcube, f, a, "psfcube.fits",,, "Output PSF cube file"
  19 +inobs, f, a, NONE,,, "Input event list or observation definition XML file"
  20 +incube, f, a, NONE,,, "Input counts cube file to extract PSF cube definition"
  21 +caldb, s, a, prod2,,, "Calibration database"
  22 +irf, s, a, South_0.5h,,, "Instrument response function"
  23 +outcube, f, a, psfcube.fits,,, "Output PSF cube file"
24 24  
25 25 #
26 26 # Energy binning parameters
27 27 #==========================
28   -ebinalg, s, h, "LOG", FILE|LIN|LOG,, "Algorithm for defining energy bins"
  28 +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins"
29 29 emin, r, a, 0.1,,, "Lower energy limit (TeV)"
30 30 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
31   -enumbins, i, a, 20,,, "Number of energy bins"
32   -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
  31 +enumbins, i, a, 20,1,200, "Number of energy bins"
  32 +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition"
33 33 addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
34 34  
35 35 #
... ... @@ -55,6 +55,6 @@ anumbins, i, h, 200,,, &quot;Number of angular separation bins&quot;
55 55 #====================
56 56 chatter, i, h, 2,0,4, "Chattiness of output"
57 57 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
58   -debug, b, h, no,,, "Debugging mode activated"
59   -mode, s, h, "ql",,, "Mode of automatic parameters"
60   -logfile, f, h, "ctpsfcube.log",,, "Log filename"
  58 +debug, b, h, no,,, "Activate debugging mode?"
  59 +mode, s, h, ql,,, "Mode of automatic parameters"
  60 +logfile, f, h, ctpsfcube.log,,, "Log filename"
... ...
src/ctselect/ctselect.par
  View file @c65f2ac
... ... @@ -16,9 +16,9 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file"
20   -outobs, f, a, "selected_events.fits",,, "Output event list or observation definition XML file"
21   -prefix, s, h, "selected_",,, "Prefix for event lists in observation definition XML file"
  19 +inobs, f, a, events.fits,,, "Input event list or observation definition XML file"
  20 +outobs, f, a, selected_events.fits,,, "Output event list or observation definition XML file"
  21 +prefix, s, h, selected_,,, "Prefix for event lists in observation definition XML file"
22 22  
23 23 #
24 24 # Selection parameters
... ... @@ -41,6 +41,6 @@ usethres,s, h, NONE,NONE|DEFAULT|USER,, &quot;Energy threshold type&quot;
41 41 publish, b, h, no,,, "Publish event list on VO Hub?"
42 42 chatter, i, h, 2,0,4, "Chattiness of output"
43 43 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
44   -debug, b, h, no,,, "Debugging mode activated"
45   -mode, s, h, "ql",,, "Mode of automatic parameters"
46   -logfile, f, h, "ctselect.log",,, "Log filename"
  44 +debug, b, h, no,,, "Activate debugging mode?"
  45 +mode, s, h, ql,,, "Mode of automatic parameters"
  46 +logfile, f, h, ctselect.log,,, "Log filename"
... ...
src/ctskymap/ctskymap.par
  View file @c65f2ac
... ... @@ -16,10 +16,10 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file"
20   -caldb, s, a, "prod2",,, "Calibration database"
21   -irf, s, a, "South_0.5h",,, "Instrument response function"
22   -outmap, f, a, "skymap.fits",,, "Output skymap file"
  19 +inobs, f, a, events.fits,,, "Input event list or observation definition XML file"
  20 +caldb, s, a, prod2,,, "Calibration database"
  21 +irf, s, a, South_0.5h,,, "Instrument response function"
  22 +outmap, f, a, skymap.fits,,, "Output skymap file"
23 23  
24 24 #
25 25 # Event selection parameters
... ... @@ -54,6 +54,6 @@ inexclusion, f, h, NONE,,, &quot;Exclusion map or DS9 region file name&quot;
54 54 publish, b, h, no,,, "Publish sky map on VO Hub?"
55 55 chatter, i, h, 2,0,4, "Chattiness of output"
56 56 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
57   -debug, b, h, no,,, "Debugging mode activated"
58   -mode, s, h, "ql",,, "Mode of automatic parameters"
59   -logfile, f, h, "ctskymap.log",,, "Log filename"
  57 +debug, b, h, no,,, "Activate debugging mode?"
  58 +mode, s, h, ql,,, "Mode of automatic parameters"
  59 +logfile, f, h, ctskymap.log,,, "Log filename"
... ...
src/cttsmap/cttsmap.par
  View file @c65f2ac
... ... @@ -16,17 +16,17 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
20   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
21   -srcname, s, a, "Crab",,, "Test source name"
22   -expcube, f, a, "NONE",,, "Input exposure cube file"
23   -psfcube, f, a, "NONE",,, "Input PSF cube file"
24   -edispcube, f, a, "NONE",,, "Input energy dispersion cube file"
25   -bkgcube, f, a, "NONE",,, "Input background cube file"
26   -caldb, s, a, "prod2",,, "Calibration database"
27   -irf, s, a, "South_0.5h",,, "Instrument response function"
  19 +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file"
  20 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  21 +srcname, s, a, Crab,,, "Test source name"
  22 +expcube, f, a, NONE,,, "Input exposure cube file"
  23 +psfcube, f, a, NONE,,, "Input PSF cube file"
  24 +edispcube, f, a, NONE,,, "Input energy dispersion cube file"
  25 +bkgcube, f, a, NONE,,, "Input background cube file"
  26 +caldb, s, a, prod2,,, "Calibration database"
  27 +irf, s, a, South_0.5h,,, "Instrument response function"
28 28 edisp, b, h, no,,, "Apply energy dispersion?"
29   -outmap, f, a, "tsmap.fits",,, "Output Test Statistic map file"
  29 +outmap, f, a, tsmap.fits,,, "Output Test Statistic map file"
30 30  
31 31 #
32 32 # TS map computation parameters
... ... @@ -51,7 +51,7 @@ yref, r, a, 22.01,-90,90, &quot;Second coordinate of image center in degrees (DE
51 51 #===========================================
52 52 binmin, i, h, -1,,, "First bin to compute"
53 53 binmax, i, h, -1,,, "Last bin to compute"
54   -logL0, r, h, 0.0,,, "LogLikelihood value of null hypothesis"
  54 +logL0, r, h, 0.0,,, "Log-likelihood value of null hypothesis"
55 55  
56 56 #
57 57 # Standard parameters
... ... @@ -59,6 +59,6 @@ logL0, r, h, 0.0,,, &quot;LogLikelihood value of null hypothesis&quot;
59 59 publish, b, h, no,,, "Publish Test Statistic map on VO Hub?"
60 60 chatter, i, h, 2,0,4, "Chattiness of output"
61 61 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
62   -debug, b, h, no,,, "Debugging mode activated"
63   -mode, s, h, "ql",,, "Mode of automatic parameters"
64   -logfile, f, h, "cttsmap.log",,, "Log filename"
  62 +debug, b, h, no,,, "Activate debugging mode?"
  63 +mode, s, h, ql,,, "Mode of automatic parameters"
  64 +logfile, f, h, cttsmap.log,,, "Log filename"
... ...
src/ctulimit/ctulimit.par
  View file @c65f2ac
... ... @@ -16,15 +16,15 @@
16 16 #
17 17 # General parameters
18 18 #===================
19   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
20   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file"
21   -srcname, s, a, "Crab",,, "Source of interest"
22   -expcube, f, a, "NONE",,, "Input exposure cube file"
23   -psfcube, f, a, "NONE",,, "Input PSF cube file"
24   -edispcube,f, a, "NONE",,, "Input energy dispersion cube file"
25   -bkgcube, f, a, "NONE",,, "Input background cube file"
26   -caldb, s, a, "prod2",,, "Calibration database"
27   -irf, s, a, "South_0.5h",,, "Instrument response function"
  19 +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file"
  20 +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file"
  21 +srcname, s, a, Crab,,, "Source of interest"
  22 +expcube, f, a, NONE,,, "Input exposure cube file"
  23 +psfcube, f, a, NONE,,, "Input PSF cube file"
  24 +edispcube,f, a, NONE,,, "Input energy dispersion cube file"
  25 +bkgcube, f, a, NONE,,, "Input background cube file"
  26 +caldb, s, a, prod2,,, "Calibration database"
  27 +irf, s, a, South_0.5h,,, "Instrument response function"
28 28 edisp, b, h, no,,, "Apply energy dispersion?"
29 29  
30 30 #
... ... @@ -45,6 +45,6 @@ max_iter, i, h, 50,1,1000, &quot;Maximum number of iterations&quot;
45 45 #====================
46 46 chatter, i, h, 2,0,4, "Chattiness of output"
47 47 clobber, b, h, yes,,, "Overwrite existing output files with new output files?"
48   -debug, b, h, no,,, "Debugging mode activated"
49   -mode, s, h, "ql",,, "Mode of automatic parameters"
50   -logfile, f, h, "ctulimit.log",,, "Log filename"
  48 +debug, b, h, no,,, "Activate debugging mode?"
  49 +mode, s, h, ql,,, "Mode of automatic parameters"
  50 +logfile, f, h, ctulimit.log,,, "Log filename"
... ...