Andreas Specovius / ctools

Commit 1b3e4c7ad728ad56a6fde188e5fb34e7ee862990

Authored by Jürgen Knödlseder
1 parent f00eb698

Reformat documentation files (mainly convert tabs to spaces)

Inline Side-by-side
Showing 7 changed files with 110 additions and 112 deletions
doc/source/users/notebooks.rst
  View file @1b3e4c7
1 .. _sec_notebooks: 1 .. _sec_notebooks:
2 2
3 Jupyter notebooks 3 Jupyter notebooks
4 -============ 4 +=================
5 5
6 Some of the tutorials are provided as Jupyter notebooks. If you see 6 Some of the tutorials are provided as Jupyter notebooks. If you see
7 this icon 7 this icon
doc/source/users/tutorials/quickstart/butterfly.rst
  View file @1b3e4c7
@@ -38,10 +38,10 @@ default is set to 100. Below an excerpt of the first lines of the @@ -38,10 +38,10 @@ default is set to 100. Below an excerpt of the first lines of the
38 38
39 .. code-block:: none 39 .. code-block:: none
40 40
41 - 103514.216667934 8.08876441182872e-15 7.86364405017512e-15 8.31388477348232e-15  
42 - 110917.48152624 6.81370736945431e-15 6.62965024227895e-15 6.99776449662967e-15  
43 - 118850.222743702 5.73964152654309e-15 5.58918876927557e-15 5.89009428381061e-15  
44 - 127350.308101666 4.83488401643174e-15 4.71191629605204e-15 4.95785173681143e-15 41 + 103514.216667934 8.08876441182872e-15 7.86364405017512e-15 8.31388477348232e-15
  42 + 110917.48152624 6.81370736945431e-15 6.62965024227895e-15 6.99776449662967e-15
  43 + 118850.222743702 5.73964152654309e-15 5.58918876927557e-15 5.89009428381061e-15
  44 + 127350.308101666 4.83488401643174e-15 4.71191629605204e-15 4.95785173681143e-15
45 45
46 ... 46 ...
47 47
doc/source/users/tutorials/quickstart/fitting.rst
  View file @1b3e4c7
@@ -49,27 +49,27 @@ that was produced by the run: @@ -49,27 +49,27 @@ that was produced by the run:
49 49
50 .. code-block:: xml 50 .. code-block:: xml
51 51
52 - <?xml version="1.0" encoding="UTF-8" standalone="no"?>  
53 - <source_library title="source library">  
54 - <source name="Crab" type="PointSource">  
55 - <spectrum type="PowerLaw">  
56 - <parameter name="Prefactor" value="5.75838848465398" error="0.106769545262219" scale="1e-16" min="1e-07" max="1000" free="1" />  
57 - <parameter name="Index" value="2.48329029246896" error="0.0156629819926589" scale="-1" min="0" max="5" free="1" />  
58 - <parameter name="PivotEnergy" value="0.3" scale="1000000" min="0.01" max="1000" free="0" />  
59 - </spectrum>  
60 - <spatialModel type="PointSource">  
61 - <parameter name="RA" value="83.6331" scale="1" min="-360" max="360" free="0" />  
62 - <parameter name="DEC" value="22.0145" scale="1" min="-90" max="90" free="0" />  
63 - </spatialModel>  
64 - </source>  
65 - <source name="BackgroundModel" type="CTACubeBackground" instrument="CTA,HESS,MAGIC,VERITAS">  
66 - <spectrum type="PowerLaw">  
67 - <parameter name="Prefactor" value="1.01452697987952" error="0.0164053949309481" scale="1" min="0.01" max="100" free="1" />  
68 - <parameter name="Index" value="0.0139985850735283" error="0.00978611932246665" scale="1" min="-5" max="5" free="1" />  
69 - <parameter name="PivotEnergy" value="1" scale="1000000" free="0" />  
70 - </spectrum>  
71 - </source>  
72 - </source_library> 52 + <?xml version="1.0" encoding="UTF-8" standalone="no"?>
  53 + <source_library title="source library">
  54 + <source name="Crab" type="PointSource">
  55 + <spectrum type="PowerLaw">
  56 + <parameter name="Prefactor" value="5.75838848465398" error="0.106769545262219" scale="1e-16" min="1e-07" max="1000" free="1" />
  57 + <parameter name="Index" value="2.48329029246896" error="0.0156629819926589" scale="-1" min="0" max="5" free="1" />
  58 + <parameter name="PivotEnergy" value="0.3" scale="1000000" min="0.01" max="1000" free="0" />
  59 + </spectrum>
  60 + <spatialModel type="PointSource">
  61 + <parameter name="RA" value="83.6331" scale="1" min="-360" max="360" free="0" />
  62 + <parameter name="DEC" value="22.0145" scale="1" min="-90" max="90" free="0" />
  63 + </spatialModel>
  64 + </source>
  65 + <source name="BackgroundModel" type="CTACubeBackground" instrument="CTA,HESS,MAGIC,VERITAS">
  66 + <spectrum type="PowerLaw">
  67 + <parameter name="Prefactor" value="1.01452697987952" error="0.0164053949309481" scale="1" min="0.01" max="100" free="1" />
  68 + <parameter name="Index" value="0.0139985850735283" error="0.00978611932246665" scale="1" min="-5" max="5" free="1" />
  69 + <parameter name="PivotEnergy" value="1" scale="1000000" free="0" />
  70 + </spectrum>
  71 + </source>
  72 + </source_library>
