Commit d7bba398697936e344c4fcdd0c1f964bf53444aa

Authored by Jürgen Knödlseder
1 parent 527a4d1f

Homogenise query text for parameter files.

cscripts/cslightcrv.py
... ... @@ -98,10 +98,10 @@ class cslightcrv(ctools.cscript):
98 98  
99 99 # Create default parfile
100 100 pars = gammalib.GApplicationPars()
101   - pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition file"))
102   - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model"))
  101 + pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition XML file"))
  102 + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file"))
103 103 pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name"))
104   - pars.append(gammalib.GApplicationPar("outfile","f","a","lightcurve.fits","","","Output file name"))
  104 + pars.append(gammalib.GApplicationPar("outfile","f","a","lightcurve.fits","","","Output lightcurve file"))
105 105 pars.append(gammalib.GApplicationPar("expcube","f","a","NONE","","","Exposure cube file (only needed for stacked analysis)"))
106 106 pars.append(gammalib.GApplicationPar("psfcube","f","a","NONE","","","PSF cube file (only needed for stacked analysis)"))
107 107 pars.append(gammalib.GApplicationPar("bkgcube","s","a","NONE","","","Background cube file (only needed for stacked analysis)"))
... ...
cscripts/csobsdef.py
... ... @@ -128,8 +128,8 @@ class csobsdef(ctools.cscript):
128 128  
129 129 # Create default parfile
130 130 pars = gammalib.GApplicationPars()
131   - pars.append(gammalib.GApplicationPar("inpnt","f","a","NONE","","","Pointing definition file"))
132   - pars.append(gammalib.GApplicationPar("outobs","f","a","obs.xml","","","Output observation definition file"))
  131 + pars.append(gammalib.GApplicationPar("inpnt","f","a","NONE","","","Input pointing definition file"))
  132 + pars.append(gammalib.GApplicationPar("outobs","f","a","obs.xml","","","Output observation definition XML file"))
133 133 pars.append(gammalib.GApplicationPar("duration","r","a","1800.0","","","Pointing duration (seconds)"))
134 134 pars.append(gammalib.GApplicationPar("caldb","s","h","","","","Calibration database"))
135 135 pars.append(gammalib.GApplicationPar("irf","s","h","","","","Instrument response function"))
... ...
cscripts/cspull.py
... ... @@ -101,9 +101,9 @@ class cspull(ctools.cscript):
101 101  
102 102 # Create default parfile
103 103 pars = gammalib.GApplicationPars()
104   - pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition file"))
105   - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model"))
106   - pars.append(gammalib.GApplicationPar("outfile","f","a","pull.dat","","","Output file name"))
  104 + pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition XML file"))
  105 + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file"))
  106 + pars.append(gammalib.GApplicationPar("outfile","f","a","pull.dat","","","Output pull distribution file"))
107 107 pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database"))
108 108 pars.append(gammalib.GApplicationPar("irf","s","a","South_50h","","","Instrument response function"))
109 109 pars.append(gammalib.GApplicationPar("deadc","r","h","0.95","0","1","Deadtime correction factor"))
... ...
cscripts/csresmap.py
... ... @@ -103,12 +103,12 @@ class csresmap(ctools.cscript):
103 103  
104 104 # Create default parfile
105 105 pars = gammalib.GApplicationPars()
106   - pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition file"))
  106 + pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition XML file"))
107 107 pars.append(gammalib.GApplicationPar("modcube","f","a","NONE","","","Model cube file (generated with ctmodel)"))
108 108 pars.append(gammalib.GApplicationPar("expcube","f","a","NONE","","","Exposure cube file (only needed for stacked analysis)"))
109 109 pars.append(gammalib.GApplicationPar("psfcube","f","a","NONE","","","PSF cube file (only needed for stacked analysis)"))
110 110 pars.append(gammalib.GApplicationPar("bkgcube","f","a","NONE","","","Background cube file (only needed for stacked analysis)"))
111   - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model"))
  111 + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file"))
