Karim Sabri / ctools

Commit befd2104f445032c01916ad5e56f4871b978c7ec

Authored by Luigi Tibaldo
1 parent 9600793a

eliminated useless newlines

Inline Side-by-side
Showing 1 changed file with 1 additions and 82 deletions
doc/source/users/reference_manual/index.rst
  View file @befd210
1 .. _reference: 1 .. _reference:
2 2
3 -  
4 -  
5 Reference Manual 3 Reference Manual
6 4
7 ================ 5 ================
8 6
9 7
10 -  
11 This manual provides reference information for all ctools and csripts. 8 This manual provides reference information for all ctools and csripts.
12 -  
13 General information on ctools usage can be found `here 9 General information on ctools usage can be found `here
14 -  
15 <../user_manual/introduction.html>`_. The description of user parameters in the reference 10 <../user_manual/introduction.html>`_. The description of user parameters in the reference
16 -  
17 manual is documented `here <usage.html>`__. 11 manual is documented `here <usage.html>`__.
18 12
19 -  
20 -  
21 -  
22 -  
23 Below you find links to the command line reference for all available tools and scripts. 13 Below you find links to the command line reference for all available tools and scripts.
24 14
25 -  
26 -  
27 ctools 15 ctools
28 16
29 ------ 17 ------
30 18
31 -  
32 -  
33 .. toctree:: 19 .. toctree::
34 20
35 :maxdepth: 1 21 :maxdepth: 1
36 22
37 -  
38 -  
39 ctbin --- Generates counts cube <ctbin> 23 ctbin --- Generates counts cube <ctbin>
40 -  
41 ctbkgcube --- Generates background cube <ctbkgcube> 24 ctbkgcube --- Generates background cube <ctbkgcube>
42 -  
43 ctbutterfly --- Compute butterfly <ctbutterfly> 25 ctbutterfly --- Compute butterfly <ctbutterfly>
44 -  
45 ctcubemask --- Filter counts cube <ctcubemask> 26 ctcubemask --- Filter counts cube <ctcubemask>
46 -  
47 ctedispcube --- Generates energy dispersion cube <ctedispcube> 27 ctedispcube --- Generates energy dispersion cube <ctedispcube>
48 -  
49 cterror --- Calculates likelihood profile errors <cterror> 28 cterror --- Calculates likelihood profile errors <cterror>
50 -  
51 ctexpcube --- Generates exposure cube <ctexpcube> 29 ctexpcube --- Generates exposure cube <ctexpcube>
52 -  
53 ctfindvar --- Search for source variability <ctfindvar> 30 ctfindvar --- Search for source variability <ctfindvar>
54 -  
55 ctlike --- Performs maximum likelihood fitting <ctlike> 31 ctlike --- Performs maximum likelihood fitting <ctlike>
56 -  
57 ctmapcube --- Generates a map cube <ctmapcube> 32 ctmapcube --- Generates a map cube <ctmapcube>
58 -  
59 ctmodel --- Computes model counts cube <ctmodel> 33 ctmodel --- Computes model counts cube <ctmodel>
60 -  
61 ctobssim --- Simulate observations <ctobssim> 34 ctobssim --- Simulate observations <ctobssim>
62 -  
63 ctphase --- Computes the phase of each event <ctphase> 35 ctphase --- Computes the phase of each event <ctphase>
64 -  
65 ctprob --- Computes event probability for a given model <ctprob> 36 ctprob --- Computes event probability for a given model <ctprob>
66 -  
67 ctpsfcube --- Generates point spread function cube <ctpsfcube> 37 ctpsfcube --- Generates point spread function cube <ctpsfcube>
68 -  
69 ctselect --- Selects event data <ctselect> 38 ctselect --- Selects event data <ctselect>
70 -  
71 ctskymap --- Generates sky map <ctskymap> 39 ctskymap --- Generates sky map <ctskymap>
72 -  
73 cttsmap --- Generates Test Statistic map <cttsmap> 40 cttsmap --- Generates Test Statistic map <cttsmap>
74 -  
75 ctulimit --- Calculates upper limit <ctulimit> 41 ctulimit --- Calculates upper limit <ctulimit>
76 42
77 -  
78 -  
79 -  
80 -  
81 cscripts 43 cscripts
82 44
83 -------- 45 --------
84 46
85 -  
86 -  
87 .. toctree:: 47 .. toctree::
88 48
89 :maxdepth: 1 49 :maxdepth: 1
90 50
91 -  
92 -  
93 - csscs --- ToDo: Describe what script is doing <csscs>  
94 csbkgmodel --- Generates background model for 3D analysis <csbkgmodel> 51 csbkgmodel --- Generates background model for 3D analysis <csbkgmodel>
95 -  
96 cscaldb --- Lists available instrument response functions <cscaldb> 52 cscaldb --- Lists available instrument response functions <cscaldb>
97 -  
98 csebins --- Generates energy boundaries for stacked analysis <csebins> 53 csebins --- Generates energy boundaries for stacked analysis <csebins>
99 -  
100 cslightcrv --- Computes light curve <cslightcrv> 54 cslightcrv --- Computes light curve <cslightcrv>
101 -  
102 csmodelinfo --- Shows model container content <csmodelinfo> 55 csmodelinfo --- Shows model container content <csmodelinfo>
103 -  
104 csmodelmerge --- Merges several model containers into one file <csmodelmerge> 56 csmodelmerge --- Merges several model containers into one file <csmodelmerge>
105 -  
106 csmodelselect --- Select models from model definition file <csmodelselect> 57 csmodelselect --- Select models from model definition file <csmodelselect>
107 -  
108 csmodelsois --- Generate map cube from subset of models <csmodelsois> 58 csmodelsois --- Generate map cube from subset of models <csmodelsois>
109 -  
110 csobsdef --- Generates observation definition file <csobsdef> 59 csobsdef --- Generates observation definition file <csobsdef>
111 -  
112 csobsinfo --- Shows observation container content <csobsinfo> 60 csobsinfo --- Shows observation container content <csobsinfo>
113 -  
114 csobsselect --- Select observations from observation definition file <csobsselect> 61 csobsselect --- Select observations from observation definition file <csobsselect>
115 -  
116 csphagen --- Generates PHA, ARF, RMF files based on source/background regions <csphagen> 62 csphagen --- Generates PHA, ARF, RMF files based on source/background regions <csphagen>
117 -  
118 csphasecrv --- Computes phase curve <csphasecrv> 63 csphasecrv --- Computes phase curve <csphasecrv>
119 -  
120 cspull --- Generates pull distribution <cspull> 64 cspull --- Generates pull distribution <cspull>
121 -  
122 csresmap --- Generates residual map <csresmap> 65 csresmap --- Generates residual map <csresmap>
123 -  
124 csresspec --- Generates residual spectrum <csresspec> 66 csresspec --- Generates residual spectrum <csresspec>
125 -  
126 csroot2caldb --- Creates a caldb entry from a ROOT file <csroot2caldb> 67 csroot2caldb --- Creates a caldb entry from a ROOT file <csroot2caldb>
127 - 68 + csscs --- Performs spectral component separation <csscs>
128 cssens --- Computes CTA sensitivity <cssens> 69 cssens --- Computes CTA sensitivity <cssens>
129 -  
130 csspec --- Computes spectral points <csspec> 70 csspec --- Computes spectral points <csspec>
131 -  
132 cssrcdetect --- Detects sources in sky map <cssrcdetect> 71 cssrcdetect --- Detects sources in sky map <cssrcdetect>
133 -  
134 cstsdist --- Generates Test Statistic distribution <cstsdist> 72 cstsdist --- Generates Test Statistic distribution <cstsdist>
135 -  
136 cstsmapmerge --- Merges slices from Test Statistic map computations <cstsmapmerge> 73 cstsmapmerge --- Merges slices from Test Statistic map computations <cstsmapmerge>
137 -  
138 cstsmapsplit --- Creates commands to split the Test Statistic map computations <cstsmapsplit> 74 cstsmapsplit --- Creates commands to split the Test Statistic map computations <cstsmapsplit>
139 -  
140 csviscube --- Computes visibility cube <csviscube> 75 csviscube --- Computes visibility cube <csviscube>
141 76
142 -  
143 -  
144 -  
145 -  
146 Scripts to manage an IACT database 77 Scripts to manage an IACT database
147 78
148 ---------------------------------- 79 ----------------------------------
149 80
150 -  
151 -  
152 .. warning:: 81 .. warning::
153 82
154 -  
155 -  
156 The ``csiactdata``, ``csiactobs``, ``csfindobs`` and ``csiactcopy`` scripts 83 The ``csiactdata``, ``csiactobs``, ``csfindobs`` and ``csiactcopy`` scripts
157 -  
158 rely on the ``json`` Python module which is only available in Python 2.6 84 rely on the ``json`` Python module which is only available in Python 2.6
159 -  
160 or higher. These scripts will not work on older Python versions. 85 or higher. These scripts will not work on older Python versions.
161 86
162 87
@@ -165,15 +90,9 @@ Scripts to manage an IACT database @@ -165,15 +90,9 @@ Scripts to manage an IACT database
165 90
166 :maxdepth: 1 91 :maxdepth: 1
167 92
168 -  
169 -  
170 csobs2caldb --- Creates a caldb entry from an input observation <csobs2caldb> 93 csobs2caldb --- Creates a caldb entry from an input observation <csobs2caldb>
171 -  
172 csiactdata --- Shows information about IACT data available on the user machine <csiactdata> 94 csiactdata --- Shows information about IACT data available on the user machine <csiactdata>
173 -  
174 csiactobs --- Generates observation definition file for IACT data from observation IDs <csiactobs> 95 csiactobs --- Generates observation definition file for IACT data from observation IDs <csiactobs>
175 -  
176 csfindobs --- Generates a list of IACT observation IDs <csfindobs> 96 csfindobs --- Generates a list of IACT observation IDs <csfindobs>
177 -  
178 csiactcopy --- Copies IACT data from one location to another <csiactcopy> 97 csiactcopy --- Copies IACT data from one location to another <csiactcopy>
179 98