Iftach Sadeh / ctools

Commit 3ffc2688d8fd92984aca5e220d2bb9e9a97bc9ef

Authored by Jürgen Knödlseder
1 parent 2232ee35

Update reference documentation

Inline Side-by-side
Showing 2 changed files with 40 additions and 36 deletions
doc/source/users/reference_manual/cslightcrv.rst
  View file @3ffc268
@@ -44,12 +44,12 @@ General parameters @@ -44,12 +44,12 @@ General parameters
44 44
45 ``(inexclusion = NONE) [file]`` 45 ``(inexclusion = NONE) [file]``
46 Optional FITS file containing a WCS map in the first hdu that defines sky 46 Optional FITS file containing a WCS map in the first hdu that defines sky
47 - regions not to be used for background estimation in On/Off analysis (where 47 + regions not to be used for background estimation in ``ONOFF`` analysis (where
48 map value != 0). 48 map value != 0).
49 49
50 ``(edisp = no) [boolean]`` 50 ``(edisp = no) [boolean]``
51 - Applies energy dispersion to response computation (for Cube analysis only,  
52 - energy dispersion is always taken into account in On/Off analysis). 51 + Applies energy dispersion to response computation (for ``3D`` analysis only,
  52 + energy dispersion is always taken into account in ``ONOFF`` analysis).
53 53
54 ``outfile [file]`` 54 ``outfile [file]``
55 Name of the light curve output file. 55 Name of the light curve output file.
@@ -70,7 +70,7 @@ General parameters @@ -70,7 +70,7 @@ General parameters
70 File defining the time binning. 70 File defining the time binning.
71 71
72 ``method <3D|ONOFF> [string]`` 72 ``method <3D|ONOFF> [string]``
73 - Selects between 3D analysis (3D spatial/energy likelihood) and ONOFF 73 + Selects between ``3D`` analysis (3D spatial/energy likelihood) and ``ONOFF``
74 analysis (1D likelihood with background from Off regions). 74 analysis (1D likelihood with background from Off regions).
75 75
76 ``emin [real]`` 76 ``emin [real]``
@@ -80,7 +80,7 @@ General parameters @@ -80,7 +80,7 @@ General parameters
80 Upper energy limit of events (in TeV). 80 Upper energy limit of events (in TeV).
81 81
82 ``enumbins [integer]`` 82 ``enumbins [integer]``
83 - Number of energy bins per light curve bin (0=unbinned for Cube analysis only). 83 + Number of energy bins per light curve bin (0=unbinned for ``3D`` analysis only).
84 84
85 ``coordsys <CEL|GAL> [string]`` 85 ``coordsys <CEL|GAL> [string]``
86 Coordinate system (CEL - celestial, GAL - galactic). 86 Coordinate system (CEL - celestial, GAL - galactic).
@@ -89,50 +89,52 @@ General parameters @@ -89,50 +89,52 @@ General parameters
89 Projection method. 89 Projection method.
90 90
91 ``xref [real]`` 91 ``xref [real]``
92 - Right Ascension / Galactic longitude of image / On region centre (J2000, in degrees). 92 + Right Ascension / Galactic longitude of image centre for ``3D`` analysis or
  93 + source region centre for ``ONOFF`` analysis (J2000, in degrees).
93 94
94 ``yref [real]`` 95 ``yref [real]``
95 - Declination / Galactic latitude of image / On region centre (J2000, in degrees). 96 + Declination / Galactic latitude of image centre for ``3D`` analysis or
  97 + source region centre for ``ONOFF`` analysis (J2000, in degrees).