73 73
74 In this example, the ``Prefactor`` and ``Index`` of the spectral model for the 74 In this example, the ``Prefactor`` and ``Index`` of the spectral model for the
75 Crab nebula as well as the ``Prefactor`` and ``Index`` of the background spectral 75 Crab nebula as well as the ``Prefactor`` and ``Index`` of the background spectral
doc/source/users/tutorials/quickstart/selecting.rst
  View file @1b3e4c7
@@ -35,43 +35,41 @@ event selection: @@ -35,43 +35,41 @@ event selection:
35 35
36 .. code-block:: none 36 .. code-block:: none
37 37
38 - 2017-11-28T14:21:57: +===================+  
39 - 2017-11-28T14:21:57: | Input observation |  
40 - 2017-11-28T14:21:57: +===================+  
41 - 2017-11-28T14:21:57: === GObservations ===  
42 - 2017-11-28T14:21:57: Number of observations ....: 1  
43 - 2017-11-28T14:21:57: Number of models ..........: 0  
44 - 2017-11-28T14:21:57: Number of observed events .: 200833  
45 - 2017-11-28T14:21:57: Number of predicted events : 0  
46 - 2017-11-28T14:21:57:  
47 - 2017-11-28T14:21:57: +=================+  
48 - 2017-11-28T14:21:57: | Event selection |  
49 - 2017-11-28T14:21:57: +=================+  
50 - 2017-11-28T14:21:57: === CTA observation ===  
51 - 2017-11-28T14:21:57: Input filename ............: events.fits  
52 - 2017-11-28T14:21:57: Event extension name ......: EVENTS  
53 - 2017-11-28T14:21:57: GTI extension name ........: GTI  
54 - 2017-11-28T14:21:58: === Event selection ===  
55 - 2017-11-28T14:21:58: Time range (MJD) ..........: 58849.0077451852 - 58849.0285785185 days  
56 - 2017-11-28T14:21:58: Time range (UTC) ..........: 2020-01-01T00:10:00 - 2020-01-01T00:40:00  
57 - 2017-11-28T14:21:58: Time range (MET) ..........: 631109469.184 - 631111269.184 seconds  
58 - 2017-11-28T14:21:58: Selected energy range .....: 0.1 - 100 TeV  
59 - 2017-11-28T14:21:58: Requested RoI .............: Centre(RA,DEC)=(83.63, 22.01) deg, Radius=3 deg  
60 - 2017-11-28T14:21:58: RoI of data ...............: Centre(RA,DEC)=(83.5, 22.8) deg, Radius=5 deg  
61 - 2017-11-28T14:21:58: Selected RoI ..............: Centre(RA,DEC)=(83.63, 22.01) deg, Radius=3 deg  
62 - 2017-11-28T14:21:58: cfitsio selection .........: TIME >= 631109469.18399978 && TIME <= 631111269.18400002 && ENERGY >= 0.10000000 && ENERGY <= 100.00000000 && ANGSEP(83.630000,22.010000,RA,DEC) <= 3.000000  
63 - 2017-11-28T14:21:58: FITS filename .............: /var/tmp/tmp.0.Nc6oWk[EVENTS][TIME >= 631109469.18399978 && TIME <= 631111269.18400002 && ENERGY >= 0.10000000 && ENERGY <= 100.00000000 && ANGSEP(83.630000,22.010000,RA,DEC) <= 3.000000]  
64 - 2017-11-28T14:21:58:  
65 - 2017-11-28T14:21:58: +====================+  
66 - 2017-11-28T14:21:58: | Output observation |  
67 - 2017-11-28T14:21:58: +====================+  
68 - 2017-11-28T14:21:58: === GObservations ===  
69 - 2017-11-28T14:21:58: Number of observations ....: 1  
70 - 2017-11-28T14:21:58: Number of models ..........: 0  
71 - 2017-11-28T14:21:58: Number of observed events .: 20877  
72 - 2017-11-28T14:21:58: Number of predicted events : 0  
73 - 2017-11-28T14:21:58:  
74 - 2017-11-28T14:21:58: +=================+ 38 + 2017-11-28T14:21:57: +===================+
  39 + 2017-11-28T14:21:57: | Input observation |
  40 + 2017-11-28T14:21:57: +===================+
  41 + 2017-11-28T14:21:57: === GObservations ===
  42 + 2017-11-28T14:21:57: Number of observations ....: 1
  43 + 2017-11-28T14:21:57: Number of models ..........: 0
  44 + 2017-11-28T14:21:57: Number of observed events .: 200833
  45 + 2017-11-28T14:21:57: Number of predicted events : 0
  46 + 2017-11-28T14:21:57:
  47 + 2017-11-28T14:21:57: +=================+
  48 + 2017-11-28T14:21:57: | Event selection |
  49 + 2017-11-28T14:21:57: +=================+
  50 + 2017-11-28T14:21:57: === CTA observation ===
  51 + 2017-11-28T14:21:57: Input filename ............: events.fits
  52 + 2017-11-28T14:21:57: Event extension name ......: EVENTS
  53 + 2017-11-28T14:21:57: GTI extension name ........: GTI
  54 + 2017-11-28T14:21:58: === Event selection ===
  55 + 2017-11-28T14:21:58: Time range (MJD) ..........: 58849.0077451852 - 58849.0285785185 days
  56 + 2017-11-28T14:21:58: Time range (UTC) ..........: 2020-01-01T00:10:00 - 2020-01-01T00:40:00
  57 + 2017-11-28T14:21:58: Time range (MET) ..........: 631109469.184 - 631111269.184 seconds
  58 + 2017-11-28T14:21:58: Selected energy range .....: 0.1 - 100 TeV
  59 + 2017-11-28T14:21:58: Requested RoI .............: Centre(RA,DEC)=(83.63, 22.01) deg, Radius=3 deg
  60 + 2017-11-28T14:21:58: RoI of data ...............: Centre(RA,DEC)=(83.5, 22.8) deg, Radius=5 deg
  61 + 2017-11-28T14:21:58: Selected RoI ..............: Centre(RA,DEC)=(83.63, 22.01) deg, Radius=3 deg
  62 + 2017-11-28T14:21:58: cfitsio selection .........: TIME >= 631109469.18399978 && TIME <= 631111269.18400002 && ENERGY >= 0.10000000 && ENERGY <= 100.00000000 && ANGSEP(83.630000,22.010000,RA,DEC) <= 3.000000
  63 + 2017-11-28T14:21:58: FITS filename .............: /var/tmp/tmp.0.Nc6oWk[EVENTS][TIME >= 631109469.18399978 && TIME <= 631111269.18400002 && ENERGY >= 0.10000000 && ENERGY <= 100.00000000 && ANGSEP(83.630000,22.010000,RA,DEC) <= 3.000000]
  64 + 2017-11-28T14:21:58:
  65 + 2017-11-28T14:21:58: +====================+
  66 + 2017-11-28T14:21:58: | Output observation |
  67 + 2017-11-28T14:21:58: +====================+
  68 + 2017-11-28T14:21:58: === GObservations ===
  69 + 2017-11-28T14:21:58: Number of observations ....: 1
  70 + 2017-11-28T14:21:58: Number of models ..........: 0
  71 + 2017-11-28T14:21:58: Number of observed events .: 20877
  72 + 2017-11-28T14:21:58: Number of predicted events : 0
