From c65f2ac943105bd49220763672a2e5e8334d0aaf Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Wed, 24 Jan 2018 09:18:26 +0100 Subject: [PATCH] Update ctools reference manual --- cscripts/cscaldb.par | 2 +- cscripts/csebins.par | 2 +- cscripts/csfindobs.par | 2 +- cscripts/csiactcopy.par | 2 +- cscripts/csiactdata.par | 2 +- cscripts/csiactobs.par | 2 +- cscripts/cslightcrv.par | 2 +- cscripts/csmodelinfo.par | 2 +- cscripts/csmodelmerge.par | 2 +- cscripts/csmodelselect.par | 2 +- cscripts/csmodelsois.par | 6 +++--- cscripts/csobs2caldb.par | 2 +- cscripts/csobsdef.par | 2 +- cscripts/csobsinfo.par | 2 +- cscripts/csobsselect.par | 2 +- cscripts/csphagen.par | 8 ++++---- cscripts/csphasecrv.par | 2 +- cscripts/cspull.par | 2 +- cscripts/csresmap.par | 4 ++-- cscripts/csresspec.par | 8 ++++---- cscripts/csroot2caldb.par | 2 +- cscripts/cssens.par | 4 ++-- cscripts/csspec.par | 10 +++++----- cscripts/cssrcdetect.par | 2 +- cscripts/cstsdist.par | 2 +- cscripts/cstsmapmerge.par | 2 +- cscripts/cstsmapsplit.par | 2 +- cscripts/csviscube.par | 2 +- cscripts/csworkflow.par | 2 +- doc/source/users/reference_manual/csmodelsois.rst | 8 ++++++-- doc/source/users/reference_manual/csphagen.rst | 26 +++++++++++++++----------- doc/source/users/reference_manual/csresmap.rst | 11 ++++++----- doc/source/users/reference_manual/csresspec.rst | 17 ++++++++++++----- doc/source/users/reference_manual/cssens.rst | 2 +- doc/source/users/reference_manual/csspec.rst | 21 ++++++++++++++------- doc/source/users/reference_manual/ctbin.rst | 19 +++++++++++++------ doc/source/users/reference_manual/ctbkgcube.rst | 17 ++++++++++++----- doc/source/users/reference_manual/ctbutterfly.rst | 23 +++++++++++++++-------- doc/source/users/reference_manual/ctedispcube.rst | 17 ++++++++++++----- doc/source/users/reference_manual/ctexpcube.rst | 17 ++++++++++++----- doc/source/users/reference_manual/ctmapcube.rst | 17 ++++++++++++----- doc/source/users/reference_manual/ctmodel.rst | 21 ++++++++++++++------- doc/source/users/reference_manual/ctpsfcube.rst | 17 ++++++++++++----- doc/source/users/reference_manual/ctselect.rst | 14 +++++++------- doc/source/users/reference_manual/cttsmap.rst | 2 +- src/ctbin/ctbin.par | 6 +++--- src/ctbkgcube/ctbkgcube.par | 26 +++++++++++++------------- src/ctbutterfly/ctbutterfly.par | 38 +++++++++++++++++++------------------- src/ctcubemask/ctcubemask.par | 14 +++++++------- src/ctedispcube/ctedispcube.par | 22 +++++++++++----------- src/cterror/cterror.par | 26 +++++++++++++------------- src/ctexpcube/ctexpcube.par | 24 ++++++++++++------------ src/ctlike/ctlike.par | 26 +++++++++++++------------- src/ctmapcube/ctmapcube.par | 14 +++++++------- src/ctmodel/ctmodel.par | 36 ++++++++++++++++++------------------ src/ctobssim/ctobssim.par | 2 +- src/ctphase/ctphase.par | 16 ++++++++-------- src/ctprob/ctprob.par | 18 +++++++++--------- src/ctpsfcube/ctpsfcube.par | 22 +++++++++++----------- src/ctselect/ctselect.par | 12 ++++++------ src/ctskymap/ctskymap.par | 14 +++++++------- src/cttsmap/cttsmap.par | 28 ++++++++++++++-------------- src/ctulimit/ctulimit.par | 24 ++++++++++++------------ 63 files changed, 391 insertions(+), 312 deletions(-) diff --git a/cscripts/cscaldb.par b/cscripts/cscaldb.par index 96d956e..0482317 100644 --- a/cscripts/cscaldb.par +++ b/cscripts/cscaldb.par @@ -18,6 +18,6 @@ #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cscaldb.log,,, "Log filename" diff --git a/cscripts/csebins.par b/cscripts/csebins.par index bf11659..08a0f4a 100644 --- a/cscripts/csebins.par +++ b/cscripts/csebins.par @@ -34,6 +34,6 @@ bkgthres, r, h, 0.5,,, "Fractional background rate change threshold" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csebins.log,,, "Log filename" diff --git a/cscripts/csfindobs.par b/cscripts/csfindobs.par index 696e415..15405ee 100644 --- a/cscripts/csfindobs.par +++ b/cscripts/csfindobs.par @@ -35,7 +35,7 @@ master_indx, s, h, master.json,,, "Name of master index file" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csfindobs.log,,, "Log filename" diff --git a/cscripts/csiactcopy.par b/cscripts/csiactcopy.par index a790035..2500bdf 100644 --- a/cscripts/csiactcopy.par +++ b/cscripts/csiactcopy.par @@ -26,6 +26,6 @@ outpath, s, a, /path/to/fits,,, "Destination path of FITS data" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csiactcopy.log,,, "Log filename" diff --git a/cscripts/csiactdata.par b/cscripts/csiactdata.par index ff653a5..f5745ff 100644 --- a/cscripts/csiactdata.par +++ b/cscripts/csiactdata.par @@ -24,7 +24,7 @@ master_indx, s, h, master.json,,, "Name of master index file" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csiactdata.log,,, "Log filename" diff --git a/cscripts/csiactobs.par b/cscripts/csiactobs.par index 9661642..f5d8ca5 100644 --- a/cscripts/csiactobs.par +++ b/cscripts/csiactobs.par @@ -47,7 +47,7 @@ bkg_range_factor, r, h, 100.0,,, "Factor to determine range of background normal #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csiactobs.log,,, "Log filename" diff --git a/cscripts/cslightcrv.par b/cscripts/cslightcrv.par index 8e2d636..b47d253 100644 --- a/cscripts/cslightcrv.par +++ b/cscripts/cslightcrv.par @@ -64,7 +64,7 @@ fix_bkg, b, h, no,,, "Fix background model parameters?" publish, b, h, no,,, "Publish light curve on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cslightcrv.log,,, "Log filename" diff --git a/cscripts/csmodelinfo.par b/cscripts/csmodelinfo.par index b78a3ae..3fd8c84 100644 --- a/cscripts/csmodelinfo.par +++ b/cscripts/csmodelinfo.par @@ -39,6 +39,6 @@ fixed_color, s, h, magenta,,, "Color for source without free parameters (any D #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csmodelinfo.log,,, "Log filename" diff --git a/cscripts/csmodelmerge.par b/cscripts/csmodelmerge.par index 596d097..da38772 100644 --- a/cscripts/csmodelmerge.par +++ b/cscripts/csmodelmerge.par @@ -24,6 +24,6 @@ outmodel, f, a, NONE,,, "Output model definition XML file" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csmodelmerge.log,,, "Log filename" diff --git a/cscripts/csmodelselect.par b/cscripts/csmodelselect.par index a33a7e3..df27ab3 100644 --- a/cscripts/csmodelselect.par +++ b/cscripts/csmodelselect.par @@ -36,6 +36,6 @@ fit_shape, b, h, no,,, "Fit source shapes?" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csmodelselect.log,,, "Log filename" diff --git a/cscripts/csmodelsois.par b/cscripts/csmodelsois.par index 62a14bc..fc0d669 100644 --- a/cscripts/csmodelsois.par +++ b/cscripts/csmodelsois.par @@ -50,6 +50,6 @@ glat, r, a, -5.80,-90,90, "Galactic latitude of image center (in degrees)" publish, b, h, no,,, "Publish map cube on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "csmodelsois.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, csmodelsois.log,,, "Log filename" diff --git a/cscripts/csobs2caldb.par b/cscripts/csobs2caldb.par index 4e615eb..d026966 100644 --- a/cscripts/csobs2caldb.par +++ b/cscripts/csobs2caldb.par @@ -28,6 +28,6 @@ index, i, h, 0,,, "Index of observation to be used from XML file" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csobs2caldb.log,,, "Log filename" diff --git a/cscripts/csobsdef.par b/cscripts/csobsdef.par index 8fa09e1..f71bccb 100644 --- a/cscripts/csobsdef.par +++ b/cscripts/csobsdef.par @@ -36,6 +36,6 @@ deadc, r, h, 0.98,,, "Deadtime correction factor" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csobsdef.log,,, "Log filename" diff --git a/cscripts/csobsinfo.par b/cscripts/csobsinfo.par index 5969d98..9471ac3 100644 --- a/cscripts/csobsinfo.par +++ b/cscripts/csobsinfo.par @@ -31,6 +31,6 @@ dec, r, a, 0.0,,, "Target Declination (deg)") #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csobsinfo.log,,, "Log filename" diff --git a/cscripts/csobsselect.par b/cscripts/csobsselect.par index ff4fa1b..5a6a80e 100644 --- a/cscripts/csobsselect.par +++ b/cscripts/csobsselect.par @@ -37,6 +37,6 @@ height, r, a, 10.0,0,180, "Height of selection box (deg)" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csobsselect.log,,, "Log filename" diff --git a/cscripts/csphagen.par b/cscripts/csphagen.par index 9366518..5262398 100644 --- a/cscripts/csphagen.par +++ b/cscripts/csphagen.par @@ -26,10 +26,10 @@ prefix, s, h, onoff,,, "Prefix for output files" # # Script parameters #================== -emin, r, a, 0.1,,, "Lower energy limit (TeV)" -emax, r, a, 100.0,,, "Upper energy limit (TeV)" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" +emin, r, a, 0.1,,, "Start value for first energy bin in TeV" +emax, r, a, 100.0,,, "Stop value for last energy bin in TeV" enumbins, i, a, 120,,, "Number of energy bins" -ebinalg, s, a, LOG,LIN|LOG|FILE,, "Binning algorithm" ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" srcshape, s, h, CIRCLE,CIRCLE,, "Shape of the source region" 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" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csphagen.log,,, "Log filename" diff --git a/cscripts/csphasecrv.par b/cscripts/csphasecrv.par index 49720a3..50aed98 100644 --- a/cscripts/csphasecrv.par +++ b/cscripts/csphasecrv.par @@ -58,7 +58,7 @@ statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic" publish, b, h, no,,, "Publish phase curve on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csphasecrv.log,,, "Log filename" diff --git a/cscripts/cspull.par b/cscripts/cspull.par index 7ed2397..885e6d6 100644 --- a/cscripts/cspull.par +++ b/cscripts/cspull.par @@ -51,6 +51,6 @@ seed, i, h, 1,,, "Initial random number generator seed" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cspull.log,,, "Log filename" diff --git a/cscripts/csresmap.par b/cscripts/csresmap.par index c98b587..f864121 100644 --- a/cscripts/csresmap.par +++ b/cscripts/csresmap.par @@ -31,7 +31,7 @@ outmap, f, a, resmap.fits,,, "Output residual map file" # # Script parameters #================== -ebinalg, s, h, LOG,LIN|LOG|FILE,, "Binning algorithm" +ebinalg, s, h, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" emin, r, a, 0.1,,, "Lower energy limit (TeV)" emax, r, a, 100.0,,, "Upper energy limit (TeV)" enumbins, i, h, 20,,, "Number of model cube energy bins" @@ -51,6 +51,6 @@ algorithm, s, a, SIGNIFICANCE,SUB|SUBDIV|SUBDIVSQRT|SIGNIFICANCE,, "Residual map publish, b, h, no,,, "Publish residual map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csresmap.log,,, "Log filename" diff --git a/cscripts/csresspec.par b/cscripts/csresspec.par index f5b5904..7d2f35b 100644 --- a/cscripts/csresspec.par +++ b/cscripts/csresspec.par @@ -34,9 +34,9 @@ outfile, f, a, resspec.fits,,, "Output residual spectrum file" statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic" components,b, h, no,,, "Calculate model for individual components?" ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" -emin, r, a, 0.1,,, "Lower energy limit (TeV)" -emax, r, a, 100.0,,, "Upper energy limit (TeV)" -enumbins, i, a, 20,,, "Number of model cube energy bins" +emin, r, a, 0.1,,, "Start value for first energy bin in TeV" +emax, r, a, 100.0,,, "Stop value for last energy bin in TeV" +enumbins, i, a, 20,1,200, "Number of energy bins" ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" stack, b, a, no,,, "Stack observations?" coordsys, s, a, CEL,CEL|GAL,, "Coordinate System" @@ -59,6 +59,6 @@ algorithm, s, a, SIGNIFICANCE,SUB|SUBDIV|SUBDIVSQRT|SIGNIFICANCE,, "Residuals co publish, b, h, no,,, "Publish residual map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csresspec.log,,, "Log filename" diff --git a/cscripts/csroot2caldb.par b/cscripts/csroot2caldb.par index cf97262..832334a 100644 --- a/cscripts/csroot2caldb.par +++ b/cscripts/csroot2caldb.par @@ -41,6 +41,6 @@ bgdinfill, b, h, no,,, "Infill of background template?" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csroot2caldb.log,,, "Log filename" diff --git a/cscripts/cssens.par b/cscripts/cssens.par index aec0553..22085e1 100644 --- a/cscripts/cssens.par +++ b/cscripts/cssens.par @@ -33,7 +33,7 @@ duration, r, a, 180000.0,,, "Effective exposure time (s)" rad, r, a, 5.0,,, "Radius of ROI (deg)" emin, r, a, 0.03163,,, "Lower energy limit (TeV)" emax, r, a, 125.8925,,, "Upper energy limit (TeV)" -bins, i, a, 18,,, "Number of energy bins for differential sensitivity computation" +bins, i, a, 18,,, "Number of energy bins for sensitivity computation" enumbins, i, h, 0,,, "Number of energy bins for binned analysis (0=unbinned)" npix, i, h, 200,,, "Number of pixels for binned analysis" 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" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cssens.log,,, "Log filename" diff --git a/cscripts/csspec.par b/cscripts/csspec.par index 302478b..7bceab3 100644 --- a/cscripts/csspec.par +++ b/cscripts/csspec.par @@ -32,10 +32,10 @@ outfile, f, a, spectrum.fits,,, "Output spectrum file" # Script parameters #================== method, s, a, AUTO,SLICE|NODES|AUTO,, "Spectrum generation method" -emin, r, a, 0.1,,, "Lower energy limit (TeV)" -emax, r, a, 100.0,,, "Upper energy limit (TeV)" -enumbins, i, a, 20,,, "Number of energy bins" -ebinalg, s, a, LOG,LIN|LOG|FILE,, "Binning algorithm" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" +emin, r, a, 0.1,,, "Start value for first energy bin in TeV" +emax, r, a, 100.0,,, "Stop value for last energy bin in TeV" +enumbins, i, a, 20,1,200, "Number of energy bins" ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic" calc_ts, b, h, yes,,, "Compute TS value in each bin" @@ -49,6 +49,6 @@ fix_bkg, b, h, no,,, "Fix background parameters" publish, b, h, no,,, "Publish spectrum on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csspec.log,,, "Log filename" diff --git a/cscripts/cssrcdetect.par b/cscripts/cssrcdetect.par index 6829460..d3caa9f 100644 --- a/cscripts/cssrcdetect.par +++ b/cscripts/cssrcdetect.par @@ -36,6 +36,6 @@ fit_shape, b, h, yes,,, "Fit source shapes?" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cssrcdetect.log,,, "Log filename" diff --git a/cscripts/cstsdist.par b/cscripts/cstsdist.par index 3e968a8..97eb2f5 100644 --- a/cscripts/cstsdist.par +++ b/cscripts/cstsdist.par @@ -40,6 +40,6 @@ statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cstsdist.log,,, "Log filename" diff --git a/cscripts/cstsmapmerge.par b/cscripts/cstsmapmerge.par index 9bfc17c..2c00824 100644 --- a/cscripts/cstsmapmerge.par +++ b/cscripts/cstsmapmerge.par @@ -30,7 +30,7 @@ delete, b, h, no,,, "Delete merged files?" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cstsmapmerge.log,,, "Log filename" diff --git a/cscripts/cstsmapsplit.par b/cscripts/cstsmapsplit.par index 0c16c9c..ee534e9 100644 --- a/cscripts/cstsmapsplit.par +++ b/cscripts/cstsmapsplit.par @@ -52,6 +52,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DE publish, b, h, no,,, "Publish Test Statistic map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, cstsmapsplit.log,,, "Log filename" diff --git a/cscripts/csviscube.par b/cscripts/csviscube.par index 203985d..db101cc 100644 --- a/cscripts/csviscube.par +++ b/cscripts/csviscube.par @@ -37,6 +37,6 @@ zmax, r, h, 60.0,,, "Maximum zenith angle (deg)" publish, b, h, no,,, "Publish visibility cube on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csviscube.log,,, "Log filename" diff --git a/cscripts/csworkflow.par b/cscripts/csworkflow.par index 88c3473..2e5bc9d 100644 --- a/cscripts/csworkflow.par +++ b/cscripts/csworkflow.par @@ -23,6 +23,6 @@ inflow, f, a, workflow.xml,,, "Input workflow XML file" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, csworkflow.log,,, "Log filename" diff --git a/doc/source/users/reference_manual/csmodelsois.rst b/doc/source/users/reference_manual/csmodelsois.rst index 1d32d13..9409121 100644 --- a/doc/source/users/reference_manual/csmodelsois.rst +++ b/doc/source/users/reference_manual/csmodelsois.rst @@ -47,7 +47,10 @@ General parameters Output model XML file (not generated if set to ``NONE``). ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` Lower energy value for first energy bin (in TeV). @@ -59,7 +62,8 @@ General parameters Number of energy bins. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy bin definition. You may use :ref:`csebins` + to generate a file with appropriate energy bins. ``nxpix [integer]`` Number of map cube bins in Right Ascension or Galactic longitude. diff --git a/doc/source/users/reference_manual/csphagen.rst b/doc/source/users/reference_manual/csphagen.rst index 4e2ee7e..2fa0895 100644 --- a/doc/source/users/reference_manual/csphagen.rst +++ b/doc/source/users/reference_manual/csphagen.rst @@ -48,24 +48,28 @@ General parameters ``(prefix = onoff) [string]`` Prefix of the file name for output PHA, ARF, RMF, XML, and DS9 region files. +``ebinalg [string]`` + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. + ``emin [real]`` - Lower energy limit (TeV) if ``LIN`` or ``LOG`` binning algorithms are used. + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy limit (TeV) if ``LIN`` or ``LOG`` binning algorithms are used. + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. At least 30 bins per decade are recommended for - proper evaluation of the instrument response. - -``ebinalg [string]`` - Algorithm for defining energy bins (``FILE``: energy bounds retrieved from - file, see ``ebinfile`` parameter; ``LIN``: linearly spaced energy bins; - ``LOG``: logarithmically spaced energy bins). + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are used. + At least 30 bins per decade are recommended for proper evaluation of the + instrument response. ``ebinfile [file]`` - Name of the file containing the energy bin definition if ``FILE`` algorithm - is used. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(srcshape = CIRCLE) [string]`` Shape of the source region (``CIRCLE``: circular region around given position). diff --git a/doc/source/users/reference_manual/csresmap.rst b/doc/source/users/reference_manual/csresmap.rst index 13d9b2a..fdd7e45 100644 --- a/doc/source/users/reference_manual/csresmap.rst +++ b/doc/source/users/reference_manual/csresmap.rst @@ -63,19 +63,20 @@ General parameters Output residual counts map file. ``(ebinalg = LOG) [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins for internal residual map computation. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for residual map (in TeV). ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for residual map (in TeV). ``(enumbins = 20) [integer]`` - Number of model cube energy bins. + Number of model cube energy bins for internal residual map computation. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy bin definition for internal residual + map computation. ``coordsys [string]`` Coordinate system (CEL - celestial, GAL - galactic). diff --git a/doc/source/users/reference_manual/csresspec.rst b/doc/source/users/reference_manual/csresspec.rst index f0ff920..e08a53b 100644 --- a/doc/source/users/reference_manual/csresspec.rst +++ b/doc/source/users/reference_manual/csresspec.rst @@ -88,19 +88,26 @@ General parameters Calculate model for individual components? ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``stack [boolean]`` Stack multiple observations for residual calculation? diff --git a/doc/source/users/reference_manual/cssens.rst b/doc/source/users/reference_manual/cssens.rst index 2789064..2b47cb6 100644 --- a/doc/source/users/reference_manual/cssens.rst +++ b/doc/source/users/reference_manual/cssens.rst @@ -83,7 +83,7 @@ General parameters Number of energy bins for sensitivity computation. ``(enumbins = 0) [integer]`` - Number of energy bins (0=unbinned). + Number of energy bins for binned analysis (``0`` = unbinned analysis). ``(npix = 200) [integer]`` Number of pixels for binned analysis. diff --git a/doc/source/users/reference_manual/csspec.rst b/doc/source/users/reference_manual/csspec.rst index 01c24ac..8654b6c 100644 --- a/doc/source/users/reference_manual/csspec.rst +++ b/doc/source/users/reference_manual/csspec.rst @@ -98,20 +98,27 @@ General parameters data. For CTA-only observations ``SLICE`` will be used, otherwise ``NODES`` will be used. +``ebinalg [string]`` + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. + ``emin [real]`` - Lower energy limit of events (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy limit of events (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. - -``ebinalg [string]`` - Algorithm for defining energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(statistic = DEFAULT) [string]`` Optimization statistic. ``DEFAULT`` uses the default statistic for all diff --git a/doc/source/users/reference_manual/ctbin.rst b/doc/source/users/reference_manual/ctbin.rst index b5ccba7..0a83f4e 100644 --- a/doc/source/users/reference_manual/ctbin.rst +++ b/doc/source/users/reference_manual/ctbin.rst @@ -18,7 +18,7 @@ specified in an observation definition file. In case that multiple event lists are given in an observation definition file, the tool will loop over all event lists and fill all events into a single counts cube. -ctbin generates a counts cube FITS file comprising three extensions. The +:ref:`ctbin` generates a counts cube FITS file comprising three extensions. The primary extension contains a 3-dimensional image that contains the counts cube values. The next extension named ``EBOUNDS`` contains a binary table that defines the energy boundaries of the counts cube. The last extension @@ -36,19 +36,26 @@ General parameters Output counts cube file. ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(usepnt = no) [boolean]`` Use CTA pointing direction for cube centre instead of xref/yref parameters? diff --git a/doc/source/users/reference_manual/ctbkgcube.rst b/doc/source/users/reference_manual/ctbkgcube.rst index 400009e..0b636e8 100644 --- a/doc/source/users/reference_manual/ctbkgcube.rst +++ b/doc/source/users/reference_manual/ctbkgcube.rst @@ -72,19 +72,26 @@ General parameters Output model XML file. ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(addbounds = no) [boolean]`` Add energies to the background cube at the observation energy boundaries? diff --git a/doc/source/users/reference_manual/ctbutterfly.rst b/doc/source/users/reference_manual/ctbutterfly.rst index 5a229af..41e1888 100644 --- a/doc/source/users/reference_manual/ctbutterfly.rst +++ b/doc/source/users/reference_manual/ctbutterfly.rst @@ -97,20 +97,27 @@ General parameters ``(matrix = "NONE") [file]`` Input covariance matrix file (not used) -``(ebinalg = "LOG") [string]`` - Butterfly energy binning algorithm. +``(ebinalg = LOG) [string]`` + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Minimum energy of butterfly (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Maximum energy of butterfly (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. -``(enumbins = 100) [string]`` - Number of energy bins of butterfly. +``(enumbins = 100) [integer]`` + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. -``(ebinfile = "NONE") [string]`` - File for energy binning algorithm. +``ebinfile [file]`` + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. Standard parameters diff --git a/doc/source/users/reference_manual/ctedispcube.rst b/doc/source/users/reference_manual/ctedispcube.rst index d0bbc66..f23d630 100644 --- a/doc/source/users/reference_manual/ctedispcube.rst +++ b/doc/source/users/reference_manual/ctedispcube.rst @@ -56,19 +56,26 @@ General parameters Output energy dispersion cube file. ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(addbounds = no) [boolean]`` Add energies to the energy dispersion cube at the observation energy boundaries? diff --git a/doc/source/users/reference_manual/ctexpcube.rst b/doc/source/users/reference_manual/ctexpcube.rst index 92393c5..2c2cf8d 100644 --- a/doc/source/users/reference_manual/ctexpcube.rst +++ b/doc/source/users/reference_manual/ctexpcube.rst @@ -63,19 +63,26 @@ General parameters Output exposure cube file. ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(addbounds = no) [boolean]`` Add energies to the exposure cube at the observation energy boundaries? diff --git a/doc/source/users/reference_manual/ctmapcube.rst b/doc/source/users/reference_manual/ctmapcube.rst index 0aa45ae..83ecadc 100644 --- a/doc/source/users/reference_manual/ctmapcube.rst +++ b/doc/source/users/reference_manual/ctmapcube.rst @@ -35,19 +35,26 @@ General parameters Sigma of Gaussian to be used for point sources (in arcmin). ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``nxpix [integer]`` Number of cube bins in Right Ascension or Galactic longitude. diff --git a/doc/source/users/reference_manual/ctmodel.rst b/doc/source/users/reference_manual/ctmodel.rst index 1a1e94c..d95480a 100644 --- a/doc/source/users/reference_manual/ctmodel.rst +++ b/doc/source/users/reference_manual/ctmodel.rst @@ -98,20 +98,27 @@ General parameters ``(deadc = 0.95) [real]`` Average deadtime correction factor. -``(ebinalg = LOG) [string]`` - Algorithm for defining energy bins. +``ebinalg [string]`` + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. -``(ebinfile = NONE) [file]`` - Name of the file containing the energy bin definition. +``ebinfile [file]`` + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(usepnt = no) [boolean]`` Use pointing instead of xref/yref parameters? diff --git a/doc/source/users/reference_manual/ctpsfcube.rst b/doc/source/users/reference_manual/ctpsfcube.rst index 1fabd0e..ce6099f 100644 --- a/doc/source/users/reference_manual/ctpsfcube.rst +++ b/doc/source/users/reference_manual/ctpsfcube.rst @@ -55,19 +55,26 @@ General parameters Output point spread function cube file. ``ebinalg [string]`` - Algorithm for defining energy bins. + Algorithm for defining energy bins. For ``FILE``, the energy bins are defined + in a FITS file that is specified by the ``ebinfile`` parameter, for ``LIN`` + and ``LOG`` there will be ``enumbins`` energy bins spaced linearly or + logarithmically between ``emin`` and ``emax``, respectively. ``emin [real]`` - Lower energy value for first energy bin (in TeV). + Lower energy value for first energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``emax [real]`` - Upper energy value for last energy bin (in TeV). + Upper energy value for last energy bin (in TeV) if ``LIN`` or ``LOG`` + energy binning algorithms are used. ``enumbins [integer]`` - Number of energy bins. + Number of energy bins if ``LIN`` or ``LOG`` energy binning algorithms are + used. ``ebinfile [file]`` - Name of the file containing the energy bin definition. + Name of the file containing the energy binning definition if ``ebinalg=FILE``. + You may use :ref:`csebins` to generate a file with appropriate energy binning. ``(addbounds = no) [boolean]`` Add energies to the point spread function cube at the observation energy boundaries? diff --git a/doc/source/users/reference_manual/ctselect.rst b/doc/source/users/reference_manual/ctselect.rst index 4b3748c..334c20d 100644 --- a/doc/source/users/reference_manual/ctselect.rst +++ b/doc/source/users/reference_manual/ctselect.rst @@ -52,37 +52,37 @@ General parameters ``ra [real]`` Right Ascension of acceptance cone (or ROI) centre (J2000, in degrees). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no ROI + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no ROI selection will be performed. ``dec [real]`` Declination of acceptance cone (or ROI) centre (J2000, in degrees). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no ROI + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no ROI selection will be performed. ``rad [real]`` Radius of acceptance cone (or ROI) centre (in degrees). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no ROI + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no ROI selection will be performed. ``tmin [time]`` Start time (UTC string, JD, MJD or time in seconds). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no time + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no time selection will be performed. ``tmax [time]`` Stop time (UTC string, JD, MJD or time in seconds). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no time + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no time selection will be performed. ``emin [real]`` Lower energy limit of events (in TeV). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no energy + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no energy selection will be performed. ``emax [real]`` Upper energy limit of events (in TeV). - If INDEF, NONE, UNDEF or UNDEFINED is passed as value, no energy + If ``INDEF``, ``NONE``, ``UNDEF`` or ``UNDEFINED`` is passed as value, no energy selection will be performed. ``(phase = NONE) [string]`` diff --git a/doc/source/users/reference_manual/cttsmap.rst b/doc/source/users/reference_manual/cttsmap.rst index f7c787d..683336c 100644 --- a/doc/source/users/reference_manual/cttsmap.rst +++ b/doc/source/users/reference_manual/cttsmap.rst @@ -104,7 +104,7 @@ General parameters ``(binmax = -1) [integer]`` Last bin to compute. -``(logLO = -1) [real]`` +``(logL0 = -1) [real]`` LogLikelihood value of null hypothesis. diff --git a/src/ctbin/ctbin.par b/src/ctbin/ctbin.par index 394479e..c8e6736 100644 --- a/src/ctbin/ctbin.par +++ b/src/ctbin/ctbin.par @@ -23,8 +23,8 @@ outcube, f, a, cntcube.fits,,, "Output counts cube file" # Energy binning parameters #========================== ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" -emin, r, a, 0.1,,, "Start value for first energy bin in TeV" -emax, r, a, 100.0,,, "Stop value for last energy bin in TeV" +emin, r, a, 0.1,,, "Lower energy limit (TeV)" +emax, r, a, 100.0,,, "Upper energy limit (TeV)" enumbins, i, a, 20,1,200, "Number of energy bins" ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" @@ -46,6 +46,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC publish, b, h, no,,, "Publish counts cube on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, ctbin.log,,, "Log filename" diff --git a/src/ctbkgcube/ctbkgcube.par b/src/ctbkgcube/ctbkgcube.par index 0922af8..d015a28 100644 --- a/src/ctbkgcube/ctbkgcube.par +++ b/src/ctbkgcube/ctbkgcube.par @@ -16,22 +16,22 @@ # # General parameters #=================== -inobs, f, a, "NONE",,, "Input event list or observation definition XML file" -inmodel, f, a, "NONE",,, "Input model definition XML file" -incube, f, a, "NONE",,, "Input counts cube file to extract background cube definition" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" -outcube, f, a, "bkgcube.fits",,, "Output background cube file" -outmodel, f, a, "NONE",,, "Output model definition XML file" +inobs, f, a, NONE,,, "Input event list or observation definition XML file" +inmodel, f, a, NONE,,, "Input model definition XML file" +incube, f, a, NONE,,, "Input counts cube file to extract background cube definition" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" +outcube, f, a, bkgcube.fits,,, "Output background cube file" +outmodel, f, a, NONE,,, "Output model definition XML file" # # Energy binning parameters #========================== -ebinalg, s, h, "LOG",FILE|LIN|LOG,, "Algorithm for defining energy bins" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" emin, r, a, 0.1,,, "Lower energy limit (TeV)" emax, r, a, 100.0,,, "Upper energy limit (TeV)" -enumbins, i, a, 20,,, "Number of energy bins" -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition" +enumbins, i, a, 20,1,200, "Number of energy bins" +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" addbounds, b, h, no,,, "Add energies at observation energy boundaries?" # @@ -52,6 +52,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC publish, b, h, no,,, "Publish sky map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctbkgcube.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctbkgcube.log,,, "Log filename" diff --git a/src/ctbutterfly/ctbutterfly.par b/src/ctbutterfly/ctbutterfly.par index f1c1c19..528dbcc 100644 --- a/src/ctbutterfly/ctbutterfly.par +++ b/src/ctbutterfly/ctbutterfly.par @@ -16,17 +16,17 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,,"Input event list, counts cube or observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -srcname, s, a, "Crab",,,"Source of interest" -expcube, f, a, "NONE",,, "Input exposure cube file" -psfcube, f, a, "NONE",,, "Input PSF cube file" -edispcube, f, a, "NONE",,, "Input energy dispersion cube file" -bkgcube, f, a, "NONE",,, "Input background cube file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, events.fits,,,"Input event list, counts cube or observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +srcname, s, a, Crab,,,"Source of interest" +expcube, f, a, NONE,,, "Input exposure cube file" +psfcube, f, a, NONE,,, "Input PSF cube file" +edispcube, f, a, NONE,,, "Input energy dispersion cube file" +bkgcube, f, a, NONE,,, "Input background cube file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" -outfile, f, a, "butterfly.txt",,, "Output ASCII file" +outfile, f, a, butterfly.txt,,, "Output ASCII file" method, s, h, GAUSSIAN, GAUSSIAN|ENVELOPE,,"Butterfly computation method" # @@ -35,22 +35,22 @@ method, s, h, GAUSSIAN, GAUSSIAN|ENVELOPE,,"Butterfly computation method" fit, b, h, no,,, "Perform maximum likelihood fitting?" confidence, r, h, 0.68,0.0,1.0, "Confidence level" statistic, s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic" -matrix, f, h, "NONE",,, "Input covariance Matrix FITS file" +matrix, f, h, NONE,,, "Input covariance Matrix FITS file" # # Energy binning parameters #========================== -ebinalg, s, h, "LOG", FILE|LIN|LOG,,"Algorithm for defining energy bins" -emin, r, a, 0.1,,,"Lower energy limit (TeV)" -emax, r, a, 100.0,,,"Upper energy limit (TeV)" -enumbins, i, h, 100,,,"Number of energy bins" -ebinfile, f, h, "NONE",,,"Name of the file containing the energy bin definition" +ebinalg, s, h, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" +emin, r, a, 0.1,,, "Lower energy limit (TeV)" +emax, r, a, 100.0,,, "Upper energy limit (TeV)" +enumbins, i, h, 100,1,1000, "Number of energy bins" +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" # # Standard parameters #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctbutterfly.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctbutterfly.log,,, "Log filename" diff --git a/src/ctcubemask/ctcubemask.par b/src/ctcubemask/ctcubemask.par index 60aaac1..381e423 100644 --- a/src/ctcubemask/ctcubemask.par +++ b/src/ctcubemask/ctcubemask.par @@ -16,9 +16,9 @@ # # General parameters #=================== -inobs, f, a, "cntcube.fits",,, "Input counts cube or observation definition XML file" -outcube, f, a, "cntcube_filtered.fits",,, "Output counts cube or observation definition XML file" -prefix, s, h, "filtered_",,, "Prefix for counts cube in observation definition XML file" +inobs, f, a, cntcube.fits,,, "Input counts cube or observation definition XML file" +outcube, f, a, cntcube_filtered.fits,,, "Output counts cube or observation definition XML file" +prefix, s, h, filtered_,,, "Prefix for counts cube in observation definition XML file" # # Selection parameters @@ -27,7 +27,7 @@ usepnt, b, h, no,,, "Use pointing instead of RA/DEC parameters?" ra, r, a, 83.63,0,360, "RA for ROI centre (degrees)" dec, r, a, 22.01,-90,90, "Dec for ROI centre (degrees)" rad, r, a, 3.0,0,180, "Radius of ROI (degrees)" -regfile, f, a, "NONE",,, "Input exclusion region file in ds9 format" +regfile, f, a, NONE,,, "Input exclusion region file in ds9 format" emin, r, a, 0.1,,, "Lower energy limit (TeV)" emax, r, a, 100.0,,, "Upper energy limit (TeV)" @@ -37,6 +37,6 @@ emax, r, a, 100.0,,, "Upper energy limit (TeV)" publish, b, h, no,,, "Publish counts cube on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctcubemask.par.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctcubemask.log,,, "Log filename" diff --git a/src/ctedispcube/ctedispcube.par b/src/ctedispcube/ctedispcube.par index 3fcd398..d91d62a 100644 --- a/src/ctedispcube/ctedispcube.par +++ b/src/ctedispcube/ctedispcube.par @@ -16,20 +16,20 @@ # # Observational parameters #=================== -inobs, f, a, "NONE",,, "Input event list or observation definition XML file" -incube, f, a, "NONE",,, "Input counts cube file to extract energy dispersion cube definition" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" -outcube, f, a, "edispcube.fits",,, "Output energy dispersion cube file" +inobs, f, a, NONE,,, "Input event list or observation definition XML file" +incube, f, a, NONE,,, "Input counts cube file to extract energy dispersion cube definition" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" +outcube, f, a, edispcube.fits,,, "Output energy dispersion cube file" # # Energy binning parameters #========================== -ebinalg, s, h, "LOG", FILE|LIN|LOG,, "Algorithm for defining energy bins" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" emin, r, a, 0.1,,, "Lower energy limit (TeV)" emax, r, a, 100.0,,, "Upper energy limit (TeV)" -enumbins, i, a, 20,,, "Number of energy bins" -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition" +enumbins, i, a, 20,1,200, "Number of energy bins" +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" addbounds, b, h, no,,, "Add energies at observation energy boundaries?" # @@ -55,6 +55,6 @@ migrabins, i, h, 100,,, "Number of migration bins" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctedispcube.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctedispcube.log,,, "Log filename" diff --git a/src/cterror/cterror.par b/src/cterror/cterror.par index ca5c3bf..c7cbfbe 100644 --- a/src/cterror/cterror.par +++ b/src/cterror/cterror.par @@ -17,17 +17,17 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definiton XML file" -srcname, s, a, "Crab",,, "Source of interest" -expcube, f, a, "NONE",,, "Input exposure cube file" -psfcube, f, a, "NONE",,, "Input PSF cube file" -edispcube,f, a, "NONE",,, "Input energy dispersion cube file" -bkgcube, f, a, "NONE",,, "Input background cube file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definiton XML file" +srcname, s, a, Crab,,, "Source of interest" +expcube, f, a, NONE,,, "Input exposure cube file" +psfcube, f, a, NONE,,, "Input PSF cube file" +edispcube,f, a, NONE,,, "Input energy dispersion cube file" +bkgcube, f, a, NONE,,, "Input background cube file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" -outmodel, f, a, "results.xml",,, "Output model definiton XML file" +outmodel, f, a, results.xml,,, "Output model definiton XML file" # # Error calculation parameters @@ -42,6 +42,6 @@ max_iter, i, h, 50,1,1000, "Maximum number of iterations" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "cterror.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, cterror.log,,, "Log filename" diff --git a/src/ctexpcube/ctexpcube.par b/src/ctexpcube/ctexpcube.par index f938860..bed9d15 100644 --- a/src/ctexpcube/ctexpcube.par +++ b/src/ctexpcube/ctexpcube.par @@ -16,20 +16,20 @@ # # General parameters #=================== -inobs, f, a, "NONE",,, "Input event list or observation definition XML file" -incube, f, a, "NONE",,, "Input counts cube file to extract exposure cube definition" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" -outcube, f, a, "expcube.fits",,, "Output exposure cube file" +inobs, f, a, NONE,,, "Input event list or observation definition XML file" +incube, f, a, NONE,,, "Input counts cube file to extract exposure cube definition" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" +outcube, f, a, expcube.fits,,, "Output exposure cube file" # # Energy binning parameters #========================== -ebinalg, s, h, "LOG", FILE|LIN|LOG,,"Algorithm for defining energy bins" -emin, r, a, 0.1,,,"Lower energy limit (TeV)" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" +emin, r, a, 0.1,,, "Lower energy limit (TeV)" emax, r, a, 100.0,,, "Upper energy limit (TeV)" -enumbins, i, a, 20,,, "Number of energy bins" -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition" +enumbins, i, a, 20,1,200, "Number of energy bins" +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" addbounds, b, h, no,,, "Add energies at observation energy boundaries?" # @@ -50,6 +50,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC publish, b, h, no,,, "Publish sky map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctexpcube.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctexpcube.log,,, "Log filename" diff --git a/src/ctlike/ctlike.par b/src/ctlike/ctlike.par index 1473cae..bb107d6 100644 --- a/src/ctlike/ctlike.par +++ b/src/ctlike/ctlike.par @@ -16,17 +16,17 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -expcube, f, a, "NONE",,, "Input exposure cube file" -psfcube, f, a, "NONE",,, "Input PSF cube file" -edispcube, f, a, "NONE",,, "Input energy dispersion cube file" -bkgcube, f, a, "NONE",,, "Input background cube file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +expcube, f, a, NONE,,, "Input exposure cube file" +psfcube, f, a, NONE,,, "Input PSF cube file" +edispcube, f, a, NONE,,, "Input energy dispersion cube file" +bkgcube, f, a, NONE,,, "Input background cube file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" -outmodel, f, a, "crab_results.xml",,, "Output model definition XML file" -outcovmat, f, h, "NONE",,, "Output covariance matrix FITS file" +outmodel, f, a, crab_results.xml,,, "Output model definition XML file" +outcovmat, f, h, NONE,,, "Output covariance matrix FITS file" # # Maximisation parameters @@ -40,6 +40,6 @@ fix_spat_for_ts, b, h, no,,, "Fix spatial parameters for TS computation?" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctlike.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctlike.log,,, "Log filename" diff --git a/src/ctmapcube/ctmapcube.par b/src/ctmapcube/ctmapcube.par index c233337..81d91fe 100644 --- a/src/ctmapcube/ctmapcube.par +++ b/src/ctmapcube/ctmapcube.par @@ -16,16 +16,16 @@ # # General parameters #=================== -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -outcube, f, a, "mapcube.fits",,, "Output map cube file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +outcube, f, a, mapcube.fits,,, "Output map cube file" ptsrcsig, r, h, 1.0,0,60, "Point source Gaussian sigma in arcmin" # # Energy binning parameters #========================== ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" -emin, r, a, 0.1,,, "Start value for first energy bin in TeV" -emax, r, a, 100.0,,, "Stop value for last energy bin in TeV" +emin, r, a, 0.1,,, "Lower energy limit (TeV)" +emax, r, a, 100.0,,, "Upper energy limit (TeV)" enumbins, i, a, 20,1,200, "Number of energy bins" ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" @@ -46,6 +46,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC publish, b, h, no,,, "Publish map cube on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctmapcube.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctmapcube.log,,, "Log filename" diff --git a/src/ctmodel/ctmodel.par b/src/ctmodel/ctmodel.par index d96c436..6e85fb9 100644 --- a/src/ctmodel/ctmodel.par +++ b/src/ctmodel/ctmodel.par @@ -16,17 +16,17 @@ # # General parameters #=================== -inobs, f, a, "NONE",,, "Input event list, counts cube or observation definition XML file" -incube, f, a, "NONE",,, "Input counts cube file to extract model cube definition" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -expcube, f, a, "NONE",,, "Input exposure cube file" -psfcube, f, a, "NONE",,, "Input PSF cube file" -edispcube,f, a, "NONE",,, "Input energy dispersion cube file" -bkgcube, f, a, "NONE",,, "Input background cube file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, NONE,,, "Input event list, counts cube or observation definition XML file" +incube, f, a, NONE,,, "Input counts cube file to extract model cube definition" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +expcube, f, a, NONE,,, "Input exposure cube file" +psfcube, f, a, NONE,,, "Input PSF cube file" +edispcube,f, a, NONE,,, "Input energy dispersion cube file" +bkgcube, f, a, NONE,,, "Input background cube file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" -outcube, f, a, "modcube.fits",,, "Output model cube file" +outcube, f, a, modcube.fits,,, "Output model cube file" # # Observation parameters @@ -41,11 +41,11 @@ deadc, r, h, 0.98,0,1, "Average deadtime correction factor" # # Energy binning parameters #========================== -ebinalg, s, h, "LOG",FILE|LIN|LOG,, "Algorithm for defining energy bins" -emin, r, a, 0.1,,, "Start value for first energy bin in TeV" -emax, r, a, 100.0,,, "Stop value for last energy bin in TeV" -enumbins, i, a, 20,,, "Number of energy bins" -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" +emin, r, a, 0.1,,, "Lower energy limit (TeV)" +emax, r, a, 100.0,,, "Upper energy limit (TeV)" +enumbins, i, a, 20,1,200, "Number of energy bins" +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" # # Spatial binning parameters @@ -65,6 +65,6 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DEC publish, b, h, no,,, "Publish model cube on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctmodel.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctmodel.log,,, "Log filename" diff --git a/src/ctobssim/ctobssim.par b/src/ctobssim/ctobssim.par index 28b81b7..e6398cf 100644 --- a/src/ctobssim/ctobssim.par +++ b/src/ctobssim/ctobssim.par @@ -46,6 +46,6 @@ eslices, i, h, 10,1,100, "Number of energy slices" publish, b, h, no,,, "Publish event list on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" +debug, b, h, no,,, "Activate debugging mode?" mode, s, h, ql,,, "Mode of automatic parameters" logfile, f, h, ctobssim.log,,, "Log filename" diff --git a/src/ctphase/ctphase.par b/src/ctphase/ctphase.par index adc9a1b..b8a476d 100644 --- a/src/ctphase/ctphase.par +++ b/src/ctphase/ctphase.par @@ -16,11 +16,11 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file" -outobs, f, a, "phased_events.fits",,, "Output event list or observation definition XML file" -prefix, s, h, "phased_",,, "Prefix for event lists in observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Model definition XML file" -srcname, s, a, "Crab",,, "Source in model definition XML file to use for phase computation" +inobs, f, a, events.fits,,, "Input event list or observation definition XML file" +outobs, f, a, phased_events.fits,,, "Output event list or observation definition XML file" +prefix, s, h, phased_,,, "Prefix for event lists in observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Model definition XML file" +srcname, s, a, Crab,,, "Source in model definition XML file to use for phase computation" # # Phase information parameters @@ -37,6 +37,6 @@ f2, r, a, 0.01,,, "Second frequency derivative at reference MJD (s^-3)" publish, b, h, no,,, "Publish event list on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctphase.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctphase.log,,, "Log filename" diff --git a/src/ctprob/ctprob.par b/src/ctprob/ctprob.par index 39ee4ec..522c454 100644 --- a/src/ctprob/ctprob.par +++ b/src/ctprob/ctprob.par @@ -16,12 +16,12 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file" -outobs, f, a, "prob_events.fits",,, "Output event list or observation definition XML file" -prefix, s, h, "prob_",,, "Prefix for event lists in observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, events.fits,,, "Input event list or observation definition XML file" +outobs, f, a, prob_events.fits,,, "Output event list or observation definition XML file" +prefix, s, h, prob_,,, "Prefix for event lists in observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" # @@ -30,6 +30,6 @@ edisp, b, h, no,,, "Apply energy dispersion?" publish, b, h, no,,, "Publish event list on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctprob.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctprob.log,,, "Log filename" diff --git a/src/ctpsfcube/ctpsfcube.par b/src/ctpsfcube/ctpsfcube.par index 6aab813..6051cdc 100644 --- a/src/ctpsfcube/ctpsfcube.par +++ b/src/ctpsfcube/ctpsfcube.par @@ -16,20 +16,20 @@ # # Observational parameters #=================== -inobs, f, a, "NONE",,, "Input event list or observation definition XML file" -incube, f, a, "NONE",,, "Input counts cube file to extract PSF cube definition" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" -outcube, f, a, "psfcube.fits",,, "Output PSF cube file" +inobs, f, a, NONE,,, "Input event list or observation definition XML file" +incube, f, a, NONE,,, "Input counts cube file to extract PSF cube definition" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" +outcube, f, a, psfcube.fits,,, "Output PSF cube file" # # Energy binning parameters #========================== -ebinalg, s, h, "LOG", FILE|LIN|LOG,, "Algorithm for defining energy bins" +ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining energy bins" emin, r, a, 0.1,,, "Lower energy limit (TeV)" emax, r, a, 100.0,,, "Upper energy limit (TeV)" -enumbins, i, a, 20,,, "Number of energy bins" -ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition" +enumbins, i, a, 20,1,200, "Number of energy bins" +ebinfile, f, a, NONE,,, "Name of the file containing the energy bin definition" addbounds, b, h, no,,, "Add energies at observation energy boundaries?" # @@ -55,6 +55,6 @@ anumbins, i, h, 200,,, "Number of angular separation bins" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctpsfcube.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctpsfcube.log,,, "Log filename" diff --git a/src/ctselect/ctselect.par b/src/ctselect/ctselect.par index 3956ca3..782e9cf 100644 --- a/src/ctselect/ctselect.par +++ b/src/ctselect/ctselect.par @@ -16,9 +16,9 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file" -outobs, f, a, "selected_events.fits",,, "Output event list or observation definition XML file" -prefix, s, h, "selected_",,, "Prefix for event lists in observation definition XML file" +inobs, f, a, events.fits,,, "Input event list or observation definition XML file" +outobs, f, a, selected_events.fits,,, "Output event list or observation definition XML file" +prefix, s, h, selected_,,, "Prefix for event lists in observation definition XML file" # # Selection parameters @@ -41,6 +41,6 @@ usethres,s, h, NONE,NONE|DEFAULT|USER,, "Energy threshold type" publish, b, h, no,,, "Publish event list on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctselect.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctselect.log,,, "Log filename" diff --git a/src/ctskymap/ctskymap.par b/src/ctskymap/ctskymap.par index 1256369..1a2f0f3 100644 --- a/src/ctskymap/ctskymap.par +++ b/src/ctskymap/ctskymap.par @@ -16,10 +16,10 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list or observation definition XML file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" -outmap, f, a, "skymap.fits",,, "Output skymap file" +inobs, f, a, events.fits,,, "Input event list or observation definition XML file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" +outmap, f, a, skymap.fits,,, "Output skymap file" # # Event selection parameters @@ -54,6 +54,6 @@ inexclusion, f, h, NONE,,, "Exclusion map or DS9 region file name" publish, b, h, no,,, "Publish sky map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctskymap.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctskymap.log,,, "Log filename" diff --git a/src/cttsmap/cttsmap.par b/src/cttsmap/cttsmap.par index de3f77e..33081e8 100644 --- a/src/cttsmap/cttsmap.par +++ b/src/cttsmap/cttsmap.par @@ -16,17 +16,17 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -srcname, s, a, "Crab",,, "Test source name" -expcube, f, a, "NONE",,, "Input exposure cube file" -psfcube, f, a, "NONE",,, "Input PSF cube file" -edispcube, f, a, "NONE",,, "Input energy dispersion cube file" -bkgcube, f, a, "NONE",,, "Input background cube file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +srcname, s, a, Crab,,, "Test source name" +expcube, f, a, NONE,,, "Input exposure cube file" +psfcube, f, a, NONE,,, "Input PSF cube file" +edispcube, f, a, NONE,,, "Input energy dispersion cube file" +bkgcube, f, a, NONE,,, "Input background cube file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" -outmap, f, a, "tsmap.fits",,, "Output Test Statistic map file" +outmap, f, a, tsmap.fits,,, "Output Test Statistic map file" # # TS map computation parameters @@ -51,7 +51,7 @@ yref, r, a, 22.01,-90,90, "Second coordinate of image center in degrees (DE #=========================================== binmin, i, h, -1,,, "First bin to compute" binmax, i, h, -1,,, "Last bin to compute" -logL0, r, h, 0.0,,, "LogLikelihood value of null hypothesis" +logL0, r, h, 0.0,,, "Log-likelihood value of null hypothesis" # # Standard parameters @@ -59,6 +59,6 @@ logL0, r, h, 0.0,,, "LogLikelihood value of null hypothesis" publish, b, h, no,,, "Publish Test Statistic map on VO Hub?" chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "cttsmap.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, cttsmap.log,,, "Log filename" diff --git a/src/ctulimit/ctulimit.par b/src/ctulimit/ctulimit.par index 7a0caad..a3b1516 100644 --- a/src/ctulimit/ctulimit.par +++ b/src/ctulimit/ctulimit.par @@ -16,15 +16,15 @@ # # General parameters #=================== -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file" -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model definition XML file" -srcname, s, a, "Crab",,, "Source of interest" -expcube, f, a, "NONE",,, "Input exposure cube file" -psfcube, f, a, "NONE",,, "Input PSF cube file" -edispcube,f, a, "NONE",,, "Input energy dispersion cube file" -bkgcube, f, a, "NONE",,, "Input background cube file" -caldb, s, a, "prod2",,, "Calibration database" -irf, s, a, "South_0.5h",,, "Instrument response function" +inobs, f, a, events.fits,,, "Input event list, counts cube or observation definition XML file" +inmodel, f, a, $CTOOLS/share/models/crab.xml,,, "Input model definition XML file" +srcname, s, a, Crab,,, "Source of interest" +expcube, f, a, NONE,,, "Input exposure cube file" +psfcube, f, a, NONE,,, "Input PSF cube file" +edispcube,f, a, NONE,,, "Input energy dispersion cube file" +bkgcube, f, a, NONE,,, "Input background cube file" +caldb, s, a, prod2,,, "Calibration database" +irf, s, a, South_0.5h,,, "Instrument response function" edisp, b, h, no,,, "Apply energy dispersion?" # @@ -45,6 +45,6 @@ max_iter, i, h, 50,1,1000, "Maximum number of iterations" #==================== chatter, i, h, 2,0,4, "Chattiness of output" clobber, b, h, yes,,, "Overwrite existing output files with new output files?" -debug, b, h, no,,, "Debugging mode activated" -mode, s, h, "ql",,, "Mode of automatic parameters" -logfile, f, h, "ctulimit.log",,, "Log filename" +debug, b, h, no,,, "Activate debugging mode?" +mode, s, h, ql,,, "Mode of automatic parameters" +logfile, f, h, ctulimit.log,,, "Log filename" -- libgit2 0.21.4