96 98
97 ``nxpix [integer]`` 99 ``nxpix [integer]``
98 - Size of the Right Ascension / Galactic longitude axis for Cube analysis (in pixels). 100 + Size of the Right Ascension / Galactic longitude axis for ``3D`` analysis (in pixels).
99 101
100 ``nypix [integer]`` 102 ``nypix [integer]``
101 - Size of the Declination / Galactic latitude axis for Cube analysis (in pixels). 103 + Size of the Declination / Galactic latitude axis for ``3D`` analysis (in pixels).
102 104
103 ``binsz [real]`` 105 ``binsz [real]``
104 - Pixel size for Cube analysis (in degrees/pixel). 106 + Pixel size for ``3D`` analysis (in degrees/pixel).
105 107
106 ``(srcshape = CIRCLE) [string]`` 108 ``(srcshape = CIRCLE) [string]``
107 - Shape of the source region. 109 + Shape of the source region for ``ONOFF`` analysis.
108 ``CIRCLE``: circular region around given position. 110 ``CIRCLE``: circular region around given position.
109 111
110 ``rad [real]`` 112 ``rad [real]``
111 - Radius of source region circle for On/Off analysis (deg) 113 + Radius of source region circle for ``ONOFF`` analysis (deg)
112 114
113 ``(bkgmethod = REFLECTED) [string]`` 115 ``(bkgmethod = REFLECTED) [string]``
114 - Method for background estimation in On/Off analysis. 116 + Method for background estimation in ``ONOFF`` analysis.
115 ``REFLECTED:`` background evaluated in regions with the same shape as 117 ``REFLECTED:`` background evaluated in regions with the same shape as
116 source region reflected w.r.t. pointing direction for each observation. 118 source region reflected w.r.t. pointing direction for each observation.
117 119
118 ``(bkgregmin = 2) [integer]`` 120 ``(bkgregmin = 2) [integer]``
119 Minimum number of background regions that are required for an observation in 121 Minimum number of background regions that are required for an observation in
120 - On/Off analysis. If this number of background regions is not available the observation is  
121 - skipped. 122 + ``ONOFF`` analysis. If this number of background regions is not available the
  123 + observation is skipped.
122 124
123 ``(maxoffset = 4.0) [real]`` 125 ``(maxoffset = 4.0) [real]``
124 Maximum offset in degrees of source from camera center to accept the 126 Maximum offset in degrees of source from camera center to accept the
125 - observation for On/Off analysis. 127 + observation for ``ONOFF`` analysis.
126 128
127 ``(etruemin = 0.01) [real]`` 129 ``(etruemin = 0.01) [real]``
128 - Minimum true energy to evaluate instrumental response in On/Off analysis (TeV). 130 + Minimum true energy to evaluate instrumental response in ``ONOFF`` analysis (TeV).
129 131
130 ``(etruemax = 0.01) [real]`` 132 ``(etruemax = 0.01) [real]``
131 - Maximum true energy to evaluate instrumental response in On/Off analysis (TeV). 133 + Maximum true energy to evaluate instrumental response in ``ONOFF`` analysis (TeV).
132 134
133 ``(etruebins = 30) [integer]`` 135 ``(etruebins = 30) [integer]``
134 Number of bins per decade for true energy bins to evaluate instrumental 136 Number of bins per decade for true energy bins to evaluate instrumental
135 - response in On/Off analysis. 137 + response in ``ONOFF`` analysis.
136 138
137 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]`` 139 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]``
138 Optimization statistic. ``DEFAULT`` uses the default statistic for all 140 Optimization statistic. ``DEFAULT`` uses the default statistic for all
doc/source/users/reference_manual/csphasecrv.rst
  View file @3ffc268
@@ -43,12 +43,12 @@ General parameters @@ -43,12 +43,12 @@ General parameters
43 43
44 ``(inexclusion = NONE) [file]`` 44 ``(inexclusion = NONE) [file]``
45 Optional FITS file containing a WCS map in the first hdu that defines sky 45 Optional FITS file containing a WCS map in the first hdu that defines sky
46 - regions not to be used for background estimation in On/Off analysis (where 46 + regions not to be used for background estimation in ``ONOFF`` analysis (where
47 map value != 0). 47 map value != 0).
48 48
49 ``(edisp = no) [boolean]`` 49 ``(edisp = no) [boolean]``
50 - Applies energy dispersion to response computation (for Cube analysis only,  
51 - energy dispersion is always taken into account in On/Off analysis). 50 + Applies energy dispersion to response computation (for ``3D`` analysis only,
  51 + energy dispersion is always taken into account in ``ONOFF`` analysis).
52 52
53 ``outfile [file]`` 53 ``outfile [file]``
54 Name of the XML output file. The phase interval will be automatically 54 Name of the XML output file. The phase interval will be automatically
@@ -83,50 +83,52 @@ General parameters @@ -83,50 +83,52 @@ General parameters
83 Projection method. 83 Projection method.
84 84
85 ``xref [real]`` 85 ``xref [real]``
86 - Right Ascension / Galactic longitude of image centre (J2000, in degrees). 86 + Right Ascension / Galactic longitude of image centre for ``3D`` analysis or
  87 + source region centre for ``ONOFF`` analysis (J2000, in degrees).