75 73
76 74
77 From the 200833 events in the input event list 20877 events were selected. 75 From the 200833 events in the input event list 20877 events were selected.
doc/source/users/tutorials/quickstart/simulating.rst
  View file @1b3e4c7
@@ -24,18 +24,18 @@ characteristics of the simulation: @@ -24,18 +24,18 @@ characteristics of the simulation:
24 24
25 .. code-block:: bash 25 .. code-block:: bash
26 26
27 - $ ctobssim  
28 - RA of pointing (degrees) (0-360) [83.63] 83.5  
29 - Dec of pointing (degrees) (-90-90) [22.01] 22.8  
30 - Radius of FOV (degrees) (0-180) [5.0]  
31 - Start time (UTC string, JD, MJD or MET in seconds) [2020-01-01T00:00:00]  
32 - Stop time (UTC string, JD, MJD or MET in seconds) [2020-01-01T01:00:00] 2020-01-01T01:00:00  
33 - Lower energy limit (TeV) [0.03]  
34 - Upper energy limit (TeV) [200.]  
35 - Calibration database [prod2]  
36 - Instrument response function [South_0.5h]  
37 - Input model definition XML file [$CTOOLS/share/models/crab.xml]  
38 - Output event data file or observation definition XML file [events.fits] 27 + $ ctobssim
  28 + RA of pointing (degrees) (0-360) [83.63] 83.5
  29 + Dec of pointing (degrees) (-90-90) [22.01] 22.8
  30 + Radius of FOV (degrees) (0-180) [5.0]
  31 + Start time (UTC string, JD, MJD or MET in seconds) [2020-01-01T00:00:00]
  32 + Stop time (UTC string, JD, MJD or MET in seconds) [2020-01-01T01:00:00] 2020-01-01T01:00:00
  33 + Lower energy limit (TeV) [0.03]
  34 + Upper energy limit (TeV) [200.]
  35 + Calibration database [prod2]
  36 + Instrument response function [South_0.5h]
  37 + Input model definition XML file [$CTOOLS/share/models/crab.xml]
  38 + Output event data file or observation definition XML file [events.fits]
