Commit 821c6a4ee2050790a1db2a3f3fccd650a2333af7

Authored by Jürgen Knödlseder
1 parent 66892c1a

Add information about ctool base class.

Showing 2 changed files with 30 additions and 18 deletions
ChangeLog
1 -2014-10-09 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu> 1 +2014-10-10 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
2 2
3 * Version 0.8.0 released 3 * Version 0.8.0 released
4 ======================== 4 ========================
5 5
6 Clean-up public interface 6 Clean-up public interface
7 Adapt to GammaLib 0.9.0 interface 7 Adapt to GammaLib 0.9.0 interface
  8 + Introduce ctool base class
8 ctbin now always merges event lists into a single counts cube 9 ctbin now always merges event lists into a single counts cube
9 ctmodel now always creates a single model cube 10 ctmodel now always creates a single model cube
10 Add ctexpcube tool (generates exposure cube) 11 Add ctexpcube tool (generates exposure cube)
@@ -2,7 +2,7 @@ New Features and Important Changes in ctools 00-08-00 @@ -2,7 +2,7 @@ New Features and Important Changes in ctools 00-08-00
2 2
3 Author(s) : Juergen Knoedlseder 3 Author(s) : Juergen Knoedlseder
4 4
5 -9 October 2014 5 +10 October 2014
6 6
7 7
8 1. Introduction 8 1. Introduction
@@ -16,6 +16,10 @@ exposed. Low-level methods that are used by the application are now @@ -16,6 +16,10 @@ exposed. Low-level methods that are used by the application are now
16 protected, as improper usage of these methods may lead to 16 protected, as improper usage of these methods may lead to
17 unpredictable results. 17 unpredictable results.
18 18
  19 +The ctool base class has been introduced and all tools now derive
  20 +from ctool instead of GApplication. This allows to avoid code
  21 +duplications and makes the code generally slimmer and more readable.
  22 +
19 23
20 2. Configuration 24 2. Configuration
21 ----------------- 25 -----------------
@@ -27,7 +31,14 @@ None @@ -27,7 +31,14 @@ None
27 None 31 None
28 32
29 33
30 -4. ctobssim - CTA observation simulation 34 +4. Support model
  35 +----------------
  36 +A support module has been introduced that will contain common classes
  37 +and functions. For the moment the only class in this module is the
  38 +ctool base class.
  39 +
  40 +
  41 +5. ctobssim - CTA observation simulation