112 112 pars.append(gammalib.GApplicationPar("outmap","f","a","resmap.fits","","","Output residual map"))
113 113 pars.append(gammalib.GApplicationPar("edisp","b","h","no","","","Apply energy dispersion?"))
114 114 pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database"))
... ...
cscripts/cssens.py
... ... @@ -97,14 +97,14 @@ class cssens(ctools.cscript):
97 97  
98 98 # Create default parfile
99 99 pars = gammalib.GApplicationPars()
100   - pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition file"))
101   - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model"))
  100 + pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition XML file"))
  101 + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file"))
102 102 pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name"))
103 103 pars.append(gammalib.GApplicationPar("offset","r","h","0.0","","","Source offset angle (deg)"))
104 104 pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database"))
105 105 pars.append(gammalib.GApplicationPar("irf","s","a","South_50h","","","Instrument response function"))
106 106 pars.append(gammalib.GApplicationPar("deadc","r","h","0.95","0","1","Deadtime correction factor"))
107   - pars.append(gammalib.GApplicationPar("outfile","f","h","sensitivity.dat","","","Output file name"))
  107 + pars.append(gammalib.GApplicationPar("outfile","f","h","sensitivity.dat","","","Output sensitivity file"))
108 108 pars.append(gammalib.GApplicationPar("duration","r","a","180000.0","","","Effective exposure time (s)"))
109 109 pars.append(gammalib.GApplicationPar("rad","r","a","5.0","","","Radius of ROI (deg)"))
110 110 pars.append(gammalib.GApplicationPar("edisp","b","h","no","","","Apply energy dispersion?"))
... ...
cscripts/csspec.py
... ... @@ -100,10 +100,10 @@ class csspec(ctools.cscript):
100 100  
101 101 # Create default parfile
102 102 pars = gammalib.GApplicationPars()
103   - pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition file"))
104   - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model"))
  103 + pars.append(gammalib.GApplicationPar("inobs","f","a","events.fits","","","Event list, counts cube, or observation definition XML file"))
  104 + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file"))
105 105 pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name"))
106   - pars.append(gammalib.GApplicationPar("outfile","f","a","spectrum.fits","","","Output file name"))
  106 + pars.append(gammalib.GApplicationPar("outfile","f","a","spectrum.fits","","","Output spectrum file"))
107 107 pars.append(gammalib.GApplicationPar("expcube","f","a","NONE","","","Exposure cube file (only needed for stacked analysis)"))
108 108 pars.append(gammalib.GApplicationPar("psfcube","f","a","NONE","","","PSF cube file (only needed for stacked analysis)"))
109 109 pars.append(gammalib.GApplicationPar("bkgcube","f","a","NONE","","","Background cube file (only needed for stacked analysis)"))
... ...
cscripts/cstsdist.py
... ... @@ -94,10 +94,10 @@ class cstsdist(ctools.cscript):
94 94  
95 95 # Create default parfile
96 96 pars = gammalib.GApplicationPars()
97   - pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition file"))
98   - pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Source model"))
  97 + pars.append(gammalib.GApplicationPar("inobs","f","h","NONE","","","Event list, counts cube, or observation definition XML file"))
  98 + pars.append(gammalib.GApplicationPar("inmodel","f","a","$CTOOLS/share/models/crab.xml","","","Input model XML file"))
99 99 pars.append(gammalib.GApplicationPar("srcname","s","a","Crab","","","Source name"))
100   - pars.append(gammalib.GApplicationPar("outfile","f","a","ts.dat","","","Output file name"))
  100 + pars.append(gammalib.GApplicationPar("outfile","f","a","ts.dat","","","Output Test Statistics distribution file"))
101 101 pars.append(gammalib.GApplicationPar("expcube","s","a","NONE","","","Exposure cube file (only needed for stacked analysis)"))
102 102 pars.append(gammalib.GApplicationPar("psfcube","s","a","NONE","","","PSF cube file (only needed for stacked analysis)"))
103 103 pars.append(gammalib.GApplicationPar("bkgcube","s","a","NONE","","","Background cube file (only needed for stacked analysis)"))
... ...
doc/source/reference_manual/ctbin.rst
... ... @@ -106,4 +106,6 @@ Standard parameters
106 106 Related tools
107 107 -------------
108 108  
109   -None
  109 +:doc:`ctexpcube`
  110 +:doc:`ctpsfcube`
  111 +:doc:`ctbkgcube`
