Iftach Sadeh / ctools

Commit 96d2ba226ffdb979ceb4d01e0263a181c25407df

Authored by Jürgen Knödlseder
1 parent a32b92ba

Update 1DC tutorials

Inline Side-by-side
Showing 25 changed files with 233 additions and 144 deletions
doc/source/users/tutorials/1dc/data_organisation.rst
  View file @96d2ba2
... ... @@ -46,7 +46,7 @@ Instrument Response Functions
46 46 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
47 47  
48 48 The ``caldb`` folder contains the
49   -:ref:`Instrument Response Functions <glossary_irf>`
  49 +:ref:`instrument response functions <glossary_irf>`
50 50 that are necessary for the analysis of the simulated CTA data.
51 51 The folder contains the ``1dc`` response that should be used for the
52 52 :ref:`first CTA Data Challenge <glossary_1dc>`.
... ... @@ -102,7 +102,7 @@ Each event file contains the events for an
102 102 :ref:`observation <glossary_obs>` and comprises an
103 103 :ref:`event list <glossary_eventlist>`
104 104 and a
105   -:ref:`Good Time Intervals <glossary_gti>`
  105 +:ref:`good time intervals <glossary_gti>`
106 106 binary table extension (see figure below).
107 107  
108 108 .. figure:: event_file.png
... ... @@ -205,7 +205,7 @@ Observation Definition Files
205 205  
206 206 The files ``obs_egal_baseline.xml``, ``obs_gc_baseline.xml``, and
207 207 ``obs_gps_baseline.xml`` are so called
208   -:ref:`Observation Definition Files <glossary_obsdef>`
  208 +:ref:`observation definition files <glossary_obsdef>`
209 209 containing the information (or metadata) of a list of observations.
210 210 The file is a plain ASCII files in XML format that can be inspected and
211 211 manipulated by any text editor.
... ... @@ -218,7 +218,7 @@ The ``models`` folder contains the definitions of all source and background
218 218 models that were used for simulating the data.
219 219 The files ``models_egal.xml``, ``models_gc.xml`` and ``models_gps.xml`` are
220 220 so called
221   -:ref:`Model Definition Files <glossary_moddef>`
  221 +:ref:`model definition files <glossary_moddef>`
222 222 collecting the definition of all model components used for the three surveys.
223 223 Since the same sky model was used for all surveys the three files are
224 224 identical.
... ...
doc/source/users/tutorials/1dc/first.rst
  View file @96d2ba2
... ... @@ -6,13 +6,13 @@ First analysis steps
6 6 The following sections describe how to analyse data from the
7 7 :ref:`first CTA Data Challenge <glossary_1dc>`
8 8 using ctools.
9   -If you have never used ctools before or if you have never analysed data from the
  9 +**If you have never used ctools before or if you have never analysed data from the**
10 10 :ref:`first CTA Data Challenge <glossary_1dc>`,
11   -this is the place where you should start.
  11 +**this is the place where you should start.**
12 12  
13 13 We assume that you have downloaded the data of the
14 14 :ref:`first CTA Data Challenge <glossary_1dc>`
15   -and that you have successfully installed the ctools package.
  15 +and that you have successfully installed and configured the ctools package.
16 16 If this is not the case, please read
17 17 :ref:`how to get the tools <1dc_getting_tools>` and
18 18 :ref:`how to get the data <1dc_getting_data>`.
... ...
doc/source/users/tutorials/1dc/first_detect.rst
  View file @96d2ba2
... ... @@ -59,9 +59,8 @@ There are three model components in the file and each model component is
59 59 identified using a unique ``name`` attribute.
60 60 The first two components, ``"Src001"`` and ``"Src002"``, are the two point sources
61 61 detected by :ref:`cssrcdetect`, the third component, ``"Background"``, is a
62   -background model component of type ``"CTAIrfBackground"``.
63   -The latter component was added because the background model type was set to
64   -``IRF`` in the :ref:`cssrcdetect` run.
  62 +background model component of type ``"CTAIrfBackground"`` that was added because
  63 +``IRF`` was specified for the ``Background model type`` when running the script.
65 64 Having a background model component added allows to directly use the
66 65 :ref:`model definition file <glossary_moddef>`
67 66 for a model fitting with :ref:`ctlike`.
... ...
doc/source/users/tutorials/1dc/first_select_events.rst
  View file @96d2ba2
... ... @@ -8,6 +8,10 @@ Selecting the relevant events
8 8 ... how to **select a subset of events** from the selected observations for
9 9 your analysis.
10 10  
  11 + The event selection is useful to restrict for example the energy range of
  12 + the events or the time interval covered, but also to select only events
  13 + within a given radial acceptance region (also called region of interest).
  14 +
11 15 As next step, you have to select the relevant events from the selected
12 16 observations. You do this with the :ref:`ctselect` tool by typing:
13 17  
... ... @@ -67,7 +71,7 @@ displays a summary of the content of this new
67 71 There are still 57 observations in the
68 72 :ref:`observation definition file <glossary_obsdef>`
69 73 but now the events are restricted to the energy interval 100 GeV - 100 TeV. In
70   -total there are 3 348 255 within this interval in the selected observations.
  74 +total there are 3 348 255 events within this interval in the selected observations.
