Mathieu Servillat / ctools

Commit 0b29710ae4944f7e8df8ce007f6c3d911b34d7cb

Authored by Jürgen Knödlseder
1 parent 6bfe9638

Update documentation.

Inline Side-by-side
Showing 5 changed files with 40 additions and 48 deletions
doc/source/reference_manual/ctbkgcube.rst
  View file @0b29710
... ... @@ -3,17 +3,17 @@
3 3 ctbkgcube
4 4 =========
5 5  
6   -Generate background cube for a counts cube.
  6 +Generate background cube for a stacked analysis.
7 7  
8 8  
9 9 Synopsis
10 10 --------
11 11  
12   -This tool generates a background cube for a counts cube based on an input
13   -model. A background cube is a 3-dimensional cube spanned by Right Ascension
14   -or Galactic longitude, Declination or Galactic latitude, and energy. The
15   -energy binning may be either linear, logarithmic, or custom defined using an
16   -input file. The input model is used to predict the expected number of
  12 +This tool generates a background cube for a stacked analysis based on an
  13 +input model. A background cube is a 3-dimensional cube spanned by Right
  14 +Ascension or Galactic longitude, Declination or Galactic latitude, and energy.
  15 +The energy binning may be either linear, logarithmic, or custom defined using
  16 +an input file. The input model is used to predict the expected number of
17 17 background counts in each background cube bin.
18 18  
19 19 ctbkgcube requires on input the event list or observation definition file
... ...
doc/source/reference_manual/ctedispcube.rst
  View file @0b29710
1 1 .. _ctedispcube:
2 2  
3 3 ctedispcube
4   -=========
  4 +===========
5 5  
6   -Generate energy dispersion cube for a counts cube.
  6 +Generate energy dispersion cube for a stacked analysis.
7 7  
8 8  
9 9 Synopsis
10 10 --------
11 11  
12   -This tool generates an energy dispersion cube for a counts cube. An energy
13   -dispersion cube is a 4-dimensional cube spanned by Right Ascension or
14   -Galactic longitude, Declination or Galactic latitude, energy, and fraction
15   -between recontructed and true photon energy. The energy binning of the cube
16   -may be either linear, logarithmic, or custom defined using an input file.
  12 +This tool generates an energy dispersion cube for a stacked analysis. An
  13 +energy dispersion cube is a 4-dimensional cube spanned by Right Ascension or
  14 +Galactic longitude, Declination or Galactic latitude, energy, and migration
  15 +which is the ratio between reconstructed and true photon energy. The energy
  16 +binning of the cube may be either linear, logarithmic, or custom defined
  17 +using an input file
17 18  
18   -ctedispcube requires on input the event list or observation definition file
19   -that has been used in the generation of the counts cube using :doc:`ctbin`.
  19 +ctedispcube requires on input the event list or observation definition XML
  20 +file that has been used in the generation of the counts cube using :doc:`ctbin`.
20 21  
21 22 It is not recommended to use the counts cube for the energy dispersion
22 23 cube definition, although this is formally possible by specifying the counts
23 24 cube as ``incube`` parameter. This leads however to a large FITS file on
24 25 output since the number of bins in the counts cube will be multiplied by
25   -the number of offset angle bins (typically 200). Since the energy dispersion
26   -varies only little over the field of view of the camera it is
27   -recommended to use a rather coarse spatial binning to keep the file size
28   -manageable (with a typical value of ``binsz=1.0``).
  26 +the number of migration (typically 100). Since the energy dispersion varies
  27 +only little over the field of view of the camera it is recommended to use a
  28 +rather coarse spatial binning to keep the file size manageable (with a typical
  29 +value of ``binsz=1.0``).
29 30  
30 31 ctedispcube generates an energy dispersion cube FITS file comprising three
31 32 extensions. The primary extension contains a 3-dimensional image that contains
32 33 the energy disperison values. The energy and fraction dimensions of the enrgy
33 34 dispersion cube are folded into the 3rd dimension of the FITS image. The next
34   -extension named ``EBOUNDS`` contains a binary table that defines the energy
35   -boundaries of the exposure cube. The last extension named ``DELTAS`` contains
36   -a binary table that defines the fraction between recontructed and true photon
37   -energy.
  35 +extension named ``ENERGIES`` contains a binary table that defines the energy
  36 +values of the energy dispersion cube. The last extension named ``MIGRAS``
  37 +contains a binary table that defines the migration values of the cube which
  38 +is the ratio between reconstructed and true photon energy.