... ...
src/ctbin/ctbin.par
... ... @@ -17,7 +17,7 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Event list or observation definition file"
  20 +inobs, f, a, "events.fits",,, "Event list or observation definition XML file"
21 21 outcube, f, a, "cntcube.fits",,, "Output counts cube"
22 22 #
23 23 # Energy binning parameters
... ...
src/ctbkgcube/ctbkgcube.par
... ... @@ -17,7 +17,7 @@
17 17 #
18 18 # Observational parameters
19 19 #===================
20   -inobs, f, a, "NONE",,, "Input event list or observation definition file"
  20 +inobs, f, a, "NONE",,, "Input event list or observation definition XML file"
21 21 inmodel, f, a, "NONE",,, "Input model XML file"
22 22 incube, f, a, "NONE",,, "Counts cube for background cube definition"
23 23 outcube, f, a, "bkgcube.fits",,, "Output background cube file"
... ...
src/ctbutterfly/ctbutterfly.par
... ... @@ -17,8 +17,8 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,,"Input event list, counts cube or observation definition file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model"
  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 XML file"
22 22 srcname, s, a, "Crab",,,"Source of interest"
23 23 expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)"
24 24 psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)"
... ... @@ -26,7 +26,7 @@ bkgcube, f, a, "NONE",,, "Background cube file (only needed for stacked analy
26 26 caldb, s, a, "prod2",,, "Calibration database"
27 27 irf, s, a, "South_50h",,, "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 refit, b, h, no,,, "Do refitting?"
31 31 confidence, r, h, 0.68,0.0,1.0, "Confidence level"
32 32 matrix, f, h, "NONE",,, "Input covariance Matrix FITS file"
... ...
src/ctcubemask/ctcubemask.par
... ... @@ -17,7 +17,7 @@
17 17 #
18 18 # File information
19 19 #=================
20   -inobs, f, a, "cntmap.fits",,, "Input counts cube or observation definition file"
  20 +inobs, f, a, "cntmap.fits",,, "Input counts cube or observation definition XML file"
21 21 regfile, f, a, "NONE",,, "Exclusion region file in ds9 format"
22 22 outcube, f, a, "filtered_cube.fits",,, "Output counts cube or observation definition file"
23 23 prefix, s, h, "filtered_",,, "Prefix for counts cube in observation definition file"
... ...
src/cterror/cterror.par
... ... @@ -18,9 +18,9 @@
18 18 #
19 19 # General parameters
20 20 #===================
21   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition file"
22   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model"
23   -outmodel, f, a, "results.xml",,, "Source model output file"
  21 +inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
  22 +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file"
  23 +outmodel, f, a, "results.xml",,, "Output model XML file"
24 24 srcname, s, a, "Crab",,, "Source of interest"
25 25 expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)"
26 26 psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)"
... ...
src/ctexpcube/ctexpcube.par
... ... @@ -17,7 +17,7 @@
17 17 #
18 18 # Observational parameters
19 19 #===================
20   -inobs, f, a, "NONE",,, "Event list or observation definition file"
  20 +inobs, f, a, "NONE",,, "Event list or observation definition XML file"
21 21 incube, f, a, "NONE",,, "Counts cube for exposure cube definition"
22 22 outcube, f, a, "expcube.fits",,, "Output exposure cube file"
23 23 caldb, s, a, "prod2",,, "Calibration database"
... ...
src/ctlike/ctlike.par
... ... @@ -17,18 +17,18 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Event list, counts cube or observation definition file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model"
  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 XML file"
22 22 expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)"
23 23 psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)"
24 24 bkgcube, f, a, "NONE",,, "Background cube file (only needed for stacked analysis)"
25 25 caldb, s, a, "prod2",,, "Calibration database"
26 26 irf, s, a, "South_50h",,, "Instrument response function"
27   -outmodel, f, a, "crab_results.xml",,, "Source model output file"
  27 +outmodel, f, a, "crab_results.xml",,, "Output model XML file"
