Alexander Ziegler / ctools

Commit 607bf92ecf42c7112d352253505ffc212b4ccc5b

Authored by Jürgen Knödlseder
1 parent 24b91e5b

Set "addbounds" parameters default to "no" (#1819)

Inline Side-by-side
Showing 11 changed files with 76 additions and 186 deletions
ChangeLog
  View file @607bf92
1   -2016-07-24 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  1 +2016-07-28
  2 +
  3 + * Version 1.2.0 released
  4 + ========================
  5 +
  6 + Set "addbounds" parameters by default to "no" (#1819)
  7 +
  8 +
  9 +2016-07-24
2 10  
3 11 * Version 1.1.0 released
4 12 ========================
... ... @@ -30,7 +38,7 @@
30 38 Support out of source builds (#1484)
31 39  
32 40  
33   -2016-01-27 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  41 +2016-01-27
34 42  
35 43 * Bug fix version 1.0.1 released
36 44 ================================
... ... @@ -40,7 +48,7 @@
40 48 Change diffuse map for science verification
41 49  
42 50  
43   -2015-12-18 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  51 +2015-12-18
44 52  
45 53 * Version 1.0.0 released
46 54 ========================
... ... @@ -56,7 +64,7 @@
56 64 Resolve Python test problem on El Capitan (#1563)
57 65  
58 66  
59   -2015-10-31 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  67 +2015-10-31
60 68  
61 69 * Version 0.10.0 released
62 70 =========================
... ... @@ -75,7 +83,7 @@
75 83 Move cscripts into the ctools Python module (#1470)
76 84  
77 85  
78   -2015-05-22 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  86 +2015-05-22
79 87  
80 88 * Version 0.9.0 released
81 89 ========================
... ... @@ -94,7 +102,7 @@
94 102 Correct sensitivity computation in cssens
95 103  
96 104  
97   -2015-01-08 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  105 +2015-01-08
98 106  
99 107 * Bug fix version 0.8.1 released
100 108 ================================
... ... @@ -102,7 +110,7 @@
102 110 Include Python wrappers in source code distribution
103 111  
104 112  
105   -2014-11-08 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  113 +2014-11-08
106 114  
107 115 * Version 0.8.0 released
108 116 ========================
... ... @@ -129,7 +137,7 @@
129 137 Enhance documentation
130 138  
131 139  
132   -2014-02-20 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  140 +2014-02-20
133 141  
134 142 * Bug fix Version 0.7.2 released
135 143 ================================
... ... @@ -138,7 +146,7 @@
138 146 Properly close temporary file in ctselect (#1149)
139 147  
140 148  
141   -2014-02-05 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  149 +2014-02-05
142 150  
143 151 * Bug fix Version 0.7.1 released
144 152 ================================
... ... @@ -149,7 +157,7 @@
149 157 Use reworked GCaldb for calibration data access (#1116)
150 158  
151 159  
152   -2014-01-18 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  160 +2014-01-18
153 161  
154 162 * Version 0.7.0 released
155 163 ========================
... ... @@ -164,7 +172,7 @@
164 172 Update parameter files if necessary
165 173  
166 174  
167   -2012-12-21 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  175 +2012-12-21
168 176  
169 177 * Version 0.6.0 released
170 178 ========================
... ... @@ -174,14 +182,16 @@
174 182 Adapt to GammaLib-00-07-00 interface
175 183 Correct ctobssim usage of seed value
176 184  
177   -2012-10-11 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  185 +
  186 +2012-10-11
178 187  
179 188 * Bug fix version 0.5.2 released
180 189 ================================
181 190  
182 191 Correct gcc 4.2.x OpenMP dlopen() test
183 192  
184   -2012-09-18 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  193 +
  194 +2012-09-18
185 195  
186 196 * Bug fix version 0.5.1 released
187 197 ================================
... ... @@ -193,7 +203,8 @@
193 203 Improve Python bindings configuration
194 204 Add TEST_ENV_DIR to load library path
195 205  
196   -2012-09-14 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  206 +
  207 +2012-09-14
197 208  
198 209 * Version 0.5.0 released
199 210 ========================
... ... @@ -202,7 +213,8 @@
202 213 Improve logging information for ctlike
203 214 Add OpenPM support
204 215  
205   -2012-03-08 Juergen Knoedlseder <jurgen.knodlseder@irap.omp.eu>
  216 +
  217 +2012-03-08
206 218  
207 219 * Version 0.4.0 released
208 220 ========================
... ... @@ -219,7 +231,7 @@
219 231 Improve building of Python bindings
220 232  
221 233  
222   -2011-10-06 Juergen Knoedlseder <knodlseder@cesr.fr>
  234 +2011-10-06
223 235  
224 236 * Version 0.3.0 released
225 237 ========================
... ... @@ -227,7 +239,7 @@
227 239 Renamed to ctools
228 240  
229 241  
230   -2011-10-03 Juergen Knoedlseder <knodlseder@cesr.fr>
  242 +2011-10-03
231 243  
232 244 * Version 0.2.5 released
233 245 ========================
... ... @@ -237,7 +249,8 @@
237 249 Add examples directory
238 250 Add scripts directory
239 251  
240   -2011-07-20 Juergen Knoedlseder <knodlseder@cesr.fr>
  252 +
  253 +2011-07-20
241 254  
242 255 * Version 0.2.4 released
243 256 ========================
... ... @@ -245,14 +258,16 @@
245 258 Improve configure script
246 259 Add scripts for ctatools environment setting
247 260  
248   -2011-07-09 Juergen Knoedlseder <knodlseder@cesr.fr>
  261 +
  262 +2011-07-09
249 263  
250 264 * Version 0.2.3 released
251 265 ========================
252 266  
253 267 Improve configure script
254 268  
255   -2011-02-24 Juergen Knoedlseder <knodlseder@cesr.fr>
  269 +
  270 +2011-02-24
256 271  
257 272 * Version 0.2.1 released
258 273 ========================
... ... @@ -260,7 +275,8 @@
260 275 Correct test environment
261 276 Adjust Python wrapper compile option on Darwin
262 277  
263   -2011-02-21 Juergen Knoedlseder <knodlseder@cesr.fr>
  278 +
  279 +2011-02-21
264 280  
265 281 * Version 0.2.0 released
266 282 ========================
... ... @@ -269,7 +285,8 @@
269 285 Add unit test (make check)
270 286 Add html documentation
271 287  
272   -2011-02-02 Juergen Knoedlseder <knodlseder@cesr.fr>
  288 +
  289 +2011-02-02
273 290  
274 291 * Version 0.1.0 released
275 292 ========================
... ...
1   -New Features and Important Changes in ctools 1.1.0
  1 +New Features and Important Changes in ctools 1.2.0
2 2  
3   -24 July 2016
  3 +28 July 2016
4 4  
5 5  
6 6 Introduction
... ... @@ -11,229 +11,102 @@ ctools release with respect to the precedent release.
11 11  
12 12 Configuration
13 13 -------------
14   -The package now supports out of source builds (#1484).
  14 +None
15 15  
16 16  
17 17 Python interface
18 18 ----------------
19   -The IACT scripts csfindobs, csiactcopy, csiactdata, and csiactobs are only
20   -imported into the cscripts module and tested if the Python version is 2.6 or
21   -newer. These scripts make use of the json Python module that is only became
22   -available from Python 2.6 on.
  19 +None
23 20  
24 21  
25 22 Support model
26 23 -------------
27   -The "edispcube" parameter is expected in any tool that supports stacked
28   -analysis. If the parameter is not "NONE" or empty, the ctool::set_obs_response()
29   -method will load the energy dispersion cube and use it in the response
30   -definition of the first observations (#1724).
31   -
32   -A new method setup_observations() has been added that sets up an observation
33   -container by appending all required information that is missing using the
34   -user parameters.
  24 +None
35 25  
36 26  
37 27 ctobssim - CTA observation simulation
38 28 -------------------------------------
39   -The simulation energy range is subdivided internally to avoid having a too
40   -large difference between simulation area and effective area. Before, there
41   -was a simulation area of 19634954 m^2 that was applied to all energies, which
42   -led to the simulation of a huge number of low energy photons that were thrown
43   -away later due to the small effective area. Now, the energy range is subdivided
44   -(controlled using the "eslices" parameter), and for each energy range, the
45   -simulation area is computed from the maximum effective area in that energy
46   -range multiplied by a security factor of 2. This leads to a much more efficient
47   -simulation of low-energy events (#1673).
48   -
49   -Any existing events in an event list are now removed before starting the
50   -simulation to enable providing an existing event file on input from which
51   -only the observation attributes are extracted (for example GTI, ROI, energy
52   -range, etc.) while the measured events are replaced by the simulated ones
53   -(#1663).
  29 +None
54 30  
55 31  
56 32 ctselect - CTA event selection
57 33 ------------------------------
58   -The tool now allows the usage of non-default extension names for the event
59   -and Good Time Intervals. If the events are not located in the "EVENTS"
60   -extension, the extension name can be provided by appending the extension
61   -name to the input file name using the syntax
62   -
63   - <filename>[<event extension name>]
64   -
65   -where <filename> needs to be replaced by the name of the FITS file and
66   -<event extension name> by the name of the FITS extension. ctselect also
67   -extracts the name of the Good Time Intervals extension from the data sub-
68   -space keywords provided in the header of the event file.
69   -
70   -The user has now also the possibility to specify other extension names for
71   -the events and the Good Time intervals upon writing of the selected output
72   -file. The format of the "outobs" parameter for this is
73   -
74   - <filename>[<event extension name;GTI extension name>]
75   -
76   -If only an event extension name is provided using
77   -
78   - <filename>[<event extension name>]
79   -
80   -the original extension name will be kept for the GTIs. Changing only the
81   -GTI extension name can be achieved using
82   -
83   - <filename>[;GTI extension name>]
84   -
85   -The ctselect tool now can also write the output into the same file that
86   -was input, replacing the initial event (and eventually also Good Time
87   -Intervals) extensions.
  34 +None
88 35  
89 36  
90 37 ctbin - CTA event binning
91 38 -------------------------
92   -Add publish() method to publish the counts cube via a SAMP Hub to Virtual
93   -Observatory interoperable tools (e.g. Aladin).
94   -
95   -The tool now computes the counts cube weights according to the overlaps
96   -between the Region of Interests and energy boundaries with the counts
97   -cube bins (#1789). Initially an implementation was done taking into account
98   -the partial overlaps between counts cube bins and the data space selection,
99   -but this led to a bias that was inherent to the method (#1819). It was
100   -therefore decided to move back to the original scheme.
  39 +None
101 40  
102 41  
103 42 ctlike - Maximum likelihood fitting
104 43 -----------------------------------
105   -Add "edispcube" parameter to support energy dispersion for stacked analysis
106   -(#1724).
  44 +None
107 45  
108 46  
109 47 cttsmap - Generation of Test Statistic map
110 48 ------------------------------------------
111   -Add publish() method to publish the Test Statistic map via a SAMP Hub to
112   -Virtual Observatory interoperable tools (e.g. Aladin).
113   -
114   -Add "edispcube" parameter to support energy dispersion for stacked analysis
115   -(#1724).
  49 +None
116 50  
117 51  
118 52 ctskymap - CTA sky mapping
119 53 --------------------------
120   -Add publish() method to publish the sky map via a SAMP Hub to Virtual
121   -Observatory interoperable tools (e.g. Aladin).
  54 +None
122 55  
123 56  
124 57 ctmodel - CTA counts cube modelling
125 58 -----------------------------------
126   -Add publish() method to publish the model cube via a SAMP Hub to Virtual
127   -Observatory interoperable tools (e.g. Aladin).
128   -
129   -Add "edispcube" parameter to support energy dispersion for stacked analysis
130   -(#1724).
  59 +None
131 60  
132 61  
133 62 ctexpcube - CTA exposure cube generation
134 63 ----------------------------------------
135   -Add publish() method to publish the exposure cube via a SAMP Hub to
136   -Virtual Observatory interoperable tools (e.g. Aladin).
137   -
138   -Remove "edisp" parameter as this is parameter is not needed (#1724).
139   -
140   -Added hidden "addbounds" parameter to insert energy layers for each
141   -energy boundary of the input observation (#1819).
  64 +Set hidden "addbounds" parameter by default to "no" (#1819).
142 65  
143 66  
144 67 ctpsfcube - CTA point spread function cube generation
145 68 -----------------------------------------------------
146   -Remove "edisp" parameter as this is parameter is not needed (#1724).
147   -
148   -Added hidden "addbounds" parameter to insert energy layers for each
149   -energy boundary of the input observation (#1819).
  69 +Set hidden "addbounds" parameter by default to "no" (#1819).
150 70  
151 71  
152 72 ctedispcube - CTA energy dispersion cube generation
153 73 ---------------------------------------------------
154   -This tool generates an energy dispersion cube for a stacked analysis. The
155   -energy dispersion cube holds the migration matrix as function of sky
156   -direction, true photon energy and the migration value which is the ratio
157   -of reconstructed over true energy (#1724).
158   -
159   -Added hidden "addbounds" parameter to insert energy layers for each
160   -energy boundary of the input observation (#1819).
  74 +Set hidden "addbounds" parameter by default to "no" (#1819).
161 75  
162 76  
163 77 ctbkgcube - CTA background cube generation
164 78 ------------------------------------------
165   -Add publish() method to publish the background cube via a SAMP Hub to
166   -Virtual Observatory interoperable tools (e.g. Aladin).
167   -
168   -Added hidden "addbounds" parameter to insert energy layers for each
169   -energy boundary of the input observation (#1819).
  79 +Set hidden "addbounds" parameter by default to "no" (#1819).
170 80  
171 81  
172 82 ctmapcube - CTA map cube generation
173 83 -----------------------------------
174   -This tools generates a map cube from a model definition XML file. In that
175   -way an arbitrary source model can be fed as diffuse map cube into an
176   -analysis. This speeds up considerably the analysis in case that many
177   -(extended) sources should be kept fixed (#1760)
  84 +None
178 85  
179 86  
180 87 ctcubemask - CTA cube filtering
181 88 -------------------------------
182   -Add publish() method to publish the masked counts cube via a SAMP Hub
183   -to Virtual Observatory interoperable tools (e.g. Aladin).
  89 +None
184 90  
185 91  
186 92 ctbutterfly - Generate butterfly diagrams
187 93 -----------------------------------------
188   -Add "edispcube" parameter to support energy dispersion for stacked analysis
189   -(#1724).
  94 +None
190 95  
191 96  
192 97 ctulimit - Compute upper limit
193 98 ------------------------------
194   -Add "edispcube" parameter to support energy dispersion for stacked analysis
195   -(#1724).
196   -
197   -In case that the parameter error is zero, the parameter value is taken as
198   -parameter error to define the bracketing parameter values (#1795).
  99 +None
199 100  
200 101  
201 102 cterror - Likelihood profile error computation
202 103 ----------------------------------------------
203   -The output filename is now read ahead in case that the tool is executed
204   -(#1700).
205   -
206   -Add "edispcube" parameter to support energy dispersion for stacked analysis
207   -(#1724).
208   -
209   -
210   -cscripts
211   ---------
212   -Add the csiactcopy script that copies IACT data from a remote machine to
213   -the user's machine (#1661).
214   -
215   -Add csresmap::publish() method to publish the residual map via a SAMP Hub
216   -to Virtual Observatory interoperable tools (e.g. Aladin).
217   -
218   -Add "edispcube" parameter to cslightcrv, csresmap, and csspec scripts to
219   -support energy dispersion for stacked analysis (#1724).
220   -
221   -Add csworkflow script that executes an arbitrary analysis workflow (#1508).
222   -
223   -Transformed cta_root2caldb into csroot2caldb script. The parameters
224   -"bgdoversample" and "bgdinfill" have been added to the parameter file to
225   -provide more control over the background template generation. The background
226   -template is now generated using linear interpolation, and the
227   -"bgdoversample" allows to generate the background template at a finer
228   -sampling than the spatial sampling in the ROOT file.
229   -
230   -Add csobsdef.pntdef() method to set directly a pointing definition from a
231   -gammalib.GCsv object (#1771).
  104 +None
232 105  
233   -Add cstsmapsplit script that generates the command sequence for splitting the
234   -computation of a Test Statistic map into computations of sub maps (#1797).
235 106  
236   -Unit tests have been added for all cscripts.
  107 +scripts
  108 +-------
  109 +None
237 110  
238 111  
239 112 Examples
... ...
README.md
  View file @607bf92
1 1 ctools information
2 2 ==================
3   -* Version: 1.2.0.dev1 (24 July 2016)
  3 +* Version: 1.2.0.dev1 (28 July 2016)
4 4 * Author: Juergen Knoedlseder (jurgen.knodlseder@irap.omp.eu)
5 5 * GammaLib dependency: 1.2.0.dev1
6 6  
... ...
doc/source/users/reference_manual/ctbkgcube.rst
  View file @607bf92
... ... @@ -87,7 +87,7 @@ General parameters
87 87 ``ebinfile [file]``
88 88 Name of the file containing the energy bin definition.
89 89  
90   -``(addbounds = yes) [boolean]``
  90 +``(addbounds = no) [boolean]``
91 91 Add energies to the background cube at the observation energy boundaries?
92 92  
93 93 ``(usepnt = no) [boolean]``
... ...
doc/source/users/reference_manual/ctedispcube.rst
  View file @607bf92
... ... @@ -70,7 +70,7 @@ General parameters
70 70 ``ebinfile [file]``
71 71 Name of the file containing the energy bin definition.
72 72  
73   -``(addbounds = yes) [boolean]``
  73 +``(addbounds = no) [boolean]``
74 74 Add energies to the energy dispersion cube at the observation energy boundaries?
75 75  
76 76 ``(usepnt = no) [boolean]``
... ...
doc/source/users/reference_manual/ctexpcube.rst
  View file @607bf92
... ... @@ -77,7 +77,7 @@ General parameters
77 77 ``ebinfile [file]``
78 78 Name of the file containing the energy bin definition.
79 79  
80   -``(addbounds = yes) [boolean]``
  80 +``(addbounds = no) [boolean]``
81 81 Add energies to the exposure cube at the observation energy boundaries?
82 82  
83 83 ``(usepnt = no) [boolean]``
... ...
doc/source/users/reference_manual/ctpsfcube.rst
  View file @607bf92
... ... @@ -69,7 +69,7 @@ General parameters
69 69 ``ebinfile [file]``
70 70 Name of the file containing the energy bin definition.
71 71  
72   -``(addbounds = yes) [boolean]``
  72 +``(addbounds = no) [boolean]``
73 73 Add energies to the point spread function cube at the observation energy boundaries?
74 74  
75 75 ``(usepnt = no) [boolean]``
... ...
src/ctbkgcube/ctbkgcube.par
  View file @607bf92
... ... @@ -5,7 +5,7 @@
5 5 # ------------------------------------------------------------------------- #
6 6 # #
7 7 # File: ctbkgcube.par #
8   -# Version: 1.1.0 #
  8 +# Version: 1.2.0 #
9 9 # #
10 10 # Author: Chia-Chun Lu #
11 11 # c.lu@mpi-hd.mpg.de #
... ... @@ -33,7 +33,7 @@ emin, r, a, 0.1,,, &quot;Lower energy limit (TeV)&quot;
33 33 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
34 34 enumbins, i, a, 20,,, "Number of energy bins"
35 35 ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
36   -addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
  36 +addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
37 37  
38 38 #
39 39 # Spatial binning parameters
... ...
src/ctedispcube/ctedispcube.par
  View file @607bf92
... ... @@ -5,7 +5,7 @@
5 5 # ------------------------------------------------------------------------- #
6 6 # #
7 7 # File: ctedispcube.par #
8   -# Version: 1.1.0 #
  8 +# Version: 1.2.0 #
9 9 # #
10 10 # Author: Maria Haupt #
11 11 # maria.haupt@desy.de #
... ... @@ -31,7 +31,7 @@ emin, r, a, 0.1,,, &quot;Lower energy limit (TeV)&quot;
31 31 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
32 32 enumbins, i, a, 20,,, "Number of energy bins"
33 33 ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
34   -addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
  34 +addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
35 35  
36 36 #
37 37 # Spatial binning parameters
... ...
src/ctexpcube/ctexpcube.par
  View file @607bf92
... ... @@ -5,7 +5,7 @@
5 5 # ------------------------------------------------------------------------- #
6 6 # #
7 7 # File: ctexpcube.par #
8   -# Version: 1.1.0 #
  8 +# Version: 1.2.0 #
9 9 # #
10 10 # Author: Juergen Knoedlseder #
11 11 # Jurgen.Knodlseder@irap.omp.eu #
... ... @@ -31,7 +31,7 @@ emin, r, a, 0.1,,,&quot;Lower energy limit (TeV)&quot;
31 31 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
32 32 enumbins, i, a, 20,,, "Number of energy bins"
33 33 ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
34   -addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
  34 +addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
35 35  
36 36 #
37 37 # Spatial binning parameters
... ...
src/ctpsfcube/ctpsfcube.par
  View file @607bf92
... ... @@ -5,7 +5,7 @@
5 5 # ------------------------------------------------------------------------- #
6 6 # #
7 7 # File: ctpsfcube.par #
8   -# Version: 1.1.0 #
  8 +# Version: 1.2.0 #
9 9 # #
10 10 # Author: Chia-Chun Lu #
11 11 # c.lu@mpi-hd.mpg.de #
... ... @@ -31,7 +31,7 @@ emin, r, a, 0.1,,, &quot;Lower energy limit (TeV)&quot;
31 31 emax, r, a, 100.0,,, "Upper energy limit (TeV)"
32 32 enumbins, i, a, 20,,, "Number of energy bins"
33 33 ebinfile, f, h, "NONE",,, "Name of the file containing the energy bin definition"
34   -addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
  34 +addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
35 35  
36 36 #
37 37 # Spatial binning parameters
... ...