39 39
40 Each line represents a query for one parameter value. 40 Each line represents a query for one parameter value.
41 The line starts with a short description of the parameter, followed by 41 The line starts with a short description of the parameter, followed by
@@ -211,29 +211,29 @@ from this file are shown here: @@ -211,29 +211,29 @@ from this file are shown here:
211 211
212 .. code-block:: none 212 .. code-block:: none
213 213
214 - 2017-11-28T14:13:40: === CTA observation ===  
215 - 2017-11-28T14:13:40: Simulation cone ...........: RA=83.5 deg, Dec=22.8 deg, radius=5.5 deg  
216 - 2017-11-28T14:13:40: Time interval .............: 6.31109e+08 - 6.31112e+08 s  
217 - 2017-11-28T14:13:40: Photon energy range .......: 30 GeV - 72.3622611060088 GeV  
218 - 2017-11-28T14:13:40: Event energy range ........: 30 GeV - 72.3622611060088 GeV  
219 - 2017-11-28T14:13:40: Simulation area ..........: 1.97769e+09 cm2  
220 - 2017-11-28T14:13:40: Use model ................: Crab  
221 - 2017-11-28T14:13:40: Normalization ............: 1 [Crab]  
222 - 2017-11-28T14:13:40: Flux .....................: 2.5413e-09 [Crab] photons/cm2/s  
223 - 2017-11-28T14:13:40: Normalized flux ..........: 2.5413e-09 [Crab] photons/cm2/s  
224 - 2017-11-28T14:13:40: Photon rate ..............: 5.0259 photons/s [Crab]  
225 - 2017-11-28T14:13:40: MC source photons ........: 18186 [Crab]  
226 - 2017-11-28T14:13:40: MC source events .........: 3544 [Crab]  
227 - 2017-11-28T14:13:40: MC source events .........: 3544 (all source models)  
228 - 2017-11-28T14:13:40: Photon energy range .......: 72.3622611060088 GeV - 174.543227745807 GeV  
229 - ...  
230 - 2017-11-28T14:13:40: MC source photons .........: 47219 [Crab]  
231 - 2017-11-28T14:13:40: MC source events ..........: 11356 [Crab]  
232 - 2017-11-28T14:13:49: MC events outside ROI .....: 0  
233 - 2017-11-28T14:13:49: MC background events ......: 189477  
234 - 2017-11-28T14:13:49: MC identifier 1 ...........: Crab  
235 - 2017-11-28T14:13:49: MC identifier 2 ...........: CTABackgroundModel  
236 - 2017-11-28T14:13:49: MC events .................: 200833 (all models) 214 + 2017-11-28T14:13:40: === CTA observation ===
  215 + 2017-11-28T14:13:40: Simulation cone ...........: RA=83.5 deg, Dec=22.8 deg, radius=5.5 deg
  216 + 2017-11-28T14:13:40: Time interval .............: 6.31109e+08 - 6.31112e+08 s
  217 + 2017-11-28T14:13:40: Photon energy range .......: 30 GeV - 72.3622611060088 GeV
  218 + 2017-11-28T14:13:40: Event energy range ........: 30 GeV - 72.3622611060088 GeV
  219 + 2017-11-28T14:13:40: Simulation area ..........: 1.97769e+09 cm2
  220 + 2017-11-28T14:13:40: Use model ................: Crab
  221 + 2017-11-28T14:13:40: Normalization ............: 1 [Crab]
  222 + 2017-11-28T14:13:40: Flux .....................: 2.5413e-09 [Crab] photons/cm2/s
  223 + 2017-11-28T14:13:40: Normalized flux ..........: 2.5413e-09 [Crab] photons/cm2/s
  224 + 2017-11-28T14:13:40: Photon rate ..............: 5.0259 photons/s [Crab]
  225 + 2017-11-28T14:13:40: MC source photons ........: 18186 [Crab]
  226 + 2017-11-28T14:13:40: MC source events .........: 3544 [Crab]
  227 + 2017-11-28T14:13:40: MC source events .........: 3544 (all source models)
  228 + 2017-11-28T14:13:40: Photon energy range .......: 72.3622611060088 GeV - 174.543227745807 GeV
  229 + ...
  230 + 2017-11-28T14:13:40: MC source photons .........: 47219 [Crab]
  231 + 2017-11-28T14:13:40: MC source events ..........: 11356 [Crab]
  232 + 2017-11-28T14:13:49: MC events outside ROI .....: 0
  233 + 2017-11-28T14:13:49: MC background events ......: 189477
  234 + 2017-11-28T14:13:49: MC identifier 1 ...........: Crab
  235 + 2017-11-28T14:13:49: MC identifier 2 ...........: CTABackgroundModel
  236 + 2017-11-28T14:13:49: MC events .................: 200833 (all models)
