Pierrick Martin / ctools

Commit be837518219ca72e9e3b5ed74283306646e7f529

Authored by Jürgen Knödlseder
1 parent 22b35494

Change order of parameters and update documentation.

Inline Side-by-side
Showing 2 changed files with 18 additions and 12 deletions
doc/source/reference_manual/cspull.rst
  View file @be83751
@@ -41,6 +41,9 @@ General parameters @@ -41,6 +41,9 @@ General parameters
41 ``irf [string]`` 41 ``irf [string]``
42 Instrumental response function. 42 Instrumental response function.
43 43
  44 +``(deadc = 0.95) [real]``
  45 + Average deadtime correction factor.
  46 +
44 ``(edisp = no) [boolean]`` 47 ``(edisp = no) [boolean]``
45 Apply energy dispersion to response computation. 48 Apply energy dispersion to response computation.
46 49
@@ -62,12 +65,18 @@ General parameters @@ -62,12 +65,18 @@ General parameters
62 ``enumbins [integer]`` 65 ``enumbins [integer]``
63 Number of energy bins (0=unbinned). 66 Number of energy bins (0=unbinned).
64 67
65 -``duration [real]``  
66 - Duration of observation (in seconds). 68 +``(tmin = 0.0) [real]``
  69 + Start time (in seconds).
67 70
68 -``(deadc = 0.95) [real]``  
69 - Average deadtime correction factor. 71 +``tmax [real]``
  72 + Stop time (in seconds).
  73 +
  74 +``npix [integer]``
  75 + Number of pixels for binned analysis.
70 76
  77 +``binsz [real]``
  78 + Pixel size for binned analysis.
  79 +
71 ``(rad = 5.0) [real]`` 80 ``(rad = 5.0) [real]``
72 ROI radius (in degrees). 81 ROI radius (in degrees).
73 82
@@ -77,12 +86,6 @@ General parameters @@ -77,12 +86,6 @@ General parameters
77 ``(offset = 1.5) [real]`` 86 ``(offset = 1.5) [real]``
78 Observation pattern offset (in degrees). 87 Observation pattern offset (in degrees).
79 88
80 -``(npix = 200) [integer]``  
81 - Number of pixels for binned analysis.  
82 -  
83 -``(binsz = 0.05) [real]``  
84 - Pixel size for binned analysis.  
85 -  
86 89
87 Standard parameters 90 Standard parameters
88 ------------------- 91 -------------------
@@ -108,6 +111,9 @@ Standard parameters @@ -108,6 +111,9 @@ Standard parameters
108 ``(mode = ql) [string]`` 111 ``(mode = ql) [string]``
109 Mode of automatic parameters (default is "ql", i.e. "query and learn"). 112 Mode of automatic parameters (default is "ql", i.e. "query and learn").
110 113
  114 +``(logfile = cspull.log) [string]``
  115 + Log filename.
  116 +
111 117
112 Related tools 118 Related tools
113 ------------- 119 -------------
scripts/cspull.py
  View file @be83751
@@ -101,18 +101,18 @@ class cspull(ctools.cscript): @@ -101,18 +101,18 @@ class cspull(ctools.cscript):
101 pars.append(gammalib.GApplicationPar("bkgcube","s","a","NONE","","","Background cube file (only needed for stacked analysis)")) 101 pars.append(gammalib.GApplicationPar("bkgcube","s","a","NONE","","","Background cube file (only needed for stacked analysis)"))
102 pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database")) 102 pars.append(gammalib.GApplicationPar("caldb","s","a","prod2","","","Calibration database"))
103 pars.append(gammalib.GApplicationPar("irf","s","a","South_50h","","","Instrument response function")) 103 pars.append(gammalib.GApplicationPar("irf","s","a","South_50h","","","Instrument response function"))
  104 + pars.append(gammalib.GApplicationPar("deadc","r","h","0.95","0","1","Deadtime correction factor"))
104 pars.append(gammalib.GApplicationPar("edisp","b","h","no","","","Apply energy dispersion?")) 105 pars.append(gammalib.GApplicationPar("edisp","b","h","no","","","Apply energy dispersion?"))
105 pars.append(gammalib.GApplicationPar("ntrials","i","a","10","","","Number of trials")) 106 pars.append(gammalib.GApplicationPar("ntrials","i","a","10","","","Number of trials"))
106 pars.append(gammalib.GApplicationPar("ra","r","a","83.6331","0","360","RA of pointing (deg)")) 107 pars.append(gammalib.GApplicationPar("ra","r","a","83.6331","0","360","RA of pointing (deg)"))
107 pars.append(gammalib.GApplicationPar("dec","r","a","22.0145","-90","90","Dec of pointing (deg)")) 108 pars.append(gammalib.GApplicationPar("dec","r","a","22.0145","-90","90","Dec of pointing (deg)"))
108 pars.append(gammalib.GApplicationPar("emin","r","a","0.1","","","Lower energy limit (TeV)")) 109 pars.append(gammalib.GApplicationPar("emin","r","a","0.1","","","Lower energy limit (TeV)"))
109 pars.append(gammalib.GApplicationPar("emax","r","a","100.0","","","Upper energy limit (TeV)")) 110 pars.append(gammalib.GApplicationPar("emax","r","a","100.0","","","Upper energy limit (TeV)"))
  111 + pars.append(gammalib.GApplicationPar("enumbins","i","a","0","","","Number of energy bins (0=unbinned)"))
110 pars.append(gammalib.GApplicationPar("tmin","r","h","0.0","","","Start time (MET in s)")) 112 pars.append(gammalib.GApplicationPar("tmin","r","h","0.0","","","Start time (MET in s)"))
111 pars.append(gammalib.GApplicationPar("tmax","r","a","1800.0","","","Duration (in s)")) 113 pars.append(gammalib.GApplicationPar("tmax","r","a","1800.0","","","Duration (in s)"))
112 - pars.append(gammalib.GApplicationPar("enumbins","i","a","0","","","Number of energy bins (0=unbinned)"))  
113 pars.append(gammalib.GApplicationPar("npix","i","a","200","","","Number of pixels for binned")) 114 pars.append(gammalib.GApplicationPar("npix","i","a","200","","","Number of pixels for binned"))
114 pars.append(gammalib.GApplicationPar("binsz","r","a","0.05","","","Pixel size for binned (deg/pixel)")) 115 pars.append(gammalib.GApplicationPar("binsz","r","a","0.05","","","Pixel size for binned (deg/pixel)"))
115 - pars.append(gammalib.GApplicationPar("deadc","r","h","0.95","0","1","Deadtime correction factor"))  
116 pars.append(gammalib.GApplicationPar("rad","r","h","5.0","0","180","Radius of ROI (deg)")) 116 pars.append(gammalib.GApplicationPar("rad","r","h","5.0","0","180","Radius of ROI (deg)"))
117 pars.append(gammalib.GApplicationPar("pattern","s","h","single","","","Observation pattern (single/four)")) 117 pars.append(gammalib.GApplicationPar("pattern","s","h","single","","","Observation pattern (single/four)"))
118 pars.append(gammalib.GApplicationPar("offset","r","h","1.5","","","Observation pattern offset (deg)")) 118 pars.append(gammalib.GApplicationPar("offset","r","h","1.5","","","Observation pattern offset (deg)"))