71 75  
72 76 The content of ``obs_selected.xml`` will look similar to the content of
73 77 ``obs.xml`` with the original event list file names replaced by the names of
... ...
doc/source/users/tutorials/1dc/first_select_obs.rst
  View file @96d2ba2
... ... @@ -27,8 +27,8 @@ For the following, make sure that you have set the ``CTADATA`` and ``CALDB``
27 27 environment variables as desribed :ref:`here <1dc_getting_data>`.
28 28  
29 29 The first step of the analysis consists in selecting the observations from the
30   -:ref:`Observation Definition File <glossary_obsdef>`
31   -``obs_gc_baseline.xml`` that have pointing directions close to the Galactic
  30 +:ref:`observation definition file <glossary_obsdef>`
  31 +``obs_gps_baseline.xml`` that have pointing directions close to the Galactic
32 32 Centre.
33 33 You do this with the :ref:`csobsselect` script by typing:
34 34  
... ... @@ -95,7 +95,7 @@ The output of :ref:`csobsinfo` is shown below. :ref:`csobsselect` selected
95 95 2017-06-02T08:10:00: Total livetime ............: 100548.00 s = 1675.80 min = 27.93 h
96 96  
97 97 The resulting
98   -:ref:`Observation Definition File <glossary_obsdef>`
  98 +:ref:`observation definition file <glossary_obsdef>`
99 99 will look as follows:
100 100  
101 101 .. code-block:: xml
... ... @@ -123,5 +123,5 @@ An ``&lt;observation&gt;`` element contains two parameters:
123 123 the ``EventList`` parameter that specifies the name of the corresponding event
124 124 file, and
125 125 the ``Calibration`` parameter that specifies the
126   -:ref:`Instrument Response Function <glossary_irf>` that applies to the
  126 +:ref:`instrument response function <glossary_irf>` that applies to the
127 127 event file.
... ...
doc/source/users/tutorials/1dc/first_skymap.rst
  View file @96d2ba2
... ... @@ -53,7 +53,7 @@ is shown below:
53 53  
54 54 *Sky map of the events recorded around the Galactic Centre during the Galactic Plane Survey*
55 55  
56   -The sky map shows a wide-spread distribution of events with a number of sources
  56 +The sky map shows a wide-spread distribution of events with several sources
57 57 superimposed.
58 58 Many of the events originate from an irreducable background that hampers the
59 59 recognition of the gamma-ray sources.
... ...
doc/source/users/tutorials/1dc/first_stacked.rst
  View file @96d2ba2
... ... @@ -71,11 +71,12 @@ that are queried by the tool.
71 71  
72 72 .. note::
73 73  
74   - The binning of an exposure cube does not need to correspond to the binning
75   - of a counts cube. In any case, exposure values will be determined by
  74 + The binning of the exposure cube does not need to correspond to the binning
  75 + of the counts cube. In any case, exposure values will be determined by
76 76 interpolation from the values stored in the exposure cube file. The same
77   - is true for the point spread function and background cubes described
78   - below.
  77 + is true for the point spread function and background cubes that are
  78 + described below, or the energy dispersion cube that is described
  79 + :ref:`here<1dc_howto_edisp>`.
79 80  
80 81 Next, :ref:`ctpsfcube` computes the weighted Point Spread Function of the
81 82 stacked counts cube.
... ...
doc/source/users/tutorials/1dc/first_tsmap.png
View file @96d2ba2

25.6 KB | W: | H:

23.7 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/getting_data.rst
  View file @96d2ba2
... ... @@ -11,11 +11,11 @@ You need your usual CTA credentials to download the data.
11 11  
12 12 The release contains simulated data for the Galactic Plane Survey, the
13 13 Galactic Centre Survey and the Extragalactic Survey,
14   -:ref:`Instrument Response Functions (IRFs) <glossary_irf>`, and the
  14 +:ref:`instrument response functions (IRFs) <glossary_irf>`, and the
15 15 :ref:`model definition files <glossary_moddef>`
16 16 that were used for the simulation.
17 17 In addition, ctools metadata, including
18   -:ref:`Observation Definition Files <glossary_obsdef>`
  18 +:ref:`observation definition files <glossary_obsdef>`
19 19 are available.
20 20  
21 21 The data were split into the separate files that can be downloaded
... ...
doc/source/users/tutorials/1dc/howto_display.rst
  View file @96d2ba2
... ... @@ -5,7 +5,8 @@ How to display the results?
5 5  
6 6 .. admonition:: You will learn ...
7 7  
8   - ... how to **display results**.
  8 + ... how to **display results** using some example scripts written in
  9 + Python and requiring the ``matplotlib`` module.
