Andreas Specovius / ctools

Commit 96aa9f4e866ebf7926c7580dc2d6cde263fe52b2

Authored by Jürgen Knödlseder
1 parent 392c2429

Homogenise parameter text.

Inline Side-by-side
Showing 10 changed files with 47 additions and 48 deletions
doc/source/reference_manual/ctbkgcube.rst
  View file @96aa9f4
@@ -54,13 +54,7 @@ General parameters @@ -54,13 +54,7 @@ General parameters
54 Input model XML file. 54 Input model XML file.
55 55
56 ``incube [file]`` 56 ``incube [file]``
57 - Counts cube file to extract background cube definition.  
58 -  
59 -``outcube [file]``  
60 - Output background cube file.  
61 -  
62 -``outmodel [file]``  
63 - Output model XML file. 57 + Input counts cube file to extract background cube definition.
64 58
65 ``caldb [string]`` 59 ``caldb [string]``
66 Calibration database. 60 Calibration database.
@@ -68,6 +62,12 @@ General parameters @@ -68,6 +62,12 @@ General parameters
68 ``irf [string]`` 62 ``irf [string]``
69 Instrument response function. 63 Instrument response function.
70 64
  65 +``outcube [file]``
  66 + Output background cube file.
  67 +
  68 +``outmodel [file]``
  69 + Output model XML file.
  70 +
71 ``ebinalg <FILE|LIN|LOG> [string]`` 71 ``ebinalg <FILE|LIN|LOG> [string]``
72 Algorithm for defining energy bins. 72 Algorithm for defining energy bins.
73 73
doc/source/reference_manual/ctbutterfly.rst
  View file @96aa9f4
@@ -28,19 +28,19 @@ General parameters @@ -28,19 +28,19 @@ General parameters
28 Input event list, counts cube or observation definition XML file. 28 Input event list, counts cube or observation definition XML file.
29 29
30 ``inmodel [file]`` 30 ``inmodel [file]``
31 - Model XML file containing the source and background definitions. 31 + Input model XML file.
32 32
33 ``srcname [string]`` 33 ``srcname [string]``
34 Name of model component for which butterfly should be computed. 34 Name of model component for which butterfly should be computed.
35 35
36 ``expcube [file]`` 36 ``expcube [file]``
37 - Exposure cube file (only needed for stacked analysis). 37 + Input exposure cube file (only needed for stacked analysis).
38 38
39 ``psfcube [file]`` 39 ``psfcube [file]``
40 - PSF cube file (only needed for stacked analysis). 40 + Input PSF cube file (only needed for stacked analysis).
41 41
42 ``bkgcube [file]`` 42 ``bkgcube [file]``
43 - Background cube file (only needed for stacked analysis). 43 + Input background cube file (only needed for stacked analysis).
44 44
45 ``caldb [string]`` 45 ``caldb [string]``
46 Calibration database. 46 Calibration database.
doc/source/reference_manual/cterror.rst
  View file @96aa9f4
@@ -21,22 +21,19 @@ General parameters @@ -21,22 +21,19 @@ General parameters
21 Input event list, counts cube or observation definition XML file. 21 Input event list, counts cube or observation definition XML file.
22 22
23 ``inmodel [file]`` 23 ``inmodel [file]``
24 - Model XML file containing the source and background definitions.  
25 -  
26 -``outmodel [file]``  
27 - Model XML file with updated error information. 24 + Input model XML file.
28 25
29 ``srcname [string]`` 26 ``srcname [string]``
30 Name of model component for which upper limit should be computed. 27 Name of model component for which upper limit should be computed.
31 28
32 ``expcube [file]`` 29 ``expcube [file]``
33 - Exposure cube file (only needed for stacked analysis). 30 + Input exposure cube file (only needed for stacked analysis).
34 31
35 ``psfcube [file]`` 32 ``psfcube [file]``
36 - PSF cube file (only needed for stacked analysis). 33 + Input PSF cube file (only needed for stacked analysis).
37 34
38 ``bkgcube [file]`` 35 ``bkgcube [file]``
39 - Background cube file (only needed for stacked analysis). 36 + Input background cube file (only needed for stacked analysis).
40 37
41 ``caldb [string]`` 38 ``caldb [string]``
42 Calibration database. 39 Calibration database.
@@ -47,6 +44,9 @@ General parameters @@ -47,6 +44,9 @@ General parameters
47 ``(edisp = no) [boolean]`` 44 ``(edisp = no) [boolean]``
48 Applies energy dispersion to response computation. 45 Applies energy dispersion to response computation.
49 46
  47 +``outmodel [file]``
  48 + Output model XML file with updated error information.
  49 +