38 39  
39 40  
40 41 General parameters
... ... @@ -52,9 +53,6 @@ General parameters
52 53 ``irf [string]``
53 54 Instrument response function.
54 55  
55   -``(edisp = no) [boolean]``
56   - Apply energy dispersion for response computation.
57   -
58 56 ``outcube [file]``
59 57 Output energy dispersion cube file.
60 58  
... ... @@ -97,10 +95,10 @@ General parameters
97 95 ``proj <AIT|AZP|CAR|MER|MOL|STG|TAN> [string]``
98 96 Projection method.
99 97  
100   -``(mmax = 10.0) [real]``
101   - Upper bound of fraction between recontructed and true photon energy.
  98 +``(migramax = 2.0) [real]``
  99 + Upper bound of ratio between reconstructed and true photon energy.
102 100  
103   -``(migrabins = 200) [integer]``
  101 +``(migrabins = 100) [integer]``
104 102 Number of migration bins.
105 103  
106 104  
... ...
doc/source/reference_manual/ctexpcube.rst
  View file @0b29710
... ... @@ -3,14 +3,14 @@
3 3 ctexpcube
4 4 =========
5 5  
6   -Generate exposure cube for a counts cube.
  6 +Generate exposure cube for a stacked analysis.
7 7  
8 8  
9 9 Synopsis
10 10 --------
11 11  
12   -This tool generates an exposure cube for a counts cube. An exposure cube is
13   -a 3-dimensional cube spanned by Right Ascension or Galactic longitude,
  12 +This tool generates an exposure cube for a stacked analysis. An exposure
  13 +cube is a 3-dimensional cube spanned by Right Ascension or Galactic longitude,
14 14 Declination or Galactic latitude, and energy, that gives the exposure
15 15 as function of true sky direction and energy. The energy binning of the cube
16 16 may be either linear, logarithmic, or custom defined using an input file.
... ... @@ -56,9 +56,6 @@ General parameters
56 56 ``irf [string]``
57 57 Instrument response function.
58 58  
59   -``(edisp = no) [boolean]``
60   - Apply energy dispersion for response computation?
61   -
62 59 ``outcube [file]``
63 60 Output exposure cube file.
64 61  
... ...
doc/source/reference_manual/ctpsfcube.rst
  View file @0b29710
... ... @@ -3,21 +3,21 @@
3 3 ctpsfcube
4 4 =========
5 5  
6   -Generate point spread function cube for a counts cube.
  6 +Generate point spread function cube for a stacked analysis.
7 7  
8 8  
9 9 Synopsis
10 10 --------
11 11  
12   -This tool generates a point spread function cube for a counts cube. A point
13   -spread function cube is a 4-dimensional cube spanned by Right Ascension or
14   -Galactic longitude, Declination or Galactic latitude, energy, and offset
15   -angle between true and measured arrival direction of a photon. The energy
16   -binning of the cube may be either linear, logarithmic, or custom defined
17   -using an input file.
  12 +This tool generates a point spread function cube for a stacked analysis.
  13 +A point spread function cube is a 4-dimensional cube spanned by Right
  14 +Ascension or Galactic longitude, Declination or Galactic latitude, energy,
  15 +and offset angle between true and measured arrival direction of a photon.
  16 +The energy binning of the cube may be either linear, logarithmic, or custom
  17 +defined using an input file.
18 18  
19   -ctpsfcube requires on input the event list or observation definition file
20   -that has been used in the generation of the counts cube using :doc:`ctbin`.
  19 +ctpsfcube requires on input the event list or observation definition XML
  20 +file that has been used in the generation of the counts cube using :doc:`ctbin`.
21 21  
22 22 It is not recommended to use the counts cube for the point spread function
23 23 cube definition, although this is formally possible by specifying the counts
... ... @@ -53,9 +53,6 @@ General parameters
53 53 ``irf [string]``
54 54 Instrument response function.
55 55  
56   -``(edisp = no) [boolean]``
57   - Apply energy dispersion for response computation.
58   -
59 56 ``outcube [file]``
60 57 Output point spread function cube file.
61 58  
... ...
src/ctedispcube/ctedispcube.par
  View file @0b29710
... ... @@ -47,7 +47,7 @@ proj, s, a, &quot;CAR&quot;, AIT|AZP|CAR|MER|MOL|STG|TAN,, &quot;Projection method&quot;
47 47 #
48 48 # Angular separation binning parameters
49 49 #======================================
50   -migramax, r, h, 2.0,,, "Upper bound of ratio of recontructed to true photon energy"
  50 +migramax, r, h, 2.0,,, "Upper bound of ratio between reconstructed and true photon energy"
51 51 migrabins, i, h, 100,,, "Number of migration bins"
52 52  
53 53 #
... ...