9 10  
10 11 The ctools package does not contain any tools or scripts for graphical
11 12 display of results since results are generally written into standard FITS
... ... @@ -17,19 +18,19 @@ included in the ctools package that rely on the
17 18 Python module. You can find these scripts in the
18 19 ``$CTOOLS/share/examples/python`` folder. The following scripts are available:
19 20  
20   -+------------------------+-----------------------------+
21   -| Script | Usage |
22   -+========================+=============================+
23   -| ``show_butterfly.py`` | Display a butterfly diagram |
24   -+------------------------+-----------------------------+
25   -| ``show_lightcurve.py`` | Display a light curve |
26   -+------------------------+-----------------------------+
27   -| ``show_obs.py`` | Display observation summary |
28   -+------------------------+-----------------------------+
29   -| ``show_pointings.py`` | Display pointing directions |
30   -+------------------------+-----------------------------+
31   -| ``show_spectrum.py`` | Display a spectrum |
32   -+------------------------+-----------------------------+
  21 + +------------------------+-----------------------------+
  22 + | Script | Usage |
  23 + +========================+=============================+
  24 + | ``show_butterfly.py`` | Display a butterfly diagram |
  25 + +------------------------+-----------------------------+
  26 + | ``show_lightcurve.py`` | Display a light curve |
  27 + +------------------------+-----------------------------+
  28 + | ``show_obs.py`` | Display observation summary |
  29 + +------------------------+-----------------------------+
  30 + | ``show_pointings.py`` | Display pointing directions |
  31 + +------------------------+-----------------------------+
  32 + | ``show_spectrum.py`` | Display a spectrum |
  33 + +------------------------+-----------------------------+
33 34  
34 35 Below some usage examples and the expected output:
35 36  
... ... @@ -45,6 +46,16 @@ Below some usage examples and the expected output:
45 46  
46 47 .. code-block:: bash
47 48  
  49 + $ $CTOOLS/share/examples/python/show_lightcurve.py lightcurve.fits
  50 +
  51 +.. figure:: howto_lightcurve.png
  52 + :width: 600px
  53 + :align: center
  54 +
  55 + *Light curve displayed with show_lightcurve.py*
  56 +
  57 +.. code-block:: bash
  58 +
48 59 $ $CTOOLS/share/examples/python/show_obs.py obs_selected.xml
49 60  
50 61 .. figure:: howto_display_obs.png
... ...
doc/source/users/tutorials/1dc/howto_exclude.rst
  View file @96d2ba2
... ... @@ -3,6 +3,11 @@
3 3 How to exclude pixels from a counts cube?
4 4 -----------------------------------------
5 5  
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how to **exclude pixels of a counts cube** from an analysis using
  9 + the :ref:`ctcubemask` tool.
  10 +
6 11 You can exclude bins in an analysis from a counts cube by using the
7 12 :ref:`ctcubemask` tool.
8 13  
... ...
doc/source/users/tutorials/1dc/howto_extent.rst
  View file @96d2ba2
... ... @@ -3,6 +3,11 @@
3 3 How to determine the extension of a source?
4 4 -------------------------------------------
5 5  
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how you **determine the spatial extent of a source** by fitting an
  9 + extended source model to the data.
  10 +
6 11 To determine the spatial extension of a source, an extended source model
7 12 has to be used in the
8 13 :ref:`model definition file <glossary_moddef>`
... ... @@ -15,15 +20,16 @@ Note that at the same time the source type has been set to
15 20  
16 21 .. code-block:: xml
17 22  
18   - <source name="Src001" type="ExtendedSource">
19   - <spectrum type="PowerLaw">
20   - <parameter name="Prefactor" value="1" scale="5.7e-18" min="0" free="1" />
21   - <parameter name="Index" value="1" scale="-2.48" min="-5" max="5" free="1" />
22   - <parameter name="PivotEnergy" value="1" scale="300000" free="0" />
  23 + <source name="Src001" type="PointSource">
  24 + <spectrum type="ExponentialCutoffPowerLaw">
  25 + <parameter name="Prefactor" scale="1e-18" value="5.7" min="1e-07" max="1000.0" free="1"/>
  26 + <parameter name="Index" scale="-1" value="2.48" min="0.0" max="+5.0" free="1"/>
  27 + <parameter name="CutoffEnergy" scale="1e7" value="1.0" min="0.01" max="1000.0" free="1"/>
  28 + <parameter name="PivotEnergy" scale="1e6" value="0.3" min="0.01" max="1000.0" free="0"/>
23 29 </spectrum>
24 30 <spatialModel type="RadialGaussian">
25   - <parameter name="RA" scale="1.0" value="266.4240" min="-360" max="360" free="1"/>
26   - <parameter name="DEC" scale="1.0" value="-29.0049" min="-90" max="90" free="1"/>
  31 + <parameter name="RA" scale="1.0" value="266.4044" min="-360" max="360" free="1"/>
  32 + <parameter name="DEC" scale="1.0" value="-28.9945" min="-90" max="90" free="1"/>
27 33 <parameter name="Sigma" scale="1.0" value="0.05" min="0.001" max="10" free="1"/>
28 34 </spatialModel>
29 35 </source>
... ...
doc/source/users/tutorials/1dc/howto_filtered.png
View file @96d2ba2

60.9 KB | W: | H:

59.8 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/howto_lightcurve.png
View file @96d2ba2

22.4 KB | W: | H:

24.3 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/howto_lightcurve.rst
  View file @96d2ba2
