1 | Duchamp version 1.1 (2007/05/14) |
---|
2 | ------------------------------------ |
---|
3 | |
---|
4 | Changes made since the last numbered release: |
---|
5 | |
---|
6 | EFFICIENCY OF EXECUTION: |
---|
7 | |
---|
8 | * Major change to the way detections are stored. They are now recorded |
---|
9 | via run-length encoding in the x-y plane, and stored as collections |
---|
10 | of channel-maps. This improves the memory usage and the speed of |
---|
11 | execution (particularly for routines such as the merging |
---|
12 | routines). The memory usage has also been improved by changing the |
---|
13 | way the list of detected objects is stored. |
---|
14 | |
---|
15 | SMOOTHING: |
---|
16 | |
---|
17 | * Addition of ability to spatially smooth the cube before |
---|
18 | searching. This is done with a Gaussian kernel, the size and shape |
---|
19 | of which can be specified by the user, using the parameters kernMaj |
---|
20 | & kernMin (which are the FWHM for the major & minor axes -- if |
---|
21 | kernMin is not given it is assumed to match kernMaj) and kernPA (the |
---|
22 | position angle of the major axis). There is a new parameter |
---|
23 | smoothType that distinguishes this method from the spectral (Hanning) |
---|
24 | smoothing already in use. |
---|
25 | |
---|
26 | DETECTIONS: |
---|
27 | |
---|
28 | * Changed the way detection is done -- now only search in 2D images, |
---|
29 | keeping all detections (ie. no minimum-pixel requirement). This |
---|
30 | should be the same as doing both the 1D and 2D searches with the |
---|
31 | minimum pixel requirement in, but simpler. The rejection is done at |
---|
32 | the end after all the merging and growing has been done. This leads |
---|
33 | to a larger number of intermediate detections (ie. the number |
---|
34 | before merging), which may increase the run-time slightly, although |
---|
35 | this is offset by the changes to the efficiency (see above). |
---|
36 | |
---|
37 | * Increased the range over which objects can be grown to match the |
---|
38 | threshSpatial & threshVelocity parameters, as well as rejecting new |
---|
39 | pixels based on the BLANK and MW tests. |
---|
40 | |
---|
41 | INPUTS: |
---|
42 | |
---|
43 | * There has been a subtle change in the way BLANK pixels are dealt |
---|
44 | with. To enable trimming of BLANK pixels, users should use the new |
---|
45 | parameter flagTrim. The parameters flagBlankPix and blankPixVal are |
---|
46 | no longer accessible via the parameter file -- warning messages are |
---|
47 | given if they are provided in the parameter file. |
---|
48 | |
---|
49 | * Added ability to specify a statsec, so that the statistics are only |
---|
50 | calculated from a given subsection of the cube, rather than the full |
---|
51 | cube. |
---|
52 | |
---|
53 | * The subsections can also specify the ability to remove a border of n |
---|
54 | pixels from the edges of an axis (ie. n from the start and from the |
---|
55 | end) -- as requested in Trac ticket #5. |
---|
56 | |
---|
57 | * Changed the default value of the reconDim parameter from 3 to 1, and |
---|
58 | the default value of the flagATrous parameter to false. |
---|
59 | |
---|
60 | OUTPUTS: |
---|
61 | |
---|
62 | * The output now includes three different estimates of the "centre" of |
---|
63 | the detection: peak location, centroid (flux-weighted), or average. |
---|
64 | |
---|
65 | * Some slight improvements to the user feedback during execution. |
---|
66 | |
---|
67 | * Spectral output now includes the baseline, if one was fitted. The |
---|
68 | format of the plot headers is slightly changed, to stop information |
---|
69 | falling off the edge of the page. |
---|
70 | |
---|
71 | * Added command-line option -x to directly disable the PGPLOT X-window |
---|
72 | map plotting. This overrides the setting of flagXOutput in the |
---|
73 | parameter file. |
---|
74 | |
---|
75 | * Fallback spectral units (in case the FITS header fails to record |
---|
76 | them) changed to SPC, but code has been fixed so that any problem |
---|
77 | should be caught before this becomes an issue. |
---|
78 | |
---|
79 | BUGFIXES: |
---|
80 | |
---|
81 | * Fixed bug (Trac ticket #4) that meant the velocity units were not |
---|
82 | correctly dealt with. Duchamp should be more robust for different |
---|
83 | velocity axis setups now. |
---|
84 | |
---|
85 | * Fixed bug (ticket #9) with the VOTable output, where the tags were |
---|
86 | not closing. |
---|
87 | |
---|
88 | * Fixed a bug that meant the integrated fluxes were not calculated |
---|
89 | properly -- no allowance was made for the number of spatial |
---|
90 | pixels. This should also work properly for 2D images now as well. |
---|
91 | |
---|
92 | * Fixed minor bug in calculating the flux threshold from the p-value |
---|
93 | threshold when the FDR method is used. This did not affect the |
---|
94 | actual thresholding, merely the quoted flux threshold in the results |
---|
95 | file. Also, the MW channels are kept out of the p-value threshold |
---|
96 | determination if they are being flagged. |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | Duchamp version 1.0.7 (2006/11/22) |
---|
101 | ---------------------------------- |
---|
102 | |
---|
103 | One new feature, and some improvements and bug-fixes. |
---|
104 | |
---|
105 | * The user can now elect to Hanning-smooth the spectral direction of |
---|
106 | the cube before the searching is done. This can be done instead of the |
---|
107 | wavelet reconstruction (although if both are selected, the |
---|
108 | reconstruction takes precendence). This functionality is switched on |
---|
109 | and off by the flagSmooth parameter, and the width of the Hanning |
---|
110 | kernel is governed by the hanningWidth parameter. |
---|
111 | |
---|
112 | * The smoothed array can also be written to a FITS file and read in at |
---|
113 | the start in the same manner as the reconstructed array. |
---|
114 | |
---|
115 | * Several improvements have been made to the memory |
---|
116 | management. Several memory leaks were fixed, and the memory usage of |
---|
117 | Duchamp is considerably less, which will be a help for running it on |
---|
118 | large cubes. The speed of some routines has also been improved, by |
---|
119 | removing unnecessarily repetitive loops. |
---|
120 | |
---|
121 | * The sorting routines have been changed, and should now be slightly quicker |
---|
122 | (and a bit more robust). |
---|
123 | |
---|
124 | * Enabled the scale bar (plotted on the 0th moment map in the spectral |
---|
125 | output file) to be able to deal with much finer spatial scales (as |
---|
126 | may be expected from VLBI data). |
---|
127 | |
---|
128 | * Other minor changes to code and presentation. |
---|
129 | |
---|
130 | |
---|
131 | Duchamp version 1.0.6 (2006/11/01) |
---|
132 | ---------------------------------- |
---|
133 | |
---|
134 | Some incremental improvements and changes to the code: |
---|
135 | |
---|
136 | * The statistics used for the detection are now calculated once for |
---|
137 | the entire cube, rather than being calculated separately for each |
---|
138 | channel map and spectrum. This results in a uniform threshold value |
---|
139 | across the entire cube. The way the statistics calculations are |
---|
140 | implemented in the code was changed, using a new statistics class. |
---|
141 | |
---|
142 | * This means we can report a peak signal-to-noise value for each |
---|
143 | detection. This is given in the text-based output, as well as in the |
---|
144 | summary information above the spectral output for each source. |
---|
145 | |
---|
146 | * The user can now elect not to have the moment map displayed in a |
---|
147 | PGPlot window, through the use of the new flagXOutput |
---|
148 | parameter. This should help in cases of running Duchamp on a dumb |
---|
149 | terminal (with no X-display capabilities), or as part of a batch |
---|
150 | script where the continual popping-up of the PGPlot window might |
---|
151 | become annoying. |
---|
152 | |
---|
153 | * There are different Flags reported for the case of an object lying on |
---|
154 | the spatial edge and spectral edge of the cube (E and S respectively). |
---|
155 | |
---|
156 | * A few minor bug fixes: |
---|
157 | - When providing a subsection, any axes with the range given by * |
---|
158 | had the pixel values offset incorrectly. This has been fixed. |
---|
159 | - Negative searches now correctly invert the reconstructed array |
---|
160 | when it is read in from a file. |
---|
161 | |
---|
162 | * Other minor changes to the code, to improve memory handling and |
---|
163 | remove redundant arrays and variables. |
---|
164 | |
---|
165 | |
---|
166 | Duchamp version 1.0.5 (2006/09/06) |
---|
167 | ---------------------------------- |
---|
168 | |
---|
169 | Since version 1.0, there have been a range of mostly minor |
---|
170 | changes. These are generally bug-fixes, thanks to feedback from a |
---|
171 | number of users, as well as a few extra features. |
---|
172 | |
---|
173 | Here is a summary of the changes since version 1.0: |
---|
174 | |
---|
175 | USER INTERFACE: |
---|
176 | |
---|
177 | * The user is now able to enter the value of flag parameters in the |
---|
178 | parameter file as strings, as well as integers (so one can enter |
---|
179 | true or 1 to give the same result). |
---|
180 | |
---|
181 | GRAPHICAL OUTPUT: |
---|
182 | |
---|
183 | * Added a new function that draws the edge of the blank region on the |
---|
184 | maps and image cutouts. There is a new flag parameter -- |
---|
185 | drawBlankEdges -- that controls the use of this function (the |
---|
186 | default is true). |
---|
187 | Also, the edge of the field is plotted on the image cutouts as a |
---|
188 | yellow line. This distinguishes it from the purple blank pixel |
---|
189 | dividing line. |
---|
190 | |
---|
191 | * The size of the tick mark in the image cutout (indicating the |
---|
192 | spatial scale of the image) is now adaptable, so that it shows the |
---|
193 | scale that best fits the image (ranging from 1 arcsec to 15 |
---|
194 | degrees). (This is a change from the previous standard length of 15 |
---|
195 | arcmin.) |
---|
196 | |
---|
197 | * The zoomed spectrum had its flux scale determined by all points in |
---|
198 | the zoom box,including those flagged by the Milky Way (MW) |
---|
199 | range. This has been fixed so that any MW channels will not affect |
---|
200 | the flux scaling, potentially improving the appearance of objects |
---|
201 | detected close in velocity to strong MW emission or absorption. |
---|
202 | |
---|
203 | * Improved Karma Annotation file output, so that files without good |
---|
204 | WCS are dealt with appropriately. |
---|
205 | |
---|
206 | TEXT-BASED OUTPUT: |
---|
207 | |
---|
208 | * The position resolution in the IAU-format names has been increased, |
---|
209 | so that distinct objects close to one another are more readily |
---|
210 | distinguished. Overlapping sources at different velocities may |
---|
211 | still have the same name, but this is a more general problem. |
---|
212 | |
---|
213 | * The presentation of the results in tabular format has been improved, |
---|
214 | so that the precision of faint sources is sufficient to show their |
---|
215 | flux, for instance, is not 0. This also applies to the information |
---|
216 | presented above the spectral plots. |
---|
217 | |
---|
218 | * Improved error and warning reporting, so that the formatting and |
---|
219 | presentation of information is clearer. |
---|
220 | |
---|
221 | FITS I/O RELATED: |
---|
222 | |
---|
223 | * The previous version was did not deal well with 4 (or greater) |
---|
224 | dimensions in the FITS file -- the memory allocation was badly done, |
---|
225 | and the axes needed to be in a particular order. This has been |
---|
226 | fixed, so that the FITS I/O routines can now handle any sized FITS |
---|
227 | file, with axes in any order (as long as there are two spatial and one |
---|
228 | spectral axes). |
---|
229 | |
---|
230 | * When the FITS file does not have a rest frequency defined, there is |
---|
231 | no way to transform the frequency axis into velocity. In this case, |
---|
232 | the spectral axis is left as frequency, and put into units of MHz. |
---|
233 | |
---|
234 | * If the beam size is not indicated by the FITS header (through the |
---|
235 | BMAJ and BMIN keywords), the user can manually specify the size |
---|
236 | through the parameter file (using parameter beamSize). |
---|
237 | |
---|
238 | * The FITS I/O routines make use of the command fits_file_exists. This |
---|
239 | was introduced into the CFITSIO package from version 2.5, so Duchamp |
---|
240 | will only work with this version or higher. Version 3+ is preferred. |
---|
241 | |
---|
242 | OTHER BUG-FIXING: |
---|
243 | |
---|
244 | * Several bugs related to the blank-pixels were dealt with. |
---|
245 | The correct values were not propagating through correctly, meaning |
---|
246 | that the default values were being used. Also, there was the |
---|
247 | potential for blank pixels to be detected when the FDR method was |
---|
248 | used. Finally, the image cutout displays occasionally did not |
---|
249 | obscure the blank pixels. All these problems should be fixed now. |
---|
250 | |
---|
251 | * The FDR setup routine was occasionally failing with a segmentation |
---|
252 | fault, due to it accessing unallocated memory. This has been fixed. |
---|
253 | |
---|
254 | * Fixed bugs that affected the way 2D images (rather than 3D cubes) |
---|
255 | were dealt with. The minChannels test failed when minChannels=0. |
---|
256 | |
---|
257 | * If there is no beam information in the FITS header, the user can now |
---|
258 | enter a beam size as a parameter. |
---|
259 | |
---|
260 | * Other minor fixes to the code, to improve its structure and |
---|
261 | robustness. |
---|
262 | |
---|
263 | |
---|
264 | Duchamp version 1.0 (2006/06/30) |
---|
265 | -------------------------------- |
---|
266 | |
---|
267 | The first full release version. |
---|
268 | |
---|
269 | Several major changes compared to previous version: |
---|
270 | |
---|
271 | * Incorporated a FitsHeader class, to keep track of header information |
---|
272 | (including WCS) from the FITS file. All units-related calculations |
---|
273 | are done with this class, such as conversion to velocity, and |
---|
274 | pixel-to-WCS conversion. The main advantage of this is improved |
---|
275 | speed of execution, more adaptable to different units, and improved |
---|
276 | code (easier for me!). |
---|
277 | |
---|
278 | * Able to select the dimensionality of the reconstruction, rather than |
---|
279 | just doing it in 3-D. |
---|
280 | |
---|
281 | * Robust text output, so that the columns are sized correctly given |
---|
282 | the data being written, and the relevant units (derived from the |
---|
283 | FITS header) are included in the output table. |
---|
284 | |
---|
285 | * Improved the way the reconstructed image is saved and read back in, |
---|
286 | with a better naming scheme and a better set of new FITS header |
---|
287 | keywords. The MW headers are now not written. |
---|
288 | |
---|
289 | Other, more minor changes include: |
---|
290 | |
---|
291 | * MW channels now not set to 0, but just ignored for searching |
---|
292 | purposes (and for the scaling of the spectral output -- they are |
---|
293 | plotted though and highlighted with a hashed box). |
---|
294 | |
---|
295 | * The scale bar in the moment map in the spectral output file has its |
---|
296 | length indicated. |
---|
297 | |
---|
298 | * Improved VOTable output, with more information about the way Duchamp |
---|
299 | was run. |
---|
300 | |
---|
301 | * Made sure all statistics calculations in the reconstruction are |
---|
302 | based on robust (ie. median) methods. |
---|
303 | |
---|
304 | Also moved to an autoconf based configure/make compilation, for ease of use. |
---|
305 | |
---|
306 | |
---|
307 | Duchamp version 0.9.2 (2006/06/27) |
---|
308 | -------------------------------- |
---|
309 | |
---|
310 | * Added the use of warning flags for detections: for either edge |
---|
311 | location or negative enclosed flux. |
---|
312 | |
---|
313 | * A new command line option added so that the user can specify a FITS |
---|
314 | file to be searched with the default parameters, rather than giving |
---|
315 | a full parameter file. |
---|
316 | |
---|
317 | * The scale bar on the moment cutout now works in general case, using |
---|
318 | an iterative process to get to the correct length. |
---|
319 | |
---|
320 | * RA axes are now done correctly on the full-scale maps. |
---|
321 | |
---|
322 | * Various coding fixes, improving the readability of the code, |
---|
323 | particularly regarding the declaration of temporary variables. |
---|
324 | |
---|
325 | * Changed the way the time of execution is called : now using time.h |
---|
326 | functions, rather than a system call. |
---|
327 | |
---|
328 | * Changed output in Detection/outputDetection.cc for the pixel |
---|
329 | information of detected objects (the info printed above the spectral |
---|
330 | plots) -- now print out number of voxels in object, and have |
---|
331 | improved the formatting a little. |
---|
332 | |
---|
333 | * Improved the functionality of saving the FITS file containing the |
---|
334 | reconstructed array. Added ability to save and read back in the MW |
---|
335 | parameters when saving a reconstructed cube (if a reconstructed cube |
---|
336 | has different MW range to that being considered, it would cause |
---|
337 | problems). ReadRecon now just returns a FAILURE and will reconstruct |
---|
338 | the cube anew. |
---|
339 | |
---|
340 | * Changed default value of flagGrowth to 0. |
---|
341 | |
---|
342 | |
---|
343 | |
---|
344 | Duchamp version 0.9 (2006/05/05) |
---|
345 | -------------------------------- |
---|
346 | |
---|
347 | First public release version. |
---|