Commit 8ac139ce55297bfd12c28f18e650d17d446882c9

Authored by Michael Mayer
1 parent 797a50cb

Working on documentation ...

doc/source/user_manual/iact_analysis/high_level.rst
@@ -168,13 +168,45 @@ To have first glance at the above computed spectrum one can use this script in t @@ -168,13 +168,45 @@ To have first glance at the above computed spectrum one can use this script in t
168 168
169 Compute light curves 169 Compute light curves
170 -------------------- 170 --------------------
171 -Euqally common in astronomy are light curves from a time-series analysis. 171 +Euqally common in astronomy are light curves from a time-series analysis. The tool :ref:`cslightcrv` takes as input only
  172 +an unbinned observation container (or a single event list). Counts cube are not possible as inout since the time informstion
  173 +is lost during the binning procedure. Nevertheless, in case of large time bins, it is possible to require a binned analysis
  174 +in each time bin. The tool will accordingly slice the event list and create the data products for the stacked analysis in each
  175 +time span.
  176 +
  177 +.. code-block:: bash
  178 +
  179 + $ cslightcrv
  180 + Input event list, counts cube, or observation definition XML file [selected_obs.xml]
  181 + Input model XML file [crab_models.xml]
  182 + Source name [Crab]
  183 + Algorithm for defining time bins (FILE|LIN|GTI) [GTI]
  184 + Number of energy bins per light curve bin (0=unbinned) [0]
  185 + Lower energy limit of events (TeV) [0.1] 0.5
  186 + Upper energy limit of events (TeV) [100.0] 50
  187 + Output light curve file [lightcurve.fits]
172 188
173 Compute a residual map 189 Compute a residual map
174 ---------------------- 190 ----------------------
  191 +A frequent means to visually inspect the fitted model with respect to the input data is to create residual maps.
  192 +Using :ref:`csresmap` such a map can easily be computed. The tool internally bins the data according to user parameters.
  193 +(if data is not already provided in a binned state). Taking into account the corresponding IRFs,
  194 +:reF:`csresmap` computes a model map (running :ref:`ctmodel`). Subsequently, there are several choices how data
  195 +and model should be compared. There are three options:
  196 +
  197 +* ``SUB``: the subtraction of the model from the counts. The resulting map will display differences in absolute counts.
  198 +* ``SUBDIV``: the subtraction and division by the model. The resulting map will display relative differences of the data with respect to the model.
  199 +* ``SUBDIVSQRT``: the subtraction and division by the square root of the model. The resulting map will display an approximation of a residual significance map. In case of sufficient count statistic per bin, the bin value represents the significance.
  200 +
175 201
176 Compute a test statistics (TS) map 202 Compute a test statistics (TS) map
177 ---------------------------------- 203 ----------------------------------
  204 +The test statistics is more precise measurement of statistic than the ``SUBDIVSQRT`` option in :ref:`csresmap`.
  205 +To get familiar with the concept of this procedure, :ref:`read more about TS maps <sec_tsmap>`.
  206 +
  207 +.. code-block:: bash
  208 +
  209 + $ cttsmap
178 210
179 -Compute flux maps  
180 ------------------  
181 \ No newline at end of file 211 \ No newline at end of file
  212 +Since :ref:`cttsmap` has to run a parameter optimisation in each skymap bin, it is very time comsuming to
  213 +compute a fine-granulated TS sky map. Read here how to split up the :ref:`computation into several jobs <sec_tips>`.
doc/source/user_manual/iact_analysis/index.rst
@@ -9,5 +9,5 @@ Analysis using current IACT data @@ -9,5 +9,5 @@ Analysis using current IACT data
9 analysis 9 analysis
10 high_level 10 high_level
11 simulation 11 simulation
12 - tipps 12 + tips
13 13
doc/source/user_manual/iact_analysis/tips.rst
1 -.. _sec_tipps: 1 +.. _sec_tips:
2 2
3 Tips, Tricks and FAQs 3 Tips, Tricks and FAQs
4 ===================== 4 =====================
@@ -6,21 +6,27 @@ Tips, Tricks and FAQs @@ -6,21 +6,27 @@ Tips, Tricks and FAQs
6 Visualise observations 6 Visualise observations
7 ---------------------- 7 ----------------------
8 8
  9 +Plot zenith angle distribution of observations
  10 +----------------------------------------------
  11 +
9 Visualise models 12 Visualise models
10 ---------------- 13 ----------------
11 14
12 -Increase analysis speed  
13 ------------------------ 15 +Speed up analysis
  16 +-----------------
14 17
15 Create count map with one energy bin 18 Create count map with one energy bin
16 ------------------------------------ 19 ------------------------------------
17 20
18 -Plot zenith angle distribution of observations  
19 ----------------------------------------------- 21 +Compute excess map
  22 +------------------
20 23
21 Split TS map computation 24 Split TS map computation
22 ------------------------ 25 ------------------------
23 26
  27 +Compute flux maps
  28 +-----------------
  29 +
24 Accessing fit parameters in python 30 Accessing fit parameters in python
25 ---------------------------------- 31 ----------------------------------
26 32