... ... @@ -3,6 +3,11 @@
3 3 How to generate a light curve?
4 4 ------------------------------
5 5  
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how to **generate a light curve** for a source using the
  9 + :ref:`cslightcrv` script.
  10 +
6 11 You can generate a light curve using the :ref:`cslightcrv` script which
7 12 takes on input an
8 13 :ref:`event list <glossary_eventlist>`
... ... @@ -16,8 +21,8 @@ performs a maximum likelihood analyse for each of the intervals.
16 21 The analysis results are writted into a light curve FITS file.
17 22  
18 23 The following example illustrates how you can generate a light curve for
19   -``Src001`` for the time interval from 59236.810 to 59245.742 (MJD),
20   -corresponding to the dates from 2021-01-22 (19:26:51) to 2021-01-31 (17:48:51)
  24 +``Src001`` for the time interval from 59235.5 to 59236.0 (MJD),
  25 +corresponding to the dates from 2021-01-21 (12:00:00) to 2021-01-22 (00:00:00)
21 26 (to convert dates to MJD and vice versa we suggest to use the
22 27 `xTime Date and Time Conversion Utility <https://heasarc.gsfc.nasa.gov/cgi-bin/Tools/xTime/xTime.pl>`_).
23 28 The time interval is linearly divided into 100 time bins.
... ... @@ -29,22 +34,21 @@ The time interval is linearly divided into 100 time bins.
29 34 Input model definition XML file [$CTOOLS/share/models/crab.xml] models.xml
30 35 Source name [Crab] Src001
31 36 Algorithm for defining time bins (FILE|LIN|GTI) [GTI] LIN
32   - Lightcurve start time (MJD) [51544.5] 59236.810
33   - Lightcurve stop time (MJD) [51544.6] 59245.742
34   - Number of time bins (1-10000) [5] 100
  37 + Lightcurve start time (MJD) [51544.5] 59235.5
  38 + Lightcurve stop time (MJD) [51544.6] 59236.0
  39 + Number of time bins (1-10000) [5] 20
35 40 Number of energy bins for binned (0=unbinned) (0-100) [0]
36 41 Lower energy limit of events (TeV) [0.1]
37 42 Upper energy limit of events (TeV) [100.0]
38 43 Output light curve file [lightcurve.fits]
39 44  
40   -The resulting light curve is shown in the figure below. The gaps in the light
41   -curve correspond to time periods during which ``Src001`` has not been observed.
  45 +The resulting light curve is shown in the figure below.
42 46  
43 47 .. figure:: howto_lightcurve.png
44 48 :width: 600px
45 49 :align: center
46 50  
47   - *Light curve from 59236.810 to 59245.742 (MJD) for Src001*
  51 + *Light curve from 59235.5 to 59236.0 (MJD) for Src001*
48 52  
49 53 .. note::
50 54 The plot was created using the ``show_lightcurve.py`` script that is
... ...
doc/source/users/tutorials/1dc/howto_ts.rst
  View file @96d2ba2
... ... @@ -3,8 +3,13 @@
3 3 How to compute the signifiance of a source?
4 4 -------------------------------------------
5 5  
6   -To compute the significance of a given source you need to add the attribute
7   -``tscalc="1"`` to the ``<source>`` tag in the
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how to **compute the significance of a source detection** using the
  9 + :ref:`ctlike` tool.
  10 +
  11 +To compute the detection significance of a given source you need to add the
  12 +attribute ``tscalc="1"`` to the ``<source>`` tag in the
8 13 :ref:`model definition file <glossary_moddef>`
9 14 and execute :ref:`ctlike` using this file.
10 15 The structure of the XML file with significance computation requested for
... ... @@ -15,14 +20,16 @@ The structure of the XML file with significance computation requested for
15 20 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
16 21 <source_library title="source library">
17 22 <source name="Src001" type="PointSource" tscalc="1">
18   - <spectrum type="PowerLaw">
19   - <parameter name="Prefactor" value="1" error="0" scale="5.7e-18" min="0" free="1" />
20   - <parameter name="Index" value="1" error="-0" scale="-2.48" min="-4.03225806451613" max="4.03225806451613" free="1" />
21   - <parameter name="PivotEnergy" value="1" scale="300000" free="0" />
  23 + <spectrum type="ExponentialCutoffPowerLaw">
  24 + <parameter name="Prefactor" scale="1e-18" value="5.7" min="1e-07" max="1000.0" free="1"/>
  25 + <parameter name="Index" scale="-1" value="2.48" min="0.0" max="+5.0" free="1"/>
  26 + <parameter name="CutoffEnergy" scale="1e7" value="1.0" min="0.01" max="1000.0" free="1"/>
  27 + <parameter name="PivotEnergy" scale="1e6" value="0.3" min="0.01" max="1000.0" free="0"/>