50 ``(confidence = 0.68) [real]`` 50 ``(confidence = 0.68) [real]``
51 Confidence level for error computation. 51 Confidence level for error computation.
52 52
doc/source/reference_manual/ctexpcube.rst
  View file @96aa9f4
@@ -45,10 +45,7 @@ General parameters @@ -45,10 +45,7 @@ General parameters
45 Input event list or observation definition XML file. 45 Input event list or observation definition XML file.
46 46
47 ``incube [file]`` 47 ``incube [file]``
48 - Counts cube file to extract exposure cube definition.  
49 -  
50 -``outcube [file]``  
51 - Output exposure cube file. 48 + Input counts cube file to extract exposure cube definition.
52 49
53 ``caldb [string]`` 50 ``caldb [string]``
54 Calibration database. 51 Calibration database.
@@ -59,6 +56,9 @@ General parameters @@ -59,6 +56,9 @@ General parameters
59 ``(edisp = no) [boolean]`` 56 ``(edisp = no) [boolean]``
60 Apply energy dispersion for response computation? 57 Apply energy dispersion for response computation?
61 58
  59 +``outcube [file]``
  60 + Output exposure cube file.
  61 +
62 ``ebinalg <FILE|LIN|LOG> [string]`` 62 ``ebinalg <FILE|LIN|LOG> [string]``
63 Algorithm for defining energy bins. 63 Algorithm for defining energy bins.
64 64
doc/source/reference_manual/ctlike.rst
  View file @96aa9f4
@@ -63,13 +63,13 @@ General parameters @@ -63,13 +63,13 @@ General parameters
63 Input model XML file. 63 Input model XML file.
64 64
65 ``expcube [file]`` 65 ``expcube [file]``
66 - Exposure cube file (only needed for stacked analysis). 66 + Input exposure cube file (only needed for stacked analysis).
67 67
68 ``psfcube [file]`` 68 ``psfcube [file]``
69 - PSF cube file (only needed for stacked analysis). 69 + Input PSF cube file (only needed for stacked analysis).
70 70
71 ``bkgcube [file]`` 71 ``bkgcube [file]``
72 - Background cube file (only needed for stacked analysis). 72 + Input background cube file (only needed for stacked analysis).
73 73
74 ``caldb [string]`` 74 ``caldb [string]``
75 Calibration database. 75 Calibration database.
doc/source/reference_manual/ctobssim.rst
  View file @96aa9f4
@@ -23,14 +23,7 @@ General parameters @@ -23,14 +23,7 @@ General parameters
23 simulation. 23 simulation.
24 24
25 ``inmodel [file]`` 25 ``inmodel [file]``
26 - XML file that describes the astrophysical sources and the instrumental  
27 - background model.  
28 -  
29 -``outevents [file]``  
30 - Output event list or observation definition XML file.  
31 -  
32 -``(prefix = sim_events_) [string]``  
33 - Prefix for event list in observation definition XML file. 26 + Input model XML file.
34 27
35 ``caldb [string]`` 28 ``caldb [string]``
36 Calibration database. 29 Calibration database.
@@ -38,6 +31,15 @@ General parameters @@ -38,6 +31,15 @@ General parameters
38 ``irf [string]`` 31 ``irf [string]``
39 Instrumental response function. 32 Instrumental response function.
40 33
  34 +``(edisp = no) [boolean]``
  35 + Apply energy dispersion?
  36 +
  37 +``outevents [file]``
  38 + Output event list or observation definition XML file.
  39 +
  40 +``(prefix = sim_events_) [string]``
  41 + Prefix for event list in observation definition XML file.
  42 +
41 ``(seed = 1) [integer]`` 43 ``(seed = 1) [integer]``
42 Integer seed value to be used for Monte Carlo simulations. Keep this 44 Integer seed value to be used for Monte Carlo simulations. Keep this
43 parameter at the same value for repeatable simulations, or increment 45 parameter at the same value for repeatable simulations, or increment
@@ -65,9 +67,6 @@ General parameters @@ -65,9 +67,6 @@ General parameters
65 ``emax [real]`` 67 ``emax [real]``
66 Upper energy limit of simulated events (in TeV). 68 Upper energy limit of simulated events (in TeV).
67 69
68 -``(edisp = no) [boolean]``  
69 - Apply energy dispersion?  
70 -  
71 ``(deadc = 0.95) [real]`` 70 ``(deadc = 0.95) [real]``
72 Average deadtime correction factor. 71 Average deadtime correction factor.
73 72
doc/source/reference_manual/ctpsfcube.rst
  View file @96aa9f4
