Commit 2332963449e5671fcdd489a974e7015edcea2325

Authored by Jürgen Knödlseder
1 parent 9ce88b01

Create bugfix 1.5.1 branch

ChangeLog
  1 +2018-02-08
  2 +
  3 + * Bug fix version 1.5.1 released
  4 + ================================
  5 +
  6 +
1 7 2018-01-23
2 8  
3 9 * Version 1.5.0 released
... ...
1   -New Features and Important Changes in GammaLib 1.5.0
  1 +New Features and Important Changes in GammaLib 1.5.1
2 2  
3   -23 January 2018
  3 +8 February 2018
4 4  
5 5  
6 6 1. Introduction
... ... @@ -12,113 +12,38 @@ made since the last release of GammaLib.
12 12 2. Public interface modifications
13 13 ---------------------------------
14 14 The following classes have been added:
15   -- GSkyRegionMap
16   -- GCOMD1Response
17   -- GCOMD2Response
18   -- GCOMInstChars
19   -- GCOMIaq
20   -- GCOMRoi
21   -- GCOMEventAtom
22   -- GCOMEventList
23   -- GCOMTim
24   -- GCOMOad
25   -- GCOMOads
26   -- GCOMDri
27   -- GCOMStatus
  15 +- none
28 16  
29 17 The following classes have been removed:
30   -- n.a.
  18 +- none
31 19  
32 20 The following classes have been renamed:
33   -- n.a.
  21 +- none
34 22  
35 23 The following methods have been added:
36   -- GTime(std::string&)
37   -- GTime(std::string&, GTimeReference&)
38   -- GTime::set(std::string&)
39   -- GTime::set(std::string&, GTimeReference&)
40   -- GApplicationPar::time(GTimeReference&)
41   -- GApplicationPar::time(GTime&)
42   -- GModelSpectralNodes(GModelSpectral&, GEnergies&)
43   -- GFitsTableCol::scale(double&, double&)
44   -- GEbounds::operator==(GEbounds&, GEbounds&)
45   -- GEbounds::operator!=(GEbounds&, GEbounds&)
46   -- GSkyMap::smooth(std::string&, double&)
47   -- GSkyMap::array(int&) - only for Python interface
48   -- GSkyMap::counts()
49   -- GSkyMap::flux()
50   -- clip(GSkyMap&, double&)
51   -- GNdarray::shape(std::vector<int>&)
52   -- GPha::operator+=(GPha&)
53   -- GPha::operator-=(GPha&)
54   -- GPha::operator*=(double&)
55   -- GPha::operator/=(double&)
56   -- GPha::areascal(int&, double&)
57   -- GPha::areascal(int&)
58   -- GPha::backscal(int&, double&)
59   -- GPha::backscal(int&)
60   -- GPha::counts_spectrum()
61   -- GPha::backscal_spectrum()
62   -- operator+(GPha&, GPha&)
63   -- operator-(GPha&, GPha&)
64   -- operator*(GPha&, double&)
65   -- operator*(double&, double&)
66   -- operator/(GPha&, double&)
67   -- GArf::operator+=(GArf&)
68   -- GArf::operator-=(GArf&)
69   -- GArf::operator*=(double&)
70   -- GArf::operator/=(double&)
71   -- GArf::operator(std::string&, GEnergy&)
72   -- operator+(GArf&, GArf&)
73   -- operator-(GArf&, GArf&)
74   -- operator*(GArf&, double&)
75   -- operator*(double&, double&)
76   -- operator/(GArf&, double&)
77   -- GRmf::operator+=(GRmf&)
78   -- GRmf::operator-=(GRmf&)
79   -- GRmf::operator*=(double&)
80   -- GRmf::operator/=(double&)
81   -- operator+(GRmf&, GRmf&)
82   -- operator-(GRmf&, GRmf&)
83   -- operator*(GRmf&, double&)
84   -- operator*(double&, double&)
85   -- operator/(GRmf&, double&)
86   -- GCTAObservation::off_regions(GSkyRegions&)
87   -- GCTAObservation::off_regions()
88   -- GCTAOnOffObservation(GObservations&)
89   -- GCTAOnOffObservation(GPha&, GPha&, GArf&, GRmf&)
90   -- GCOMInstDir(GSkyDir&, double&)
  24 +- none
91 25  
92 26 The following methods have been removed:
93   -- GCTAObservation::obs_id()
  27 +- none
94 28  
95 29 The following methods have been renamed:
96   -- GObservation::statistic() was GObservation::statistics()
97   -- GObservation::statistic(std::string&) was GObservation::statistics(std::string&)
  30 +- none
98 31  
99 32 The arguments for the following methods have been changed:
100   -- GCOMResponse(GCaldb&, std::string&)
101   -- GCOMObservation::response(GCaldb&, std::string&)
  33 +- none
102 34  
103 35 The return value of the following methods has been changed:
104   -- n.a.
  36 +- none