22 28 </spectrum>
23   - <spatialModel type="PointSource">
24   - <parameter name="RA" value="266.424004498437" error="0" scale="1" free="1" />
25   - <parameter name="DEC" value="-29.0049010253548" error="0" scale="1" free="1" />
  29 + <spatialModel type="RadialDisk">
  30 + <parameter name="RA" scale="1.0" value="266.4044" min="-360" max="360" free="1"/>
  31 + <parameter name="DEC" scale="1.0" value="-28.9944" min="-90" max="90" free="1"/>
  32 + <parameter name="Radius" scale="1.0" value="0.1" min="0.01" max="10" free="1"/>
26 33 </spatialModel>
27 34 </source>
28 35 ...
... ... @@ -37,26 +44,20 @@ For :math:`p=1`, the source significance is the square root of the Test
37 44 Statistic.
38 45  
39 46 An excerpt of the :ref:`ctlike` log file is shown below where signifance
40   -computation was requested for ``Src001`` and ``Src002`` and the diffuse
41   -Galactic emission component ``IEM``. The computation has been done using
42   -a stacked analysis.
  47 +computation was requested for ``Src001`` and ``Src002``. The computation was
  48 +done using a stacked analysis.
43 49  
44 50 .. code-block:: bash
45 51  
46   - 2017-03-03T23:36:07: === GModelSky ===
47   - 2017-03-03T23:36:07: Name ......................: Src001
48   - 2017-03-03T23:36:07: Instruments ...............: all
49   - 2017-03-03T23:36:07: Test Statistic ............: 12650.600597267
50   - ...
51   - 2017-03-03T23:36:07: === GModelSky ===
52   - 2017-03-03T23:36:07: Name ......................: Src002
53   - 2017-03-03T23:36:07: Instruments ...............: all
54   - 2017-03-03T23:36:07: Test Statistic ............: 2154.31897658715
  52 + 2017-06-02T10:54:10: === GModelSky ===
  53 + 2017-06-02T10:54:10: Name ......................: Src001
  54 + 2017-06-02T10:54:10: Instruments ...............: all
  55 + 2017-06-02T10:54:10: Test Statistic ............: 8845.82638467156
55 56 ...
56   - 2017-03-03T23:36:07: === GModelSky ===
57   - 2017-03-03T23:36:07: Name ......................: IEM
58   - 2017-03-03T23:36:07: Instruments ...............: all
59   - 2017-03-03T23:36:07: Test Statistic ............: 43070.3063685261
  57 + 2017-06-02T10:54:10: === GModelSky ===
  58 + 2017-06-02T10:54:10: Name ......................: Src002
  59 + 2017-06-02T10:54:10: Instruments ...............: all
  60 + 2017-06-02T10:54:10: Test Statistic ............: 1437.33551948087
60 61  
61 62 The Test Statistic values are also written into the
62 63 :ref:`model definition file <glossary_moddef>`
... ... @@ -66,13 +67,10 @@ created by :ref:`ctlike`:
66 67  
67 68 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
68 69 <source_library title="source library">
69   - <source name="Src001" type="PointSource" ts="12650.601" tscalc="1">
70   - ...
71   - </source>
72   - <source name="Src002" type="PointSource" ts="2154.319" tscalc="1">
  70 + <source name="Src001" type="ExtendedSource" ts="8845.826" tscalc="1">
73 71 ...
74 72 </source>
75   - <source name="IEM" type="DiffuseSource" ts="43070.306" tscalc="1">
  73 + <source name="Src002" type="PointSource" ts="1437.336" tscalc="1">
76 74 ...
77 75 </source>
78 76 ...
... ...
doc/source/users/tutorials/1dc/howto_tsmap.rst
  View file @96d2ba2
... ... @@ -3,6 +3,11 @@
3 3 How to generate a Test Statistic map?
4 4 -------------------------------------
5 5  
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how to **generate a map of source detection significances** using the
  9 + :ref:`cttsmap` tool.
  10 +
6 11 If you want to know how the Test Statistic changes with source position you
7 12 can create a Test Statistic map using the :ref:`cttsmap` tool. A Test
8 13 Statistic map is for example useful to study the precise error contours of
... ... @@ -21,14 +26,14 @@ map of size 0.5 x 0.5 degrees, centred on the Galactic Centre.
21 26 Input background cube file (only needed for stacked analysis) [NONE] bkgcube.fits
22 27 Test source name [Crab] Src001
23 28 Input model definition XML file [$CTOOLS/share/models/crab.xml] stacked_models.xml
24   - First coordinate of image center in degrees (RA or galactic l) (0-360) [83.63] 0
25   - Second coordinate of image center in degrees (DEC or galactic b) (-90-90) [22.01] 0
26   - Projection method (AIT|AZP|CAR|MER|MOL|STG|TAN) [CAR]
  29 + First coordinate of image center in degrees (RA or galactic l) (0-360) [83.63] 0.0
  30 + Second coordinate of image center in degrees (DEC or galactic b) (-90-90) [22.01] 0.0
  31 + Projection method (AIT|AZP|CAR|GLS|MER|MOL|SFL|SIN|STG|TAN) [CAR]
27 32 Coordinate system (CEL - celestial, GAL - galactic) (CEL|GAL) [CEL] GAL
28 33 Image scale (in degrees/pixel) [0.02] 0.05
29 34 Size of the X axis in pixels [200] 10
30 35 Size of the Y axis in pixels [200] 10
31   - Output Test Statistic map file [tsmap.fits] tsmap_stacked.fits
  36 + Output Test Statistic map file [tsmap.fits]