87 88
88 ``yref [real]`` 89 ``yref [real]``
89 - Declination / Galactic latitude of image centre (J2000, in degrees). 90 + Declination / Galactic latitude of image centre for ``3D`` analysis or
  91 + source region centre for ``ONOFF`` analysis (J2000, in degrees).
90 92
91 ``nxpix [integer]`` 93 ``nxpix [integer]``
92 - Size of the Right Ascension / Galactic longitude axis (in pixels). 94 + Size of the Right Ascension / Galactic longitude axis for ``3D`` analysis (in pixels).
93 95
94 ``nypix [integer]`` 96 ``nypix [integer]``
95 - Size of the Declination / Galactic latitude axis (in pixels). 97 + Size of the Declination / Galactic latitude axis for ``3D`` analysis (in pixels).
96 98
97 ``binsz [real]`` 99 ``binsz [real]``
98 - Pixel size (in degrees/pixel). 100 + Pixel size for ``3D`` analysis (in degrees/pixel).
99 101
100 ``(srcshape = CIRCLE) [string]`` 102 ``(srcshape = CIRCLE) [string]``
101 - Shape of the source region. 103 + Shape of the source region for ``ONOFF`` analysis.
102 ``CIRCLE``: circular region around given position. 104 ``CIRCLE``: circular region around given position.
103 105
104 ``rad [real]`` 106 ``rad [real]``
105 - Radius of source region circle for On/Off analysis (deg) 107 + Radius of source region circle for ``ONOFF`` analysis (deg)
106 108
107 ``(bkgmethod = REFLECTED) [string]`` 109 ``(bkgmethod = REFLECTED) [string]``
108 - Method for background estimation in On/Off analysis. 110 + Method for background estimation in ``ONOFF`` analysis.
109 ``REFLECTED:`` background evaluated in regions with the same shape as 111 ``REFLECTED:`` background evaluated in regions with the same shape as
110 source region reflected w.r.t. pointing direction for each observation. 112 source region reflected w.r.t. pointing direction for each observation.
111 113
112 ``(bkgregmin = 2) [integer]`` 114 ``(bkgregmin = 2) [integer]``
113 Minimum number of background regions that are required for an observation in 115 Minimum number of background regions that are required for an observation in
114 - On/Off analysis. If this number of background regions is not available the observation is  
115 - skipped. 116 + ``ONOFF`` analysis. If this number of background regions is not available the
  117 + observation is skipped.
116 118
117 ``(maxoffset = 4.0) [real]`` 119 ``(maxoffset = 4.0) [real]``
118 Maximum offset in degrees of source from camera center to accept the 120 Maximum offset in degrees of source from camera center to accept the
119 - observation for On/Off analysis. 121 + observation for ``ONOFF`` analysis.
120 122
121 ``(etruemin = 0.01) [real]`` 123 ``(etruemin = 0.01) [real]``
122 - Minimum true energy to evaluate instrumental response in On/Off analysis (TeV). 124 + Minimum true energy to evaluate instrumental response in ``ONOFF`` analysis (TeV).
123 125
124 ``(etruemax = 0.01) [real]`` 126 ``(etruemax = 0.01) [real]``
125 - Maximum true energy to evaluate instrumental response in On/Off analysis (TeV). 127 + Maximum true energy to evaluate instrumental response in ``ONOFF`` analysis (TeV).
126 128
127 ``(etruebins = 30) [integer]`` 129 ``(etruebins = 30) [integer]``
128 Number of bins per decade for true energy bins to evaluate instrumental 130 Number of bins per decade for true energy bins to evaluate instrumental
129 - response in On/Off analysis. 131 + response in ``ONOFF`` analysis.
130 132
131 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]`` 133 ``(statistic = DEFAULT) <DEFAULT|CSTAT|WSTAT|CHI2> [string]``
132 Optimization statistic. ``DEFAULT`` uses the default statistic for all 134 Optimization statistic. ``DEFAULT`` uses the default statistic for all