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