32 37  
33 38 The :ref:`cttsmap` tool creates a FITS file containing for each pixel the
34 39 Test Statistic value as well as the fit parameters for the test source.
... ... @@ -85,16 +90,16 @@ The figure below shows the resulting Test Statistic map.
85 90  
86 91 .. code-block:: bash
87 92  
88   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=0 binmax=10 outmap=tsmap_split_0.fits logfile=tsmap_split_0.log &
89   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=10 binmax=20 outmap=tsmap_split_1.fits logfile=tsmap_split_1.log &
90   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=20 binmax=30 outmap=tsmap_split_2.fits logfile=tsmap_split_2.log &
91   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=30 binmax=40 outmap=tsmap_split_3.fits logfile=tsmap_split_3.log &
92   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=40 binmax=50 outmap=tsmap_split_4.fits logfile=tsmap_split_4.log &
93   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=50 binmax=60 outmap=tsmap_split_5.fits logfile=tsmap_split_5.log &
94   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=60 binmax=70 outmap=tsmap_split_6.fits logfile=tsmap_split_6.log &
95   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=70 binmax=80 outmap=tsmap_split_7.fits logfile=tsmap_split_7.log &
96   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=80 binmax=90 outmap=tsmap_split_8.fits logfile=tsmap_split_8.log &
97   - cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL xref=0.0 yref=0.0 proj=CAR publish=no chatter=2 clobber=yes debug=no mode=ql logL0=1082619.2527136307 binmin=90 binmax=100 outmap=tsmap_split_9.fits logfile=tsmap_split_9.log &
  93 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=0 binmax=10 outmap=tsmap_split_0.fits logfile=tsmap_split_0.log &
  94 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=10 binmax=20 outmap=tsmap_split_1.fits logfile=tsmap_split_1.log &
  95 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=20 binmax=30 outmap=tsmap_split_2.fits logfile=tsmap_split_2.log &
  96 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=30 binmax=40 outmap=tsmap_split_3.fits logfile=tsmap_split_3.log &
  97 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=40 binmax=50 outmap=tsmap_split_4.fits logfile=tsmap_split_4.log &
  98 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=50 binmax=60 outmap=tsmap_split_5.fits logfile=tsmap_split_5.log &
  99 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=60 binmax=70 outmap=tsmap_split_6.fits logfile=tsmap_split_6.log &
  100 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=70 binmax=80 outmap=tsmap_split_7.fits logfile=tsmap_split_7.log &
  101 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=80 binmax=90 outmap=tsmap_split_8.fits logfile=tsmap_split_8.log &
  102 + cttsmap inobs=cntcube.fits inmodel=stacked_models.xml srcname=Src001 expcube=expcube.fits psfcube=psfcube.fits bkgcube=bkgcube.fits edisp=no errors=no usepnt=no nxpix=10 nypix=10 binsz=0.05 coordsys=GAL proj=CAR xref=0.0 yref=0.0 publish=no chatter=2 clobber=yes debug=no mode=ql logL0=-227629.3114637738 binmin=90 binmax=100 outmap=tsmap_split_9.fits logfile=tsmap_split_9.log &
98 103  
99 104 Now run the ASCII file by typing
100 105  
... ... @@ -111,6 +116,3 @@ The figure below shows the resulting Test Statistic map.
111 116 $ cstsmapmerge
112 117 Input TS map FITS files [tsmap.fits] tsmap_split_*.fits
113 118 Output TS map FITS file [NONE] tsmap_split.fits
114   -
115   -
116   -
... ...
doc/source/users/tutorials/1dc/howto_ulimit.rst
  View file @96d2ba2
... ... @@ -3,6 +3,11 @@
3 3 How to compute upper limits?
4 4 ----------------------------
5 5  
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how to **determine the upper flux limit for a source** using the
  9 + :ref:`ctulimit` tool.
  10 +
6 11 You determine upper limits for gamma-ray sources using the :ref:`ctulimit`
7 12 tool.
8 13  
... ... @@ -39,7 +44,7 @@ and then run the :ref:`ctulimit` as follows:
39 44 Input PSF cube file (only needed for stacked analysis) [NONE] psfcube.fits
40 45 Input background cube file (only needed for stacked analysis) [NONE] bkgcube.fits
41 46 Source of interest [Crab] Test
42   - Input model definition XML file [$CTOOLS/share/models/crab.xml] stacked_models_iem_ul.xml
  47 + Input model definition XML file [$CTOOLS/share/models/crab.xml] stacked_models-cutoff-iem-up.xml
43 48  
44 49 After the run, the upper gamma-ray flux limit for this test source can be
45 50 extracted from the :ref:`ctulimit` log file:
... ...
doc/source/users/tutorials/1dc/howto_vo.rst
  View file @96d2ba2