28 28 stat, s, h, "POISSON",,, "Optimization statistics"
29 29 edisp, b, h, no,,, "Apply energy dispersion?"
30 30 refit, b, h, no,,, "Do refitting?"
31   -fix_spat_for_ts, b, h, no,,,"Fix spatial parameters for TS computation?"
  31 +fix_spat_for_ts, b, h, no,,, "Fix spatial parameters for TS computation?"
32 32  
33 33 #
34 34 # Standard parameters
... ...
src/ctmodel/ctmodel.par
... ... @@ -18,7 +18,7 @@
18 18 # General parameters
19 19 #===================
20 20 incube, f, a, "NONE",,, "Input counts cube"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model"
  21 +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file"
22 22 outcube, f, a, "modcube.fits",,, "Output model cube"
23 23 edisp, b, h, no,,, "Apply energy dispersion?"
24 24 #
... ...
src/ctobssim/ctobssim.par
... ... @@ -17,10 +17,10 @@
17 17 #
18 18 # File information
19 19 #=================
20   -inobs, f, h, "NONE",,, "Input event list or observation definition file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Model"
22   -outevents, f, a, "events.fits",,, "Output event data file or observation definition file"
23   -prefix, s, h, "sim_events_",,, "Prefix for event lists in observation definition file"
  20 +inobs, f, h, "NONE",,, "Input event list or observation definition XML file"
  21 +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file"
  22 +outevents, f, a, "events.fits",,, "Output event data file or observation definition XML file"
  23 +prefix, s, h, "sim_events_",,, "Prefix for event lists in observation definition XML file"
24 24 #
25 25 # Observation parameters
26 26 #=======================
... ...
src/ctpsfcube/ctpsfcube.par
... ... @@ -17,7 +17,7 @@
17 17 #
18 18 # Observational parameters
19 19 #===================
20   -inobs, f, a, "NONE",,, "Event list or observation definition file"
  20 +inobs, f, a, "NONE",,, "Event list or observation definition XML file"
21 21 incube, f, a, "NONE",,, "Counts cube for psf cube definition"
22 22 outcube, f, a, "psfcube.fits",,, "Output psf cube file"
23 23 caldb, s, a, "prod2",,, "Calibration database"
... ...
src/ctselect/ctselect.par
... ... @@ -17,9 +17,9 @@
17 17 #
18 18 # File information
19 19 #=================
20   -inobs, f, a, "events.fits",,, "Input event list or observation definition file"
21   -outobs, f, a, "selected_events.fits",,, "Output event list or observation definition file"
22   -prefix, s, h, "selected_",,, "Prefix for event lists in observation definition file"
  20 +inobs, f, a, "events.fits",,, "Input event list or observation definition XML file"
  21 +outobs, f, a, "selected_events.fits",,, "Output event list or observation definition XML file"
  22 +prefix, s, h, "selected_",,, "Prefix for event lists in observation definition XML file"
23 23 #
24 24 # Selection parameters
25 25 #=====================
... ...
src/ctskymap/ctskymap.par
... ... @@ -17,8 +17,8 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Event list or observation definition file"
21   -outmap, f, a, "skymap.fits",,, "Output file name"
  20 +inobs, f, a, "events.fits",,, "Event list or observation definition XML file"
  21 +outmap, f, a, "skymap.fits",,, "Output skymap file"
22 22 #
23 23 # Event selection parameters
24 24 #===========================
... ...
src/cttsmap/cttsmap.par
... ... @@ -17,8 +17,8 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model"
  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 XML file"
22 22 srcname, s, a, "Crab",,, "Test source"
23 23 expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)"
24 24 psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)"
... ...
src/ctulimit/ctulimit.par
... ... @@ -17,8 +17,8 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Source model"
  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 XML file"
22 22 srcname, s, a, "Crab",,, "Source of interest"
23 23 expcube, f, a, "NONE",,, "Exposure cube file (only needed for stacked analysis)"
24 24 psfcube, f, a, "NONE",,, "PSF cube file (only needed for stacked analysis)"
... ...