237 237
238 Each line starts with the UTC time at which the line has been written. In 238 Each line starts with the UTC time at which the line has been written. In
239 this run, 47219 Crab photons have been thrown. 11356 of these photons have been 239 this run, 47219 Crab photons have been thrown. 11356 of these photons have been
doc/source/users/tutorials/quickstart/spectrum.rst
  View file @1b3e4c7
@@ -26,19 +26,19 @@ bins between 100 GeV and 100 TeV: @@ -26,19 +26,19 @@ bins between 100 GeV and 100 TeV:
26 26
27 .. code-block:: bash 27 .. code-block:: bash
28 28
29 - $ csspec  
30 - Input event list, counts cube, or observation definition XML file [events.fits] cntcube.fits  
31 - Input exposure cube file [NONE] expcube.fits  
32 - Input PSF cube file [NONE] psfcube.fits  
33 - Input background cube file [NONE] bkgcube.fits  
34 - Input model definition XML file [$CTOOLS/share/models/crab.xml] crab_results.xml  
35 - Source name [Crab]  
36 - Spectrum generation method (SLICE|NODES|AUTO) [AUTO]  
37 - Binning algorithm (LIN|LOG|FILE) [LOG]  
38 - Lower energy limit (TeV) [0.1]  
39 - Upper energy limit (TeV) [100.0]  
40 - Number of energy bins [20] 10  
41 - Output spectrum file [spectrum.fits] 29 + $ csspec
  30 + Input event list, counts cube, or observation definition XML file [events.fits] cntcube.fits
  31 + Input exposure cube file [NONE] expcube.fits
  32 + Input PSF cube file [NONE] psfcube.fits
  33 + Input background cube file [NONE] bkgcube.fits
  34 + Input model definition XML file [$CTOOLS/share/models/crab.xml] crab_results.xml
  35 + Source name [Crab]
  36 + Spectrum generation method (SLICE|NODES|AUTO) [AUTO]
  37 + Binning algorithm (LIN|LOG|FILE) [LOG]
  38 + Lower energy limit (TeV) [0.1]
  39 + Upper energy limit (TeV) [100.0]
  40 + Number of energy bins [20] 10
  41 + Output spectrum file [spectrum.fits]
42 42
43 There are different methods to create a binned spectrum: 43 There are different methods to create a binned spectrum:
44 44
models/Makefile.am
  View file @1b3e4c7
@@ -21,7 +21,7 @@ @@ -21,7 +21,7 @@
21 21
22 # Models to install 22 # Models to install
23 models = crab.xml \ 23 models = crab.xml \
24 - crab_beyond.xml \ 24 + crab_beyond.xml \
25 crab_poly.xml \ 25 crab_poly.xml \
26 crab_profile.xml \ 26 crab_profile.xml \
27 disk.xml \ 27 disk.xml \