... ... @@ -3,6 +3,13 @@
3 3 How to use Virtual Observatory tools with ctools?
4 4 -------------------------------------------------
5 5  
  6 +.. admonition:: You will learn ...
  7 +
  8 + ... how to interaction with Virtual Observatory tools such as
  9 + `Aladin <http://aladin.u-strasbg.fr>`_
  10 + or
  11 + `Topcat <http://www.star.bris.ac.uk/~mbt/topcat/>`_.
  12 +
6 13 Several ctools can interact with Virtual Observatory tools such as
7 14 `Aladin <http://aladin.u-strasbg.fr>`_
8 15 or
... ... @@ -15,7 +22,7 @@ Let&#39;s take the example of generating a sky map, as explained
15 22 application on your desktop:
16 23  
17 24 .. figure:: howto_vo_aladin_before.png
18   - :width: 400px
  25 + :width: 600px
19 26 :align: center
20 27  
21 28 *Aladin application after start-up*
... ... @@ -45,7 +52,7 @@ appear in the
45 52 application (see below).
46 53  
47 54 .. figure:: howto_vo_aladin_after.png
48   - :width: 400px
  55 + :width: 600px
49 56 :align: center
50 57  
51 58 *Aladin application after ctskymap finished execution*
... ... @@ -58,47 +65,90 @@ catalogue which allows us to identify ``Src001`` with a Fermi/LAT source at
58 65 the Galactic centre.
59 66  
60 67 .. figure:: howto_vo_aladin_catalog.png
61   - :width: 400px
  68 + :width: 600px
62 69 :align: center
63 70  
64 71 *Overlay of the Fermi/LAT 3FGL catalogue over the sky map*
65 72  
66   -Below the list of tools and scripts that interact with Virtual Observatory
67   -tools. Some tools or scripts publish tables instead of images, and the tables
68   -can for example by displayed and explored using
  73 +Another example is the display of an event list using
69 74 `Topcat <http://www.star.bris.ac.uk/~mbt/topcat/>`_.
  75 +Start with launching the
  76 +`Topcat <http://www.star.bris.ac.uk/~mbt/topcat/>`_
  77 +application on your desktop:
70 78  
71   -+-------------------+--------+-------------------+
72   -| Tool or script | Object | VO tool (example) |
73   -+===================+========+===================+
74   -| :ref:`cslightcrv` | Table | Topcat |
75   -+-------------------+--------+-------------------+
76   -| :ref:`csresmap` | Image | Aladin |
77   -+-------------------+--------+-------------------+
78   -| :ref:`csspec` | Table | Topcat |
79   -+-------------------+--------+-------------------+
80   -| :ref:`csviscube` | Image | Aladin |
81   -+-------------------+--------+-------------------+
82   -| :ref:`ctbin` | Image | Aladin |
83   -+-------------------+--------+-------------------+
84   -| :ref:`ctbkgcube` | Image | Aladin |
85   -+-------------------+--------+-------------------+
86   -| :ref:`ctcubemask` | Image | Aladin |
87   -+-------------------+--------+-------------------+
88   -| :ref:`ctexpcube` | Image | Aladin |
89   -+-------------------+--------+-------------------+
90   -| :ref:`ctmapcube` | Image | Aladin |
91   -+-------------------+--------+-------------------+
92   -| :ref:`ctmodel` | Image | Aladin |
93   -+-------------------+--------+-------------------+
94   -| :ref:`ctobssim` | Table | Topcat |
95   -+-------------------+--------+-------------------+
96   -| :ref:`ctselect` | Table | Topcat |
97   -+-------------------+--------+-------------------+
98   -| :ref:`ctskymap` | Image | Aladin |
99   -+-------------------+--------+-------------------+
100   -| :ref:`cttsmap` | Image | Aladin |
101   -+-------------------+--------+-------------------+
  79 +.. figure:: howto_vo_topcat_before.png
  80 + :width: 600px
  81 + :align: center
  82 +
  83 + *Topcat application after start-up*
102 84  
  85 +Then run :ref:`ctselect` for event selection and specify ``publish=yes`` as
  86 +argument after the tool name:
  87 +
  88 +.. code-block:: bash
103 89  
  90 + $ ctselect publish=yes
  91 + Input event list or observation definition XML file [selected_gps_baseline_120380.fits]
  92 + RA for ROI centre (degrees) (0-360) [UNDEFINED]
  93 + Start time (CTA MET in seconds) [UNDEFINED]
  94 + Lower energy limit (TeV) [0.2]
  95 + Upper energy limit (TeV) [50.0]
  96 + Output event list or observation definition XML file [selected_gps_baseline_120380_0.2-50TeV.fits]
  97 +
  98 +Once :ref:`ctselect` has terminated, the resulting event list will automatically
  99 +appear in the
  100 +`Topcat <http://www.star.bris.ac.uk/~mbt/topcat/>`_
  101 +application (see below).
  102 +
  103 +.. figure:: howto_vo_topcat_after.png
  104 + :width: 600px
  105 + :align: center
  106 +
  107 + *Topcat application after ctselect finished execution*
  108 +
  109 +You can now open the 3-dimensional display tab and visualise the data in
  110 +a coordinate system that is spanned by Right Ascension, Declination and
  111 +energy (see below).
  112 +
  113 +.. figure:: howto_vo_topcat_scatter.png
  114 + :width: 600px
  115 + :align: center
  116 +
  117 + *Display of event list in 3-dimensional representation*
  118 +
  119 +Below the list of tools and scripts that interact with Virtual Observatory
  120 +tools. Some tools or scripts publish tables instead of images, and the tables
  121 +can for example by displayed and explored using
  122 +`Topcat <http://www.star.bris.ac.uk/~mbt/topcat/>`_.