@@ -45,10 +45,7 @@ General parameters @@ -45,10 +45,7 @@ General parameters
45 Input event list or observation definition XML file. 45 Input event list or observation definition XML file.
46 46
47 ``incube [file]`` 47 ``incube [file]``
48 - Counts cube file to extract point spread function cube definition.  
49 -  
50 -``outcube [file]``  
51 - Output point spread function cube file. 48 + Input counts cube file to extract point spread function cube definition.
52 49
53 ``caldb [string]`` 50 ``caldb [string]``
54 Calibration database. 51 Calibration database.
@@ -59,6 +56,9 @@ General parameters @@ -59,6 +56,9 @@ General parameters
59 ``(edisp = no) [boolean]`` 56 ``(edisp = no) [boolean]``
60 Apply energy dispersion for response computation. 57 Apply energy dispersion for response computation.
61 58
  59 +``outcube [file]``
  60 + Output point spread function cube file.
  61 +
62 ``ebinalg <FILE|LIN|LOG> [string]`` 62 ``ebinalg <FILE|LIN|LOG> [string]``
63 Algorithm for defining energy bins. 63 Algorithm for defining energy bins.
64 64
doc/source/reference_manual/ctskymap.rst
  View file @96aa9f4
@@ -19,7 +19,7 @@ General parameters @@ -19,7 +19,7 @@ General parameters
19 Input event list or observation definition XML file. 19 Input event list or observation definition XML file.
20 20
21 ``outmap [file]`` 21 ``outmap [file]``
22 - Output sky map. 22 + Output sky map file.
23 23
24 ``emin [real]`` 24 ``emin [real]``
25 Minimum energy in map (in TeV). 25 Minimum energy in map (in TeV).
doc/source/reference_manual/cttsmap.rst
  View file @96aa9f4
@@ -26,13 +26,13 @@ General parameters @@ -26,13 +26,13 @@ General parameters
26 Statistic map should be computed. 26 Statistic map should be computed.
27 27
28 ``expcube [file]`` 28 ``expcube [file]``
29 - Exposure cube file (only needed for stacked analysis). 29 + Input exposure cube file (only needed for stacked analysis).
30 30
31 ``psfcube [file]`` 31 ``psfcube [file]``
32 - PSF cube file (only needed for stacked analysis). 32 + Input PSF cube file (only needed for stacked analysis).
33 33
34 ``bkgcube [file]`` 34 ``bkgcube [file]``
35 - Background cube file (only needed for stacked analysis). 35 + Input background cube file (only needed for stacked analysis).
36 36
37 ``caldb [string]`` 37 ``caldb [string]``
38 Calibration database. 38 Calibration database.
doc/source/reference_manual/ctulimit.rst
  View file @96aa9f4
@@ -19,19 +19,19 @@ General parameters @@ -19,19 +19,19 @@ General parameters
19 Input event list, counts cube or observation definition XML file. 19 Input event list, counts cube or observation definition XML file.
20 20
21 ``inmodel [file]`` 21 ``inmodel [file]``
22 - Model XML file containing the source and background definitions. 22 + Input model XML file.
23 23
24 ``srcname [string]`` 24 ``srcname [string]``
25 Name of model component for which upper limit should be computed. 25 Name of model component for which upper limit should be computed.
26 26
27 ``expcube [file]`` 27 ``expcube [file]``
28 - Exposure cube file (only needed for stacked analysis). 28 + Input exposure cube file (only needed for stacked analysis).
29 29
30 ``psfcube [file]`` 30 ``psfcube [file]``
31 - PSF cube file (only needed for stacked analysis). 31 + Input PSF cube file (only needed for stacked analysis).
32 32
33 ``bkgcube [file]`` 33 ``bkgcube [file]``
34 - Background cube file (only needed for stacked analysis). 34 + Input background cube file (only needed for stacked analysis).
35 35
36 ``caldb [string]`` 36 ``caldb [string]``
37 Calibration database. 37 Calibration database.