31 ---------------------------------------- 42 ----------------------------------------
32 ctobssim was not fully thread save as the models were shared among the 43 ctobssim was not fully thread save as the models were shared among the
33 threads which led to concurrent memory access when evaluating the Monte 44 threads which led to concurrent memory access when evaluating the Monte
@@ -38,7 +49,7 @@ ctobssim now also supports the handling of energy dispersion. Energy @@ -38,7 +49,7 @@ ctobssim now also supports the handling of energy dispersion. Energy
38 dispersion can be switched on or off using the hidden edisp parameter. 49 dispersion can be switched on or off using the hidden edisp parameter.
39 50
40 51
41 -5. ctselect - CTA event selection 52 +6. ctselect - CTA event selection
42 --------------------------------- 53 ---------------------------------
43 The temporary file is now properly close to avoid file opening errors 54 The temporary file is now properly close to avoid file opening errors
44 when iterating over ctselect (#1149). 55 when iterating over ctselect (#1149).
@@ -49,7 +60,7 @@ internally converted to the reference time of the GTI before event @@ -49,7 +60,7 @@ internally converted to the reference time of the GTI before event
49 selection (#1329). 60 selection (#1329).
50 61
51 62
52 -6. ctbin - CTA event binning 63 +7. ctbin - CTA event binning
53 ---------------------------- 64 ----------------------------
54 WARNING: The philosophy behind the ctbin tool changed fundamentally! 65 WARNING: The philosophy behind the ctbin tool changed fundamentally!
55 66
@@ -69,7 +80,7 @@ case of binning a single event list and using the usepnt=yes option @@ -69,7 +80,7 @@ case of binning a single event list and using the usepnt=yes option
69 (or specifying the pointing manually as the xref and yref parameters). 80 (or specifying the pointing manually as the xref and yref parameters).
70 81
71 82
72 -7. ctlike - Maximum likelihood fitting 83 +8. ctlike - Maximum likelihood fitting
73 -------------------------------------- 84 --------------------------------------
74 ctlike now has full access to the calibration database, allowing 85 ctlike now has full access to the calibration database, allowing
75 the use for 2D response functions in FITS files. 86 the use for 2D response functions in FITS files.
@@ -78,7 +89,7 @@ ctlike now also supports the handling of energy dispersion. Energy @@ -78,7 +89,7 @@ ctlike now also supports the handling of energy dispersion. Energy
78 dispersion can be switched on or off using the hidden edisp parameter. 89 dispersion can be switched on or off using the hidden edisp parameter.
79 90
80 91
81 -8. cttsmap - Generation of Test Statistics map 92 +9. cttsmap - Generation of Test Statistics map
82 ---------------------------------------------- 93 ----------------------------------------------
83 The cttsmap tool has been added that provides a test statistics map 94 The cttsmap tool has been added that provides a test statistics map
84 for a given set of observations. This tool is not restricted to CTA 95 for a given set of observations. This tool is not restricted to CTA
@@ -93,12 +104,12 @@ TS map. Also the value of the fitted parameters are stored as @@ -93,12 +104,12 @@ TS map. Also the value of the fitted parameters are stored as
93 extension in the FITS file. 104 extension in the FITS file.
94 105
95 106
96 -9. ctskymap - CTA sky mapping  
97 ------------------------------ 107 +10. ctskymap - CTA sky mapping
  108 +------------------------------
98 None 109 None
99 110
100 111
101 -10. ctmodel - CTA counts cube modelling 112 +11. ctmodel - CTA counts cube modelling
102 --------------------------------------- 113 ---------------------------------------
103 WARNING: The philosophy behind the ctmodel tool changed fundamentally! 114 WARNING: The philosophy behind the ctmodel tool changed fundamentally!
104 115
@@ -125,7 +136,7 @@ ctmodel now also supports the handling of energy dispersion. Energy @@ -125,7 +136,7 @@ ctmodel now also supports the handling of energy dispersion. Energy
125 dispersion can be switched on or off using the hidden edisp parameter. 136 dispersion can be switched on or off using the hidden edisp parameter.
126 137
127 138
128 -11. ctexpcube - CTA exposure cube generation 139 +12. ctexpcube - CTA exposure cube generation
129 -------------------------------------------- 140 --------------------------------------------
130 The first version of the ctexpcube tool is included in the release. 141 The first version of the ctexpcube tool is included in the release.
131 ctexpcube computes the exposure cube for an observation definition 142 ctexpcube computes the exposure cube for an observation definition
@@ -133,7 +144,7 @@ file. The cube definition may be taken from a counts cube or may be @@ -133,7 +144,7 @@ file. The cube definition may be taken from a counts cube or may be
133 specified by user parameters. 144 specified by user parameters.
134 145
135 146
136 -12. ctpsfcube - CTA point spread function cube generation 147 +13. ctpsfcube - CTA point spread function cube generation
137 --------------------------------------------------------- 148 ---------------------------------------------------------
138 The first version of the ctpsfcube tool is included in the release. 149 The first version of the ctpsfcube tool is included in the release.
139 ctpsfcube computes the point spread function cube for an observation 150 ctpsfcube computes the point spread function cube for an observation
@@ -141,7 +152,7 @@ definition file. The cube definition may be taken from a counts cube @@ -141,7 +152,7 @@ definition file. The cube definition may be taken from a counts cube
141 or may be specified by user parameters. 152 or may be specified by user parameters.
142 153
143 154
144 -13. ctbkgcube - CTA background cube generation 155 +14. ctbkgcube - CTA background cube generation
145 ---------------------------------------------- 156 ----------------------------------------------
146 The first version of the ctbkgcube tool is included in the release. 157 The first version of the ctbkgcube tool is included in the release.
147 ctbkgcube computes the background cube for an observation definition 158 ctbkgcube computes the background cube for an observation definition
@@ -149,7 +160,7 @@ file. The cube definition may be taken from a counts cube or may be @@ -149,7 +160,7 @@ file. The cube definition may be taken from a counts cube or may be
149 specified by user parameters. 160 specified by user parameters.
150 161
151 162
152 -14. ctcubemask - CTA cube filtering 163 +15. ctcubemask - CTA cube filtering
153 ----------------------------------- 164 -----------------------------------
154 The first version of the ctcubemask tool is included in the release. 165 The first version of the ctcubemask tool is included in the release.
155 ctcubemask allows filtering of bins in a counts cube by setting the 166 ctcubemask allows filtering of bins in a counts cube by setting the
@@ -157,12 +168,12 @@ bin content to -1. Filtering can be done by energy, for a circular @@ -157,12 +168,12 @@ bin content to -1. Filtering can be done by energy, for a circular
157 Region of Interest (ROI) or using ds9 exclusion regions. 168 Region of Interest (ROI) or using ds9 exclusion regions.
158 169
159 170
160 -15. Examples 171 +16. Examples
161 ------------ 172 ------------
162 None 173 None
163 174
164 175
165 -16. Scripts 176 +17. Scripts
166 ----------- 177 -----------
167 Add logL and event statistics to cspull output file. 178 Add logL and event statistics to cspull output file.
168 179
@@ -182,11 +193,11 @@ The following functions have been added to obsutils: @@ -182,11 +193,11 @@ The following functions have been added to obsutils:
182 specified energy bins. 193 specified energy bins.
183 194
184 195
185 -17. caldb 196 +18. caldb
186 --------- 197 ---------
187 None 198 None
188 199
189 200
190 -18. models 201 +19. models
191 ---------- 202 ----------
192 None 203 None