104 123  
  124 + +-------------------+--------+-------------------+
  125 + | Tool or script | Object | VO tool (example) |
  126 + +===================+========+===================+
  127 + | :ref:`cslightcrv` | Table | Topcat |
  128 + +-------------------+--------+-------------------+
  129 + | :ref:`csresmap` | Image | Aladin |
  130 + +-------------------+--------+-------------------+
  131 + | :ref:`csspec` | Table | Topcat |
  132 + +-------------------+--------+-------------------+
  133 + | :ref:`csviscube` | Image | Aladin |
  134 + +-------------------+--------+-------------------+
  135 + | :ref:`ctbin` | Image | Aladin |
  136 + +-------------------+--------+-------------------+
  137 + | :ref:`ctbkgcube` | Image | Aladin |
  138 + +-------------------+--------+-------------------+
  139 + | :ref:`ctcubemask` | Image | Aladin |
  140 + +-------------------+--------+-------------------+
  141 + | :ref:`ctexpcube` | Image | Aladin |
  142 + +-------------------+--------+-------------------+
  143 + | :ref:`ctmapcube` | Image | Aladin |
  144 + +-------------------+--------+-------------------+
  145 + | :ref:`ctmodel` | Image | Aladin |
  146 + +-------------------+--------+-------------------+
  147 + | :ref:`ctobssim` | Table | Topcat |
  148 + +-------------------+--------+-------------------+
  149 + | :ref:`ctselect` | Table | Topcat |
  150 + +-------------------+--------+-------------------+
  151 + | :ref:`ctskymap` | Image | Aladin |
  152 + +-------------------+--------+-------------------+
  153 + | :ref:`cttsmap` | Image | Aladin |
  154 + +-------------------+--------+-------------------+
... ...
doc/source/users/tutorials/1dc/howto_vo_aladin_after.png
View file @96d2ba2

335 KB | W: | H:

349 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/howto_vo_aladin_catalog.png
View file @96d2ba2

326 KB | W: | H:

343 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/howto_vo_topcat_after.png 0 → 100644
View file @96d2ba2

74.6 KB
doc/source/users/tutorials/1dc/howto_vo_topcat_before.png 0 → 100644
View file @96d2ba2

65.1 KB
doc/source/users/tutorials/1dc/howto_vo_topcat_scatter.png 0 → 100644
View file @96d2ba2

147 KB
doc/source/users/tutorials/1dc/scope.rst
  View file @96d2ba2
... ... @@ -6,7 +6,7 @@ Scope of the first CTA Data Challenge
6 6 The goal of the
7 7 :ref:`first CTA Data Challenge <glossary_1dc>`
8 8 is to enable the CTA Consortium Science Working Groups to derive **science
9   -benchmarks** for the CTA Key Science objectives.
  9 +benchmarks** for the CTA Key Science Projects.
10 10  
11 11 The
12 12 :ref:`first CTA Data Challenge <glossary_1dc>`
... ... @@ -27,26 +27,30 @@ The data distributed in the
27 27 are high-level data in form of
28 28 :ref:`event lists <glossary_eventlist>`
29 29 and
30   -:ref:`Instrument Response Functions <glossary_irf>`
  30 +:ref:`instrument response functions <glossary_irf>`
31 31 (data level 3).
32 32 The
33 33 :ref:`event lists <glossary_eventlist>`
34   -have been simulated from high-level
35   -:ref:`Instrument Response Functions <glossary_irf>`
  34 +were simulated from high-level
  35 +:ref:`instrument response functions <glossary_irf>`
36 36 that correspond to an ideal CTA with good and stable atmosphere and instrument
37   -conditions; only zenith angles of 20 degrees and 40 degrees have been
  37 +conditions; only zenith angles of 20 degrees and 40 degrees were
38 38 simulated.
39 39  
40 40 Data are provided for the baseline arrays. So far only data for the South array
41   -were simulated.
  41 +were simulated, data for the North array will be provided once the
  42 +:ref:`instrument response functions <glossary_irf>`
  43 +for the North array are available.
42 44  
43 45 Three Key Science Projects (KSPs) were simulated using realistic pointing
44 46 patterns as defined in the CTA Science Case document:
45 47  
46 48 * the Galactic Plane Scan (GPS)
47 49 * the Galactic Centre Survey (GC)
48   -* the extragalactic survey
  50 +* the Extragalactic Survey (EGAL)
49 51  
50 52 The source model used for the simulations is distributed together with the
51 53 data to the CTA Consortium Science Working Groups, so that analysis results
52   -can be compared to the Monte Carlo truth.
  54 +can be compared to the Monte Carlo truth. The same source model was used for
  55 +the simulation of all three surveys.
  56 +
... ...