Commit 02cfa05dd223f250b4e297edded69e2a31c8ef06
1 parent
badc09b9
Remove plotting section from user manual (there is an equivalent section in the HowTo)
Showing
8 changed files
with
0 additions
and
123 deletions
doc/source/users/user_manual/index.rst
doc/source/users/user_manual/plotting.rst deleted
| 1 | -.. _sec_plotting: | ||
| 2 | - | ||
| 3 | -Plotting | ||
| 4 | -======== | ||
| 5 | - | ||
| 6 | -ctools and GammaLib do not include classes and scripts to make plots. | ||
| 7 | - | ||
| 8 | -This is intentional because creating and maintaining plotting tools that work | ||
| 9 | -on all platforms and cover all needs is a big project in itself, and deciding | ||
| 10 | -to support a plotting package that is popular now as part of the CTA science | ||
| 11 | -tools could become very problematic in the future. | ||
| 12 | - | ||
| 13 | -But we realise that most ctools users need to create plots for their high-level | ||
| 14 | -science results, so on this page we provide a few pointers to external packages | ||
| 15 | -and tools. | ||
| 16 | - | ||
| 17 | -Nevertheless, for your convenience several scripts for graphical display are | ||
| 18 | -included in the ctools package that rely on the | ||
| 19 | -`matplotlib <http://matplotlib.org>`_ | ||
| 20 | -Python module. You can find these scripts in the | ||
| 21 | -``$CTOOLS/share/examples/python`` folder. The following scripts are available: | ||
| 22 | - | ||
| 23 | - +------------------------+-----------------------------+ | ||
| 24 | - | Script | Usage | | ||
| 25 | - +========================+=============================+ | ||
| 26 | - | ``show_butterfly.py`` | Display a butterfly diagram | | ||
| 27 | - +------------------------+-----------------------------+ | ||
| 28 | - | ``show_lightcurve.py`` | Display a light curve | | ||
| 29 | - +------------------------+-----------------------------+ | ||
| 30 | - | ``show_obs.py`` | Display observation summary | | ||
| 31 | - +------------------------+-----------------------------+ | ||
| 32 | - | ``show_pointings.py`` | Display pointing directions | | ||
| 33 | - +------------------------+-----------------------------+ | ||
| 34 | - | ``show_phases.py`` | Display event phases | | ||
| 35 | - +------------------------+-----------------------------+ | ||
| 36 | - | ``show_spectrum.py`` | Display a spectrum | | ||
| 37 | - +------------------------+-----------------------------+ | ||
| 38 | - | ||
| 39 | -Below some usage examples and the expected output. | ||
| 40 | - | ||
| 41 | -show_butterfly.py | ||
| 42 | -^^^^^^^^^^^^^^^^^ | ||
| 43 | - | ||
| 44 | -.. code-block:: bash | ||
| 45 | - | ||
| 46 | - $ $CTOOLS/share/examples/python/show_butterfly.py butterfly_src001.txt | ||
| 47 | - | ||
| 48 | -.. figure:: plotting_butterfly.png | ||
| 49 | - :width: 600px | ||
| 50 | - :align: center | ||
| 51 | - | ||
| 52 | - *Butterfly diagram displayed with show_butterfly.py* | ||
| 53 | - | ||
| 54 | - | ||
| 55 | -show_lightcurve.py | ||
| 56 | -^^^^^^^^^^^^^^^^^^ | ||
| 57 | - | ||
| 58 | -.. code-block:: bash | ||
| 59 | - | ||
| 60 | - $ $CTOOLS/share/examples/python/show_lightcurve.py lightcurve.fits | ||
| 61 | - | ||
| 62 | -.. figure:: plotting_lightcurve.png | ||
| 63 | - :width: 600px | ||
| 64 | - :align: center | ||
| 65 | - | ||
| 66 | - *Light curve displayed with show_lightcurve.py* | ||
| 67 | - | ||
| 68 | - | ||
| 69 | -show_obs.py | ||
| 70 | -^^^^^^^^^^^ | ||
| 71 | - | ||
| 72 | -.. code-block:: bash | ||
| 73 | - | ||
| 74 | - $ $CTOOLS/share/examples/python/show_obs.py obs_selected.xml | ||
| 75 | - | ||
| 76 | -.. figure:: plotting_obs.png | ||
| 77 | - :width: 600px | ||
| 78 | - :align: center | ||
| 79 | - | ||
| 80 | - *Observation summary displayed with show_obs.py* | ||
| 81 | - | ||
| 82 | - | ||
| 83 | -show_pointings.py | ||
| 84 | -^^^^^^^^^^^^^^^^^ | ||
| 85 | - | ||
| 86 | -.. code-block:: bash | ||
| 87 | - | ||
| 88 | - $ $CTOOLS/share/examples/python/show_pointings.py obs_selected.xml | ||
| 89 | - | ||
| 90 | -.. figure:: plotting_pointings.png | ||
| 91 | - :width: 600px | ||
| 92 | - :align: center | ||
| 93 | - | ||
| 94 | - *Observation summary displayed with show_pointings.py (zoomed in)* | ||
| 95 | - | ||
| 96 | - | ||
| 97 | -show_phases.py | ||
| 98 | -^^^^^^^^^^^^^^ | ||
| 99 | - | ||
| 100 | -.. code-block:: bash | ||
| 101 | - | ||
| 102 | - $ $CTOOLS/share/examples/python/show_phases.py -n 50 events_phased.fits | ||
| 103 | - | ||
| 104 | -.. figure:: plotting_phases.png | ||
| 105 | - :width: 600px | ||
| 106 | - :align: center | ||
| 107 | - | ||
| 108 | - *Event phases displayed with show_phases.py* | ||
| 109 | - | ||
| 110 | - | ||
| 111 | -show_spectrum.py | ||
| 112 | -^^^^^^^^^^^^^^^^ | ||
| 113 | - | ||
| 114 | -.. code-block:: bash | ||
| 115 | - | ||
| 116 | - $ $CTOOLS/share/examples/python/show_spectrum.py spectrum_src001.fits | ||
| 117 | - | ||
| 118 | -.. figure:: plotting_spectrum.png | ||
| 119 | - :width: 600px | ||
| 120 | - :align: center | ||
| 121 | - | ||
| 122 | - *Observation summary displayed with show_spectrum.py* |
doc/source/users/user_manual/plotting_butterfly.png deleted
33.2 KB
doc/source/users/user_manual/plotting_lightcurve.png deleted
24.2 KB
doc/source/users/user_manual/plotting_obs.png deleted
72.1 KB
doc/source/users/user_manual/plotting_phases.png deleted
18 KB
doc/source/users/user_manual/plotting_pointings.png deleted
26.6 KB
doc/source/users/user_manual/plotting_spectrum.png deleted
22.5 KB