105 37  
106 38  
107 39 3. Configuration
108 40 -----------------
109   -A code generator script codegen.py has been added to the dev folder to ease
110   -the addition of code extensions to GammaLib.
111   -
112   -The configure script now aborts if cfitsio is not found. If GammaLib should be
113   -compiled without cfitsio the --without-cfitsio option has to be specified
114   -explicitly (#2265).
  41 +None
115 42  
116 43  
117 44 4. Application module
118 45 ---------------------
119   -A time parameter with type "t" has was to allow specifying time values in
120   -various formats to time systems to an application. Methods were added to set
121   -and retrieve the time value (#1864).
  46 +None
122 47  
123 48  
124 49 5. Base module
... ... @@ -128,9 +53,7 @@ None
128 53  
129 54 6. FITS I/O Interface
130 55 ---------------------
131   -The GFitsTableCol::scale() method has been added to allow setting the
132   -TSCALE and TZERO values before reading the column data. The keywords
133   -that may exist in the FITS file are not affected by the setting (#2191).
  56 +None
134 57  
135 58  
136 59 7. Linear algebra module
... ... @@ -140,38 +63,17 @@ None
140 63  
141 64 8. Model module
142 65 ---------------
143   -A spectral model constructor was added to GModelSpectralNodes to allow
144   -conversion of any spectral model into a spectral node model (#2178).
145   -
146   -XML support functions are now used in all model classes to simplify the
147   -code (#1430).
  66 +None
148 67  
149 68  
150 69 9. Numerics module
151 70 ------------------
152   -Added GNdarray sign() friend operator and operator*= and operator/=
153   -(#2290).
  71 +None
154 72  
155 73  
156 74 10. Observation module
157 75 ----------------------
158   -The statistic were renamed. POISSON is now called CSTAT and GAUSSIAN is called
159   -CHI2. The code still accepts POISSON and GAUSSIAN, but it is recommended to use
160   -CSTAT and CHI2 instead (#2237).
161   -
162   -The GResponse::eval_prob() method was speed up by avoiding computation for the
163   -case that the spatial response is non-positive. In that case the spectral
164   -response is no longer evaluated.
165   -
166   -A time string constructor and set method was added to GTime to allow
167   -setting various time formats from a string. Variants exist to set the time in
168   -the native time reference or in a specific time reference (#1864).
169   -
170   -The efficiency of the GGti::contains() method has been improved for subsequent
171   -checking of sorted times. Now a new time search always starts at the last
172   -successful index so that the number of search loops is minimized.
173   -
174   -Add equality and inequality operators for the GEbounds class.
  76 +None
175 77  
176 78  
177 79 11. Optimization module
... ... @@ -181,25 +83,12 @@ None
181 83  
182 84 12. Sky module
183 85 --------------
184   -Added GSkyMap::counts() and GSkyMap::flux() methods and clip() frield
185   -operators that allows clipping of sky map values (#2290)
186   -
187   -Added the GSkyMap::array() method to the Python interface to returns the sky
188   -map pixels as a list of lists (#2285)
189   -
190   -Added a GSkyMap division operator that also works under Python 3.x (#2122)
191   -
192   -The GNdarray class is now used to store GSkyMap pixels. A GSkyMap::smooth()
193   -method was added to allow smoothing of sky maps with uniform disk or Gaussian
194   -shaped kernels (#1729).
195   -
196   -The GSkyRegionMap class was added to handle arbitrary sky regions defined using
197   -a FITS file map. All positive pixels will define the region (#1121).
  86 +None
198 87  
199 88  
200 89 13. Support module
201 90 ------------------
202   -The GCsv class now accepts lines staring with # as comment lines (#2291).
  91 +None
203 92  
204 93  
205 94 14. XML module
... ... @@ -214,20 +103,7 @@ None
214 103  
215 104 16. Xspec module
216 105 ----------------
217   -Added GPha::counts_spectrum() and GPha::backscal_spectrum() methods to access
218   -the GPha content (#2290).
219   -
220   -Added arithmetic operators for GPha class to add, subtract, scale and divide
221   -spectra, and methods to set and retrieve the area and background scaling
222   -factors.
223   -
224   -Added arithmetic operators for GArf class to add, subtract, scale and divide
225   -Auxiliary Response Files. Add also an operator that returns the content of
226   -an additional column as function of energy. The operator performs a log-log
227   -interpolation of the column values.
228   -
229   -Added arithmetic operators for GRmf class to add, subtract, scale and divide
230   -Redistribution Matrix Files.
  106 +None
231 107  
232 108  
233 109 17. Test module
... ... @@ -242,89 +118,14 @@ None
242 118  
243 119 19. Fermi-LAT interface
244 120 ----------------------
245   -The mean PSF is now updated in GLATResponse::irf(GLATEventBin&, GSource&,
246   -GObservation&) is the source position has changed by more than 0.01 degrees.
247   -This is smaller than reasonable values for the TS map computation, hence now
248   -for each test position the mean PSF gets updated. But it is larger than the
249   -typical step size in the numerical gradient computation in ctlike, so that
250   -also position fitting is now possible for Fermi-LAT (#604, #2183).
  121 +None
251 122  
252 123  
253 124 20. CTA interface
254 125 -----------------
255   -Change DATE_OBS, DATE_END, TIME_OBS and TIME_END FITS keywords into DATA-OBS,
256   -DATE-END, TIME-OBS and TIME-END.
257   -
258   -If a non-point source model is fitted in an On/Off fitting an exception is thrown,
259   -since On/Off fitting so far only is correct for point source models (#2296).
260   -
261   -Set the Good Time Interval time reference to the CTA time reference in
262   -GCTAEventList, GCTAEventCube and GCTACubeExposure (#2295).
263   -
264   -Add Off sky regions attribute to the GCTAObservation class. The Off sky regions
265   -can be set and accessed using the GCTAObservation::off_regions() method. The
266   -Off regions filename is also read from and written into the observation
267   -definition XML file (#2284).
268   -
269   -GCTAObservation and GCTAOnOffObservation handle statistic attribute in XML
270   -file (#2238).
271   -
272   -Added GCTAOnOffObservation(GPha&, GPha&, GArf&, GRmf&) constructor to allow
273   -creation of an On/Off observation from On and Off spectra, an Auxiliary Response
274   -File and a Redistribution Matrix File (#2231).
275   -
276   -Added GCTAOnOffObservation(GObservations&) constructor that creates a stacked
277   -CTA On/Off observation from all On/Off observations that are found in the
278   -observation container (#2228).
279   -
280   -A GCTAOnOffObservation(GObservations&) constructer has been added to the
281   -GCTAOnOffObservation class that creates a stacked CTA On/Off observations from
282   -all On/Off observations that are found in the observation container (#2228).
283   -
284   -The GCTAOnOffObservation class now performs a proper response integration over
285   -the On and Off regions and takes into account the energy dispersion using the
286   -Redistribution Matrix File (#2210).
287   -
288   -The WSTAT statistics was added to GCTAOnOffObservation for maximum likelihood
289   -fitting (#2209).
290   -
291   -The GCTAObservation::obs_id() methods have been removed since the generic
292   -observation identified string, accessed via the GObservation::id() methods,
293   -will now be used (#1836).
  126 +None
294 127  
295 128  
296 129 21. COMPTEL interface
297 130 ---------------------
298   -The GCOMResponse::irf() method no longer returns negative IRF values. This
299   -happened before due to the interpolation scheme that assumes that IRF values
300   -are taken at the pixel centre (#2234).
301   -
302   -COMPTEL SDA, SDB and ICT response files were added so that the information to
303   -compute the instrument response for any arbitrary energy band is available
304   -(#2186).
305   -
306   -The classes GCOMD1Response and GCOMD2Response were added to handle the energy
307   -response of the D1 and D2 modules, respectively. These classes handle reading
308   -of the SDA and SDB response files (#2186).
309   -
310   -The class GCOMInstChar was added to handle the instrument characteristics that
311   -are necessary to perform the response computation. The class handles reading
312   -of the ICT file (#2186).
313   -
314   -The class GCOMIaq was added to perform the computation of an IAQ response. This
315   -allows now to generate an own IAQ within GammaLib. Below 10 MeV the resulting
316   -IAQs are very close to simulated ones from UNH, above there are some deviations.
317   -Definitely more cross-checking is needed, but for now the functionality is
318   -there (#2186).
319   -
320   -The classes GCOMRoi, GCOMEventAtom and GCOMEventList were added to support
321   -handling of COMPTEL event lists in EVP FITS format. In addition, the class
322   -GCOMTim was added to support reading of TIM FITS files. Furthermore the classes
323   -GCOMOad and GCOMOads were added to handle the COMPTEL Orbit Aspect Data. And
324   -finally the class GCOMDri now handles all COMPTEL data cubes (#2187).
325   -
326   -The class GCOMStatus was added to handle a mission wide database of D1 and D2
327   -module status that forms now part of the COMPTEL calibration database (#2187).
328   -
329   -The COMPTEL Phibar fitting background model now writes out a format that can be
330   -used again (#2184).
  131 +None
... ...
doc/source/admin/release_history/1.5.1.rst 0 → 100644
  1 +.. _1.5.1:
  2 +
  3 +GammaLib 1.5.1 release
  4 +======================
  5 +
  6 +Overview
  7 +--------
  8 +
  9 +GammaLib 1.5.1 is a bug fix release for GammaLib release 1.5.
  10 +
  11 +The following bugs were fixed:
  12 +
  13 +* ...
  14 +
  15 +The following improvements were made:
  16 +
  17 +* ...
... ...
doc/source/admin/release_history/index.rst
... ... @@ -6,6 +6,7 @@ Release History
6 6 .. toctree::
7 7 :maxdepth: 1
8 8  
  9 + GammaLib 1.5.1 <1.5.1>
9 10 GammaLib 1.5 <1.5>
10 11 GammaLib 1.4.3 <1.4.3>
11 12 GammaLib 1.4.2 <1.4.2>
... ...