[1285] | 1 | Duchamp version 1.5 (2013/08/29) |
---|
[1249] | 2 | -------------------------------- |
---|
| 3 | |
---|
[1280] | 4 | New features & algorithms: |
---|
[1249] | 5 | |
---|
| 6 | * There is now a more flexible way to specify channels that should be |
---|
| 7 | ignored by the source-finding. Use flaggedChannels to provide a list |
---|
| 8 | of single channels or channel ranges that should be ignored. This |
---|
| 9 | replaces the flagMW/minMW/maxMW parameters, extending their |
---|
| 10 | functionality and allowing more than one set of channels to be |
---|
| 11 | specified. |
---|
| 12 | |
---|
[1278] | 13 | * There is now an alternative way to find (and remove) spectral |
---|
| 14 | baselines, using a median baselining algorithm. This calculates the |
---|
| 15 | baseline value for a given pixel to be the median value within a box |
---|
| 16 | of a specified size centred on that pixel. There are two input |
---|
| 17 | parameters now available, baselineType (atrous or median), and |
---|
| 18 | baselineBoxWidth (the width of the median box). Consult the User's |
---|
| 19 | Guide for further information. |
---|
| 20 | |
---|
[1280] | 21 | * There is now more flexibility in running the spatial smoothing. The |
---|
| 22 | cutoff value in determining the size of the smoothing kernel can now |
---|
| 23 | be set via the input parameters, as can the way the edge pixels get |
---|
| 24 | treated. Conult the User's Guide for details. |
---|
| 25 | |
---|
[1288] | 26 | * You can now also specify the maximum number of voxels, spatial |
---|
| 27 | pixels and/or channels, in a way analogous to the minimum |
---|
| 28 | values. Detections with more than the maximum are rejected. Negative |
---|
| 29 | values (such as the defaults) mean this comparison is not done. |
---|
| 30 | |
---|
[1274] | 31 | Output changes: |
---|
| 32 | |
---|
| 33 | * The results files now include the Nchan and Nspatpix columns, |
---|
| 34 | showing the number of distinct channels and the number of spatial |
---|
| 35 | pixels in each detection. For clarity, the Npix column has been |
---|
| 36 | renamed Nvoxel. |
---|
| 37 | |
---|
| 38 | * The VOTable now includes the pixel location X, Y, Z columns, and the |
---|
| 39 | pixel ranges - this makes it much closer to the ASCII results file |
---|
| 40 | (it is just missing the string versions of RA/DEC, and F_tot when |
---|
| 41 | F_int is calculated). |
---|
| 42 | |
---|
[1266] | 43 | Bug fixes: |
---|
[1249] | 44 | |
---|
[1266] | 45 | * Negative velocity (and other) values were resulting in the column |
---|
| 46 | widths not adjusting correctly, leading to columns running into each |
---|
| 47 | other. This has been fixed, so that the spacing in the results files |
---|
| 48 | should be correct. |
---|
| 49 | |
---|
[1270] | 50 | * Fixed a problem applicable to cubes with blank/masked pixels in the |
---|
| 51 | same spectra as detections. The velocity width calculations could |
---|
| 52 | sometimes fail due to the mask not being applied. |
---|
[1266] | 53 | |
---|
[1249] | 54 | Code changes: |
---|
| 55 | |
---|
| 56 | * The plotting code has been refactored, improving its class structure |
---|
| 57 | and inheritance. No functional change from this should be evident, |
---|
| 58 | but it improves the maintainability of the code. |
---|
| 59 | |
---|
| 60 | |
---|
[1229] | 61 | Duchamp version 1.4 (2013/06/20) |
---|
| 62 | -------------------------------- |
---|
| 63 | |
---|
| 64 | Installation: |
---|
| 65 | |
---|
| 66 | * The "make lib" command will now create a shared library |
---|
| 67 | libduchamp.1.4.so as well as the static library libduchamp.1.4.a |
---|
| 68 | (formerly just called libduchamp.a). |
---|
| 69 | |
---|
| 70 | Bug Fixes: |
---|
| 71 | |
---|
| 72 | * The orientation of ellipses in the DS9 region files are now correct |
---|
| 73 | (they were wrong by 90 degrees). |
---|
| 74 | |
---|
| 75 | * Corrected the output FITS filenames so that they work when the input |
---|
| 76 | filename does *not* end in ".fits". |
---|
| 77 | |
---|
| 78 | Code changes: |
---|
| 79 | |
---|
| 80 | * The code that manages the output columns for the ASCII and VOTable |
---|
| 81 | output has been overhauled and streamlined. Little functional change |
---|
| 82 | should be evident, but it should be much more robust. And easier to |
---|
| 83 | use in derived software. |
---|
| 84 | |
---|
[1213] | 85 | Duchamp version 1.3.2 (2013/05/02) |
---|
| 86 | ---------------------------------- |
---|
| 87 | |
---|
| 88 | Bug fixes: |
---|
| 89 | |
---|
| 90 | * The units for the integrated flux (for F_int) were not being |
---|
| 91 | calculated for cases of a FITS file without a spectral |
---|
| 92 | axis. Additionally, a vestigial default value meant this column had |
---|
| 93 | units of "counts". This has been fixed so that a FITS file with |
---|
| 94 | Jy/beam units will have F_int values in Jy. |
---|
| 95 | |
---|
| 96 | * The ellipse fitting to find the MAJ/MIN/PA was not working correctly |
---|
| 97 | in the case of negative searches. This has been fixed. |
---|
| 98 | |
---|
| 99 | * The scaling of MAJ/MIN values was not being done correctly in all |
---|
| 100 | cases, so that the values were out by a factor of 60 or 3600. This |
---|
| 101 | was particularly the case when the ellipse fitting failed (due to |
---|
| 102 | small numbers of pixels, for instance). |
---|
| 103 | |
---|
| 104 | * The principle axes calculations have been simplified slightly, and |
---|
| 105 | now are done only on pixels above half the peak in the moment-0 map |
---|
| 106 | (to estimate the FWHM). |
---|
| 107 | |
---|
[1202] | 108 | Duchamp version 1.3.1 (2013/04/18) |
---|
| 109 | ---------------------------------- |
---|
| 110 | |
---|
| 111 | Bug fixes: |
---|
| 112 | |
---|
| 113 | * The kernel used in the 2D smoothing was not normalised properly, |
---|
| 114 | which meant the fluxes in the smoothed array were scaled |
---|
| 115 | incorrectly. The kernel is now normalised, so that the fluxes in the |
---|
| 116 | smoothed array decrease (and to an increasing degree with larger |
---|
| 117 | kernels, as expected). |
---|
| 118 | |
---|
| 119 | * The way the position angle of the smoothing kernel was interpreted |
---|
| 120 | was wrong. It now conforms to the typical astronomical position |
---|
| 121 | angle definition of degrees east of north. |
---|
| 122 | |
---|
| 123 | * The Z_PEAK column was being left out of the results file for |
---|
| 124 | Duchamp-1.3. It has been put back in. |
---|
| 125 | |
---|
| 126 | * The calculation of S/Nmax has changed so that when smoothing or |
---|
| 127 | reconstruction is done, the peak flux used is measured in the |
---|
| 128 | reconstructed/smoothed array (where the noise is measured). |
---|
| 129 | |
---|
| 130 | * The flux errors are now not reported in the case of smoothing, since |
---|
| 131 | we don't measure the noise in the original input image array. |
---|
| 132 | |
---|
| 133 | Other fixes: |
---|
| 134 | |
---|
| 135 | * The vertical range of the spectral plots now properly takes into |
---|
| 136 | account all spectra (not just the input array), and quirks with a MW |
---|
| 137 | range lying outside the plotted range have been fixed. |
---|
| 138 | |
---|
| 139 | * The flux scaling for the moment-0 map plot now ignores negative |
---|
| 140 | values, meaning the scale should be sensible. |
---|
| 141 | |
---|
| 142 | * The spelling of the Object2D::getPrincipalAxes() has been corrected. |
---|
| 143 | |
---|
| 144 | * Minor code optimisations have been made to the smoothing code. |
---|
| 145 | |
---|
| 146 | * The subsection class is now initialised with a blank string. |
---|
| 147 | |
---|
[1181] | 148 | Duchamp version 1.3 (2013/03/08) |
---|
| 149 | -------------------------------- |
---|
[1150] | 150 | |
---|
| 151 | New features: |
---|
| 152 | |
---|
[1159] | 153 | * New source parameters: |
---|
[1150] | 154 | |
---|
[1159] | 155 | # Each source now has a measurement of the major & minor axis sizes, |
---|
| 156 | along with the position angle of the major axis. The sizes are the |
---|
| 157 | full-width at half maximum, measured from the moment-0 map. These |
---|
| 158 | now appear in the catalogue and in the spectral plots, with the |
---|
| 159 | ellipse drawn on the moment map cutout in the spectral plots. The |
---|
| 160 | old measurements of w_RA & w_DEC are still made and included in |
---|
| 161 | the full catalogue, but are no longer reported in the smaller |
---|
| 162 | catalogue printed to screen (nor in the XML/VOTable output). |
---|
[1150] | 163 | |
---|
[1159] | 164 | # Each source also now has a measurement of the error on the |
---|
| 165 | integrated and total fluxes. This is calculated from summing in |
---|
[1178] | 166 | quadrature the statistical noise on each detected voxel. This is |
---|
| 167 | from a request by Sara Shakouri. |
---|
[1150] | 168 | |
---|
[1159] | 169 | * Output files - new types and changes to the way they are written: |
---|
[1150] | 170 | |
---|
[1159] | 171 | # Ability to create CASA region format files showing the location of |
---|
| 172 | the detected sources. This is analogous to the Karma annotation |
---|
| 173 | files or DS9 region files, for use with the casa viewer, but can |
---|
| 174 | also be imported into casapy. |
---|
[1150] | 175 | |
---|
[1159] | 176 | # Ability to save baseline values to a FITS file (in the same way as |
---|
| 177 | for the reconstructed or smoothed array). |
---|
[1150] | 178 | |
---|
[1159] | 179 | # Ability to save the moment-0 mask to a FITS file (that is, a mask |
---|
| 180 | indicating which spatial pixels form part of the moment-0 map). |
---|
[1150] | 181 | |
---|
[1159] | 182 | # There is an improved way to store the detected pixels for later |
---|
| 183 | re-use. While previously the detected pixels were written as scans |
---|
| 184 | to the logfile, and then read in when the usePrevious flag was |
---|
| 185 | set, we now write the scans and other metadata to a binary |
---|
| 186 | catalogue that can be read in again. Writing as a binary file |
---|
| 187 | leads to much better compression of the data, particularly when |
---|
| 188 | combined with the run-length encoding. It is anticipated future |
---|
| 189 | tools will be provided to allow additional interaction with these |
---|
| 190 | binary catalogues. |
---|
| 191 | |
---|
| 192 | # There are slight changes to the format of the ASCII catalogues, |
---|
| 193 | where lines not containing sources are prefixed with a comment |
---|
| 194 | character '#'. This will facilitate their use in other software. |
---|
| 195 | |
---|
[1161] | 196 | * There is a new command-line parameter, -t THRESH, which specifies |
---|
| 197 | the flux threshold for searching. It is designed to be used with the |
---|
| 198 | -f option, as a quick way of searching a FITS image to a specified |
---|
| 199 | flux level. |
---|
[1159] | 200 | |
---|
[1150] | 201 | Bug fixes: |
---|
| 202 | |
---|
| 203 | * A bug in the spatial smoothing has been fixed. The mask was being |
---|
| 204 | interpreted incorrectly, so that no valid pixels were getting |
---|
| 205 | smoothed. |
---|
| 206 | |
---|
| 207 | * The WCS for the moment-0 FITS cube has been fixed (specifically, the |
---|
| 208 | axis names). |
---|
| 209 | |
---|
| 210 | * When usePrevious was used, the behaviour in previous versions was to |
---|
| 211 | always write individual spectra. This is now controlled by a new |
---|
| 212 | parameter flagPlotIndividualSpectra. |
---|
| 213 | |
---|
| 214 | * Minor improvements to the output when verbose=false. |
---|
| 215 | |
---|
| 216 | * Improvements to the Makefile, so that header files from a |
---|
| 217 | previously-installed version of Duchamp do not get used instead of |
---|
| 218 | those from the current version. |
---|
| 219 | |
---|
| 220 | * The vertical range for the spectral plots now take into account the |
---|
| 221 | baseline and reconstructed/smoothed arrays as well (outside of any |
---|
| 222 | MW range, of course). |
---|
| 223 | |
---|
| 224 | Other |
---|
| 225 | |
---|
| 226 | * The code-base for reading from and writing to FITS files has been |
---|
| 227 | overhauled and streamlined. It can now be found in the FitsIO |
---|
[1180] | 228 | directory. The interface for the writing of FITS files via the Cube |
---|
| 229 | class has not changed. |
---|
[1150] | 230 | |
---|
[1161] | 231 | * The User Guide has been slightly re-ordered to provide more explicit |
---|
| 232 | information about the source parameters. |
---|
[1150] | 233 | |
---|
[1161] | 234 | |
---|
[1107] | 235 | Duchamp version 1.2.2 (2012/10/29) |
---|
| 236 | ---------------------------------- |
---|
| 237 | |
---|
| 238 | Bug fixes: |
---|
| 239 | |
---|
| 240 | * The reading of reconstructed & smoothed arrays in the case of large |
---|
| 241 | (>2GB) cubes has been improved. While the most recent versions of |
---|
| 242 | cfitsio were able to handle these, earlier versions would result in |
---|
| 243 | a segementation fault using the previous interface. An alternative |
---|
| 244 | interface has been implemented that avoids these faults, even for |
---|
| 245 | the older cfitsio libraries. |
---|
| 246 | |
---|
| 247 | * A bug affecting the writing of FITS mask files (apparently for the |
---|
| 248 | case of flagging by the object number) has been fixed. |
---|
| 249 | |
---|
| 250 | * The moment map occasionally failed if sources lay spatially within |
---|
| 251 | the blank pixel region of the first channel. This check has been |
---|
| 252 | removed and the moment map should be produced successfully in all |
---|
| 253 | situations. |
---|
| 254 | |
---|
| 255 | Other: |
---|
| 256 | |
---|
| 257 | * The UCDs used in the VOTable catalogue output have been |
---|
| 258 | updated. Several of these were shared between different columns, and |
---|
| 259 | so they have been changed so that each UCD is unique to one |
---|
| 260 | column. The column ID strings have been updated for clarity. |
---|
| 261 | |
---|
| 262 | * The determination of default output image filenames has been |
---|
| 263 | improved -- it previously assumed the input filename ended in |
---|
| 264 | '.fits', but this is no longer the case. |
---|
| 265 | |
---|
[1087] | 266 | Duchamp version 1.2.1 (2012/10/09) |
---|
| 267 | ---------------------------------- |
---|
| 268 | |
---|
| 269 | New feature: |
---|
| 270 | |
---|
| 271 | * Duchamp can now produce region files to annotate images displayed in |
---|
| 272 | SAOImage DS9. There are new parameters flagDS9 and ds9File that work |
---|
| 273 | in the same way as the Karma annotation file parameters. The region |
---|
| 274 | files can also be displayed in (at least some versions of) |
---|
| 275 | casaviewer. |
---|
| 276 | |
---|
| 277 | * There is a new script to fix occasional problems with the |
---|
| 278 | automatically-detected Makefile, and the verification script has |
---|
| 279 | been updated and improved. |
---|
| 280 | |
---|
| 281 | Bug fixes: |
---|
| 282 | |
---|
| 283 | * The main bug fix for this release corrects a problem with the |
---|
| 284 | velocity width measurements made when searching for negative |
---|
| 285 | detections. It was possible to get very small (and incorrect) widths |
---|
| 286 | in some cases - this was due to the integrated spectrum not being |
---|
| 287 | inverted correctly. |
---|
| 288 | |
---|
| 289 | * In the case of smoothing, the stats of the full cube that were being |
---|
| 290 | reported in the output files were actually those of the un-smoothed |
---|
| 291 | (input cube). This only affected the output files, not the detection |
---|
| 292 | process itself. |
---|
| 293 | |
---|
| 294 | * The units were not being reported in the VOTable. This has been |
---|
| 295 | fixed. |
---|
| 296 | |
---|
| 297 | * The UCDs for the spectral parameters in the VOTable were not being |
---|
| 298 | adapted to the user requests, so didn't always match the types of |
---|
| 299 | the parameters. All should be consistent now. |
---|
| 300 | |
---|
| 301 | Other changes: |
---|
| 302 | |
---|
| 303 | * The codebase relating to the creation of and writing to output files |
---|
| 304 | (results, logs, annotation, VOTables) has been overhauled, with a |
---|
[1088] | 305 | cleaner interface. Most of this code is in the new subdirectory |
---|
| 306 | src/Outputs, to where the columns code has been moved as well. |
---|
[1087] | 307 | |
---|
[1088] | 308 | This was instigated by ASKAP/Selavy development, but also allowed |
---|
| 309 | the expansion of output formats to include DS9 region files. No |
---|
| 310 | change to the user should be visible, but anyone using the software |
---|
| 311 | will notice differences. Please get in touch if changes are |
---|
| 312 | difficult to follow. |
---|
| 313 | |
---|
[1035] | 314 | Duchamp version 1.2 (2012/08/08) |
---|
[962] | 315 | -------------------------------- |
---|
[928] | 316 | |
---|
[951] | 317 | Key changes: |
---|
| 318 | |
---|
| 319 | * The way the wavelet reconstruction is done in the presence of BLANK |
---|
| 320 | voxels is slightly different, specifically when there were BLANK |
---|
| 321 | voxels on the edge. While BLANK voxels are always ignored by the |
---|
| 322 | reconstruction (and left in place), the previous approach dealt with |
---|
| 323 | BLANKS on the edge by moving the effective edge of the image inwards |
---|
| 324 | until the first non-blank voxel. This meant that the size of the |
---|
| 325 | dimensions used to determine the number of scales, and the location |
---|
| 326 | where boundary reflections took place where different to the input |
---|
| 327 | image size. |
---|
| 328 | |
---|
| 329 | However, this meant that BLANK voxels on the edge were treated |
---|
| 330 | differently to those not on the edge, so this inconsistency was |
---|
| 331 | removed. The full image dimensions are always used to calculate the |
---|
| 332 | number of scales, and reflections (which is how the reconstruction |
---|
| 333 | deals with the boundaries) will occur at the actual image edges. |
---|
| 334 | |
---|
| 335 | If your data has this property (BLANK pixels at the image |
---|
| 336 | boundaries), then any reconstruction will be affected (most likely |
---|
| 337 | only in a small way) and potentially any subsequent searching. You |
---|
[1035] | 338 | are advised to check this (for instance by saving the results of the |
---|
| 339 | resonstruction from 1.1.13 and 1.2 and comparing). |
---|
[951] | 340 | |
---|
[1035] | 341 | * The way the spectral world coordinate system is dealt with has been |
---|
| 342 | improved. Previously Duchamp tried to convert to a velocity axis, |
---|
| 343 | and got a bit grumpy if that didn't work well. Now it will express |
---|
| 344 | the spectral units in the axis type indicated by the FITS |
---|
| 345 | header. Duchamp will also allow you to change this type by providing |
---|
| 346 | an appropriate WCS type as an input parameter. You may also provide |
---|
| 347 | a rest frequency in the parameter file and this will be used to |
---|
| 348 | calculate velocities. And, as before, you can provide specific units |
---|
| 349 | for the spectral quantities to be converted into. |
---|
| 350 | |
---|
[951] | 351 | * Since v1.1.13 was released, the journal paper describing Duchamp has |
---|
| 352 | been published. It can be found at MNRAS 421, 3242 (2012), or |
---|
| 353 | http://onlinelibrary.wiley.com/doi/10.1111/j.1365-2966.2012.20548.x/full. It |
---|
| 354 | includes descriptions of the various algorithms used for Duchamp, as |
---|
| 355 | well as some indicative comparisons of the relative completeness & |
---|
| 356 | reliability. Please cite this paper when describing Duchamp. |
---|
| 357 | |
---|
| 358 | Other new features: |
---|
| 359 | |
---|
[1035] | 360 | * The default value of snrCut has changed from 3 to 5. This is |
---|
| 361 | espeically important if you use the -f option, but also if you don't |
---|
| 362 | provide snrCut in your parameter file. |
---|
| 363 | |
---|
[951] | 364 | * The XML VOTable output now includes a more complete list of |
---|
| 365 | parameters, matching the output given in text form in the results & |
---|
| 366 | log output files. Only those parameters affecting the results are |
---|
| 367 | included - things like the output file names and so on are left out. |
---|
| 368 | |
---|
| 369 | * The minVoxels parameter is now adjusted to be at least (minPix + |
---|
| 370 | minChannels - 1). If it is changed, a warning message is triggered. |
---|
| 371 | |
---|
| 372 | * The warning/error reporting has been overhauled, with an improved |
---|
| 373 | interface for developers. Also, some ERROR instances that previously |
---|
| 374 | resulted in the program terminating now allow it to continue |
---|
| 375 | (provided that is possible given the error). |
---|
| 376 | |
---|
[1026] | 377 | * It is now possible to give the convergence criterion for the wavelet |
---|
| 378 | reconstruction via the parameter reconConvergence. When the relative |
---|
| 379 | change in standard deviation of the residuals from the |
---|
| 380 | reconstruction falls below this value, the a trous algorithm stops |
---|
| 381 | iterating. |
---|
| 382 | |
---|
[991] | 383 | * The way one-dimensional arrays were dealt with was unsatisfactory, |
---|
| 384 | both with the way positions were registered and the format of the |
---|
| 385 | graphical output. Improvements have been made such that a 1D data |
---|
| 386 | structure is assumed to be a spectrum, and so positions in the |
---|
| 387 | spectrum are reported as z-pixels (or the equivalent world |
---|
| 388 | coordinate). Instead of a 2D moment map, the X-windows display will |
---|
| 389 | show the spectrum with all detected pixels plus the final list of |
---|
| 390 | detections highlighted, along with the detection and growth |
---|
[1035] | 391 | thresholds. This plot will also be written to the "detectionMap" |
---|
| 392 | image. |
---|
[991] | 393 | |
---|
| 394 | * All spectral plots will now show the detection (and growth, if |
---|
| 395 | applicable) thresholds when plotting the peak flux spectrum. |
---|
| 396 | |
---|
| 397 | * Accessing FITS files when a subsection string is provided has been |
---|
| 398 | streamlined. The cfitsio package, which handles the FITS access, |
---|
| 399 | creates a temporary file containing this image section, and this |
---|
| 400 | meant the previous approach was slow, particularly for large |
---|
| 401 | files/sections. Now the file is only opened once and the overhead of |
---|
| 402 | creating the temporary file is only encountered once. |
---|
| 403 | |
---|
| 404 | * Several aspects of the processing & output did not handle a |
---|
| 405 | non-existent WCS well. This has been improved, so that all stages of |
---|
| 406 | execution will proceed without errors. |
---|
| 407 | |
---|
[928] | 408 | Bug fixes: |
---|
| 409 | |
---|
[941] | 410 | * The absence of a BLANK keyword when trimming will now not trigger a |
---|
| 411 | failure, only a warning message. |
---|
[928] | 412 | |
---|
[941] | 413 | * The flux unit conversion (eg. from Jy/beam to mJy/beam) was not |
---|
| 414 | being applied correctly when an existing reconstructed or smoothed |
---|
| 415 | array was being read in. This is now applied properly. |
---|
| 416 | |
---|
| 417 | * When saving reconstructed or smoothed arrays, the data type is now |
---|
| 418 | set to FLOAT, so that the correct values are written (and |
---|
| 419 | subsequently read in). The previous version was potentially saving |
---|
| 420 | to a FITS file with integer data type (this depended on the type of |
---|
[951] | 421 | the input array). In this case, the full precision of data values |
---|
| 422 | would not be preserved, so reading back in and doing an identical |
---|
| 423 | search could yield different sources. |
---|
[941] | 424 | |
---|
| 425 | * For certain cases, the reconstruction attempted to use a very large |
---|
| 426 | number of scales. This has been fixed. |
---|
| 427 | |
---|
[1026] | 428 | * The maximum scale for the reconstruction was not always being |
---|
| 429 | applied. The scale ranges are now enforced for all types of |
---|
| 430 | reconstructions. |
---|
| 431 | |
---|
[941] | 432 | * When saving a mask image while using a subsection of a cube, the |
---|
| 433 | offsets for the subsection were not being accounted for |
---|
| 434 | correctly. This is now fixed. |
---|
| 435 | |
---|
[991] | 436 | * The detection map plots were not recording pixels added from the |
---|
| 437 | growing stage. This has been fixed. |
---|
| 438 | |
---|
[941] | 439 | * The RA & Dec now have appropriate precision, rather than an |
---|
| 440 | arbitrary 2 decimal places on the seconds value. The RA will be one |
---|
| 441 | decimal place more than the Dec, and they will reflect the degree of |
---|
| 442 | precision in the image pixels. |
---|
| 443 | |
---|
| 444 | * A number of data type conversions (typically ints to floats) led to |
---|
| 445 | errors in some calculations, such as WCS conversions. Care has been |
---|
| 446 | taken to make sure all indexing is done appropriately with no |
---|
| 447 | overflow, and that all conversions (where necessary) are done |
---|
| 448 | appropriately. |
---|
| 449 | |
---|
| 450 | * It was possible to get world positions looking like 11:59:60.0! Not |
---|
| 451 | any more. |
---|
| 452 | |
---|
[1020] | 453 | * Reading previous detections from the log file (via the use of the |
---|
| 454 | usePrevious parameter) did result in error messages due to slightly |
---|
| 455 | incompatible formats. These have been fixed, and all graphical |
---|
| 456 | output should work properly. |
---|
[928] | 457 | |
---|
[1020] | 458 | * When using a spectral search, having a blank pixel in the first |
---|
| 459 | channel could lead to that entire spectrum being ignored, leading to |
---|
| 460 | inconsistent results between spectral and spatial searches. This |
---|
| 461 | issue has been fixed, with both types of searches returning the same |
---|
| 462 | catalogue. |
---|
| 463 | |
---|
| 464 | |
---|
[928] | 465 | Code base development notes: |
---|
| 466 | |
---|
[951] | 467 | * Most instances of integer overflow due to insufficient precision |
---|
| 468 | have been tracked down - many of these were indexing variables of |
---|
| 469 | type int, which have been changed to size_t. |
---|
[928] | 470 | |
---|
[1020] | 471 | * Importantly, for code interfacing with the duchamp::Cube and related |
---|
| 472 | classes, axisDim is now an array of size_t elements, rather than |
---|
| 473 | long. |
---|
| 474 | |
---|
[951] | 475 | * Object3D now carries its spatial map with it, rather than |
---|
| 476 | calculating it on the fly when requested. This saves a lot of |
---|
| 477 | unnecessary computational effort. |
---|
[928] | 478 | |
---|
[951] | 479 | * The warning/error interface has improved, making use of C++ |
---|
| 480 | exception handling. This should be compatible with external logging |
---|
| 481 | infrastructure (such as log4cxx). |
---|
| 482 | |
---|
[1035] | 483 | * The interface to the FitsHeader & WCS structures for external code |
---|
| 484 | has been improved, so that the WCS can be set up via function calls. |
---|
[951] | 485 | |
---|
| 486 | |
---|
| 487 | |
---|
[852] | 488 | Duchamp version 1.1.13 (2011/04/10) |
---|
| 489 | ------------------------------------- |
---|
| 490 | |
---|
| 491 | Bug fixes: |
---|
| 492 | |
---|
| 493 | * The median statistics calculations had a bug in the test for whether |
---|
| 494 | the array under consideration was of even size. The correction for |
---|
| 495 | this can mean small differences in the resulting values. This can |
---|
| 496 | flow through to calculated detection thresholds - please check this |
---|
| 497 | with your data if you use this mode! |
---|
| 498 | |
---|
| 499 | * The reconstruction code had a bug where the incorrect number of |
---|
| 500 | scales was being used. This occurred when the blank pixel flag was |
---|
| 501 | set, and when the spectral dimension was smaller than both the |
---|
| 502 | spatial dimensions. |
---|
| 503 | |
---|
| 504 | Other: |
---|
| 505 | |
---|
| 506 | * The default value of the blank pixel flag has been set to false, |
---|
| 507 | rather than true. For Duchamp, this should not matter, as it is set |
---|
| 508 | when the FITS file is read in. For external code using, for |
---|
| 509 | instance, the reconstruction algorithms, this default may be |
---|
| 510 | important. Having it true was contributing to the second bug listed |
---|
| 511 | above. It also makes more sense for it to be false unless explicitly |
---|
| 512 | set in some way. |
---|
| 513 | |
---|
| 514 | * The reconstruction code has been streamlined a little, reducing its |
---|
| 515 | memory impact and using more appropriate variable types |
---|
| 516 | (eg. unsigned ints instead of ints and so forth). |
---|
| 517 | |
---|
| 518 | * For those who care about the actual code base, the statistics |
---|
| 519 | functions have been expanded, and separated from getStats.cc into |
---|
| 520 | "normal" and "robust" versions. |
---|
| 521 | |
---|
| 522 | |
---|
[836] | 523 | Duchamp version 1.1.12 (2011/03/18) |
---|
| 524 | ------------------------------------- |
---|
| 525 | |
---|
| 526 | Bug fixes: |
---|
| 527 | |
---|
| 528 | * The velocity width calculations had a bug that occasionally led to |
---|
| 529 | very large values. The widths are calculated using the integrated |
---|
| 530 | spectrum, using a threshold relative to its peak. In v.1.1.10 and |
---|
| 531 | 1.1.11, however, the peak was searched for over the entire spectral |
---|
| 532 | range, rather than just the range for the current object. This led |
---|
| 533 | to spurious values. This has been fixed, so that the peak is only |
---|
| 534 | searched for within the detected ranage of the object. |
---|
| 535 | |
---|
| 536 | * Both the pixel and statistics subsections are now more carefully |
---|
| 537 | examined, with errors reported if there are no valid pixels in the |
---|
| 538 | pixel subsection, or if the statistics subsection does not intersect |
---|
| 539 | with the pixel subsection. |
---|
| 540 | |
---|
| 541 | Other: |
---|
| 542 | |
---|
| 543 | * The configure script has been slightly improved so that the pgsbox |
---|
| 544 | library is only added if PGPlot has been enabled - this is |
---|
| 545 | particularly necessary with the slightly changed build procedure for |
---|
| 546 | recent wcslib versions. |
---|
| 547 | |
---|
| 548 | * In a related note, one file - momentMap.cc - had some #include |
---|
| 549 | statements that failed when PGPlot (and hence pgsbox in WCSLIB) was |
---|
| 550 | not enabled. These were actually unnecesssary and have been removed. |
---|
| 551 | |
---|
| 552 | * There is a new input parameter - flagPlotSpectra - that allows the |
---|
| 553 | user to turn off the production of the spectral plots. It defaults |
---|
| 554 | to true (meaning the plots are produced). |
---|
| 555 | |
---|
| 556 | |
---|
[819] | 557 | Duchamp version 1.1.11 (2011/03/01) |
---|
[799] | 558 | ------------------------------------- |
---|
| 559 | |
---|
| 560 | Improvements: |
---|
| 561 | |
---|
| 562 | * The largest changes in this release involved improving the |
---|
| 563 | efficiency of the code, resulting in further speed-ups. The code |
---|
| 564 | affected was the low-level object-handling code, with the merging |
---|
| 565 | stages in particular showing good speed-ups. |
---|
| 566 | |
---|
| 567 | * The default value for the beam size, when the beam parameters are |
---|
| 568 | not in the FITS header, has been dropped. Now the default behaviour |
---|
| 569 | is to simply not make any beam corrections if the beam is not |
---|
| 570 | specified by either the FITS file or the input parameters. Thanks to |
---|
| 571 | Tobias Westemeier for the suggestion. |
---|
| 572 | |
---|
| 573 | * The reporting of the beam size has changed slightly to provide a bit |
---|
| 574 | more information. |
---|
| 575 | |
---|
| 576 | Bug Fixes: |
---|
| 577 | |
---|
[819] | 578 | * The statistics section (statSec) could be larger than the image |
---|
| 579 | subsection (if provided), yet the pixels required would never be |
---|
| 580 | read in from the FITS file. The behaviour has been changed so that |
---|
| 581 | the statSec, if requested, is trimmed to be wholly within the image |
---|
| 582 | section. |
---|
| 583 | |
---|
| 584 | * It was possible to request, for instance, spectral smoothing on a 2D |
---|
| 585 | image. This resulted in a blank smoothed array, which led to |
---|
| 586 | problems in the calculations of statistics (and hence the |
---|
| 587 | threshold), as well as subsequent calculations. This has been fixed, |
---|
| 588 | so that in cases like this the smoothing is turned off (and a |
---|
| 589 | warning message is displayed). |
---|
| 590 | |
---|
[799] | 591 | * There was a problem with using a MW range and subsectioning when |
---|
| 592 | growing objects, as a result of changes in 1.1.10. This has been |
---|
| 593 | fixed. |
---|
| 594 | |
---|
| 595 | * Inversion was failing when no array was allocated (not a problem for |
---|
| 596 | standard Duchamp, but affected its use as a library by other code). |
---|
| 597 | |
---|
[812] | 598 | * Writing text spectra would only occur when PGPlot output was enabled |
---|
| 599 | in the build (it was combined with the plotting of the spectral |
---|
[810] | 600 | graphs). This has been changed so that this output can be requested |
---|
[812] | 601 | without requiring PGPlot. |
---|
[810] | 602 | |
---|
[804] | 603 | * The equation for the beam size in Sec.4.2 of the User Guide was |
---|
| 604 | incorrect and has been fixed. |
---|
| 605 | |
---|
[819] | 606 | * Minor change to the configure script to improve the detection of the |
---|
| 607 | PGPlot library. |
---|
| 608 | |
---|
| 609 | Code development notes: |
---|
| 610 | |
---|
| 611 | * The main work has been additions and improvements to the interfaces |
---|
| 612 | for the Param and the Section classes, as well as new classes to |
---|
| 613 | manage the beam information. The efficiency changes mentioned above |
---|
| 614 | also affected the internals of some of the PixelInfo classes, and |
---|
| 615 | provided additional functions for judging the closeness of |
---|
| 616 | neighbouring objects. |
---|
| 617 | |
---|
[760] | 618 | Duchamp version 1.1.10 (2010/11/15) |
---|
[574] | 619 | ------------------------------------- |
---|
[542] | 620 | |
---|
[760] | 621 | Improvements: |
---|
| 622 | |
---|
| 623 | * The major change for this release is a greatly improved growing |
---|
| 624 | algorithm. The previous incarnation was very inefficient (testing |
---|
| 625 | all pixels in an object, most of which only have neighbours that are |
---|
| 626 | already in the object), and could take an unnecessarily large amount |
---|
| 627 | of time in the case of extended sources. The improved algorithm |
---|
| 628 | makes use of voxel flags to quickly identify those voxels not yet in |
---|
| 629 | an object and only examines them. For a certain test case |
---|
| 630 | (observations of extended Galactic HI), the time required reduced |
---|
[761] | 631 | from about a day to about a minute! (Note that compact sources, such |
---|
| 632 | as HI galaxies, will not show this degree of speedup...) Many thanks |
---|
| 633 | to Tara Murphy for pointing out this bug and her help in |
---|
| 634 | diagnosing/fixing the problem. |
---|
[760] | 635 | |
---|
| 636 | * There have been a number of further improvements to the code to |
---|
| 637 | speed it up, based on some profiling. The most important was the |
---|
| 638 | function to add pixels to a 2D object, but there were several other |
---|
| 639 | minor changes as well. |
---|
| 640 | |
---|
| 641 | * The minimum size of the detections can now also be specified in |
---|
| 642 | terms of the total number of voxels (in addition or instead of |
---|
| 643 | specifying the minimum spatial pixels or channels). |
---|
| 644 | |
---|
| 645 | * The way memory is allocated when reading the image has been |
---|
| 646 | streamlined. The amount of memory being allocated is also now |
---|
| 647 | reported - this is in an effort to allow users to identify problems |
---|
| 648 | with running out of memory. |
---|
| 649 | |
---|
| 650 | * The version number is now reported in the results and log files. |
---|
| 651 | |
---|
| 652 | * Only the filename of the input image (ie. not the leading |
---|
| 653 | directories) is now shown on the detection and moment-0 maps. This |
---|
| 654 | is to avoid problems with large directory paths being too wide for |
---|
| 655 | the plot. |
---|
| 656 | |
---|
| 657 | * The verification script was improved for readability (although no |
---|
| 658 | functional change was made). |
---|
| 659 | |
---|
| 660 | Bug fixes: |
---|
| 661 | |
---|
| 662 | * Growing was not being done when a single source was found. Now |
---|
| 663 | fixed. |
---|
| 664 | |
---|
| 665 | * For particular WCS setups, the RA can be interpreted as being |
---|
| 666 | negative, which corrupted the Source ID (ie. the IAU-format |
---|
| 667 | string). This has been fixed. |
---|
| 668 | |
---|
| 669 | * When the flux units were changed, problems had been seen when |
---|
| 670 | writing a reconstructed cube to a FITS file. Any unit change is now |
---|
| 671 | undone prior to writing and there should now be no problem. |
---|
| 672 | |
---|
| 673 | * Filenames with spaces in them were not handled well. New functions |
---|
| 674 | were included and moved to a more obvious location. These filenames |
---|
| 675 | now work as expected. |
---|
| 676 | |
---|
| 677 | * Spectral axes of type FREQ that had a rest frequency were not being |
---|
| 678 | put into velocity units. Now fixed. |
---|
| 679 | |
---|
| 680 | * Improvements to the output to screen, making sure everything is |
---|
| 681 | covered by the verbose flag. |
---|
| 682 | |
---|
| 683 | * Better management of the allocation of arrays. |
---|
| 684 | |
---|
| 685 | * The minSize parameter in Image was never initialised, leading to |
---|
| 686 | unpredictable behaviour. Now fixed. |
---|
| 687 | |
---|
| 688 | Code development notes: |
---|
| 689 | |
---|
| 690 | * New functionality includes: a function to return a vector list of |
---|
| 691 | voxels in an Object3D or Detection; a new generic Search function |
---|
| 692 | (basically a front-end to each of the individual functions); more |
---|
[766] | 693 | complete copy constructors for the DataArray classes; new methods |
---|
| 694 | for finding the velocity widths. |
---|
[760] | 695 | |
---|
| 696 | Duchamp version 1.1.9 (2010/03/26) |
---|
| 697 | ------------------------------------- |
---|
| 698 | |
---|
[654] | 699 | Improvements: |
---|
[616] | 700 | |
---|
[680] | 701 | * There is now the ability to save the moment-0 map as a FITS |
---|
| 702 | file. This is controlled by the parameters flagOutputMomentMap and |
---|
| 703 | fileOutputMomentMap, which work in the same way for the mask file. |
---|
| 704 | |
---|
[697] | 705 | * There is a new parameter flagRejectBeforeMerge that, when true, |
---|
[680] | 706 | rejects sources according to the minPix/minChannels requirements |
---|
| 707 | before the merging and growing is done. This defaults to false (so |
---|
| 708 | default behaviour is as before). Thanks to Tobias Westmeier for |
---|
| 709 | suggesting this and the above improvement. |
---|
| 710 | |
---|
[697] | 711 | * There is also a new parameter flagTwoStageMerging. When true (the |
---|
| 712 | default), newly-detected objects are merged with the first close |
---|
| 713 | object in the list. When false, they are simply added to the end of |
---|
| 714 | the list. In both cases, a second round of merging is done to pick |
---|
| 715 | up all close matches. |
---|
| 716 | |
---|
[680] | 717 | * The way the beam is specified in the absence of the BMAJ/BMIN/BPA |
---|
| 718 | parameters has been slightly changed. The use of "beamSize" was |
---|
| 719 | somewhat ambiguous (it meant the number of pixels covered by the |
---|
| 720 | beam, not the FWHM), so new parameters have been introduced. The |
---|
| 721 | beam can be specified by beamArea (which replaces beamSize), or |
---|
| 722 | beamFWHM (the FWHM of the beam in pixels). If beamFWHM is provided, |
---|
| 723 | it will be used, else the beamArea will be. |
---|
| 724 | |
---|
[687] | 725 | * There is a new parameter searchType that allows the user to choose |
---|
| 726 | how the searching is done. The behaviour up till now has been to |
---|
| 727 | search the 2D channel maps one at a time to build up the 3D |
---|
| 728 | detections. This is the default, and can be obtained by setting |
---|
| 729 | searchType=spatial. Alternatively, you can set searchType=spectral |
---|
| 730 | to do the searching in the 1D spectra. |
---|
| 731 | |
---|
[654] | 732 | * Profiling of the code has led to a few changes that have sped up |
---|
| 733 | some calculations, particularly those involving the median. Rather |
---|
| 734 | than using std::sort, the code now simply uses std::nth_element, |
---|
| 735 | which shows a substantial speedup factor. |
---|
| 736 | |
---|
| 737 | * When using the objectList parameter, the maps will now only show the |
---|
| 738 | selected objects, rather than all detected objects. |
---|
| 739 | |
---|
| 740 | * There is a new verification test that looks at the "growing" |
---|
| 741 | functionality. |
---|
| 742 | |
---|
| 743 | Bug fixes: |
---|
| 744 | |
---|
[670] | 745 | * When saving a mask FITS file, there was an occasional memory leak |
---|
| 746 | that caused Duchamp to crash (only when the cube was suitably |
---|
| 747 | large). This has been fixed. |
---|
| 748 | |
---|
[680] | 749 | * The median calculation had a bug that led to an incorrect value |
---|
| 750 | being reported. The difference will not be great (the element of an |
---|
| 751 | array being reported as the median was out by one), but could be |
---|
| 752 | noticeable depending on the dataset. |
---|
| 753 | |
---|
| 754 | * The MW range parameters did not respond to the use of a |
---|
| 755 | subsection. They should refer to channel ranges in the original |
---|
| 756 | cube, and changes have been made to the code to reflect this. |
---|
| 757 | |
---|
[654] | 758 | * There was an occasional error in writing out FITS keywords, due to |
---|
| 759 | the way comment strings were intialised. This has been improved and |
---|
| 760 | made more robust. |
---|
| 761 | |
---|
| 762 | * Testing with gcc-4.3.2 showed a number of compilation warnings & |
---|
| 763 | errors, which have been fixed. |
---|
| 764 | |
---|
| 765 | * The Gaussian smoothing kernel was too small - it is now made big |
---|
| 766 | enough to encompass all possible values. It was also being |
---|
| 767 | incorrectly scaled. This had no functional effect on the detection |
---|
| 768 | of objects, but for other uses was incorrect. This has been |
---|
| 769 | rectified. |
---|
| 770 | |
---|
| 771 | * Some outputs that weren't caught by the verbose flag now are. |
---|
| 772 | |
---|
| 773 | |
---|
| 774 | Code development notes: |
---|
| 775 | |
---|
| 776 | The following notes only apply if you want to use the code as a |
---|
| 777 | library, rather than the stand-alone package. These have generally |
---|
| 778 | come out of the ASKAP software development. If you just use the |
---|
| 779 | stand-alone package, they won't be a concern. |
---|
| 780 | |
---|
[616] | 781 | * The API for storing detected objects has changed, making it more |
---|
[654] | 782 | robust from a programming point of view. |
---|
[616] | 783 | |
---|
[654] | 784 | * Additional versions of some functions (and the Gaussian smoothing |
---|
| 785 | class) have been added - this has come out of the ASKAP development |
---|
| 786 | work. |
---|
| 787 | |
---|
| 788 | * A number of instances of "unsigned int" being used for loops have |
---|
| 789 | been changed to iterators or "size_t". There shouldn't be any |
---|
| 790 | functional change from this -- the code should just build more |
---|
| 791 | cleanly. |
---|
| 792 | |
---|
[687] | 793 | * The Detection class now records whether the parameters have been |
---|
| 794 | set, and unsets that flag when objects are merged. This allows |
---|
| 795 | external programs to track which objects have been merged and deal |
---|
| 796 | with them appropriately. |
---|
[654] | 797 | |
---|
[687] | 798 | |
---|
[616] | 799 | Duchamp version 1.1.8 (2009/07/20) |
---|
| 800 | ---------------------------------- |
---|
| 801 | |
---|
[542] | 802 | Improvements: |
---|
| 803 | |
---|
[572] | 804 | * The final source list can now be sorted on one of a range of object |
---|
| 805 | parameters: x-value, y-value, z-value, ra, dec, vel, w50, iflux, |
---|
| 806 | pflux (integrated and peak flux respectively), or snr. Simply use |
---|
| 807 | the new input parameter sortingParam. Its default value is vel, so |
---|
| 808 | the default behaviour stays the same. |
---|
| 809 | |
---|
[543] | 810 | * The FDR method involves calculating how many pixels are |
---|
| 811 | correlated. This previously involved multiplying the beam area by 2, |
---|
| 812 | implying that 2 neighbouring channels were correlated. This factor |
---|
| 813 | is now a user-selectable parameter, so that if you know how many |
---|
| 814 | spectral channels should be correlated, you can set the parameter |
---|
| 815 | FDRnumCorChan and the FDR calculation will be done correctly. |
---|
| 816 | |
---|
[542] | 817 | * Screen output now has more information on the growing threshold when |
---|
| 818 | the cube statistics are printed. |
---|
| 819 | |
---|
| 820 | |
---|
| 821 | Bug fixes: |
---|
| 822 | |
---|
[584] | 823 | * When reading in previous detections, there was a bug causing a |
---|
| 824 | segmentation fault. This has been fixed and made more robust. |
---|
| 825 | |
---|
[579] | 826 | * There was an apparent bug when writing out the reconstructed cubes |
---|
| 827 | to a FITS file that caused the new file to be very large. Changing |
---|
| 828 | the cfitsio function used has fixed this. |
---|
| 829 | |
---|
[574] | 830 | * Using NCP projections near the equator could result in a large |
---|
| 831 | stream of error messages, due to coordinate transformations being |
---|
| 832 | done in blank regions outside of the acceptable range of world |
---|
| 833 | coordinates. This has been fixed. |
---|
| 834 | |
---|
[542] | 835 | * The function that grows objects had a major bug, that stopped it |
---|
| 836 | working when flagAdjacent=false. This has been fixed and should work |
---|
| 837 | fine. |
---|
| 838 | |
---|
[616] | 839 | * The input parameter spectraTextFile was not being read |
---|
| 840 | properly. This has been remedied. |
---|
| 841 | |
---|
| 842 | * The units for the integrated flux were wrong for some types of pixel |
---|
| 843 | flux units. This has been fixed. |
---|
| 844 | |
---|
| 845 | * A minor bug caused incorrect calculation of the 20% widths. |
---|
| 846 | |
---|
[542] | 847 | * All calls to uint were changed to unsigned int, as some compilers |
---|
| 848 | had problems recognising that they were the same thing. |
---|
| 849 | |
---|
| 850 | * src/fitsHeader.cc was missing an include statement for stdlib.h, |
---|
| 851 | again causing some compilers to fail. |
---|
| 852 | |
---|
| 853 | |
---|
[529] | 854 | Duchamp version 1.1.7 (2009/01/16) |
---|
[520] | 855 | ---------------------------------- |
---|
| 856 | |
---|
| 857 | Improvements: |
---|
| 858 | |
---|
[522] | 859 | * The mask file that can be created with flagMask can now specify |
---|
| 860 | which object a given detected pixel belongs to, by taking the object |
---|
| 861 | ID as its value. This applies if you set flagMaskWithObjectNum=true |
---|
| 862 | (it defaults to false, which means each detected pixel has the value |
---|
| 863 | 1). Non-detected pixels still have the value 0. |
---|
[520] | 864 | |
---|
[535] | 865 | * The names of the output FITS files are now able to be specified |
---|
| 866 | directly by input parameters. These will override the default names |
---|
| 867 | that Duchamp provides. |
---|
| 868 | |
---|
[520] | 869 | * The Karma annotation file now specifies a font - previously it did |
---|
| 870 | not and so was at the mercy of whatever was specified in other |
---|
| 871 | annotation files being viewed at the same time. Please let me know |
---|
| 872 | if the font I've chosen (lucidasans-12) is not suitable. |
---|
| 873 | |
---|
| 874 | * The default flag, used in the absence of 'E', 'S' or 'N', is now '-' |
---|
| 875 | rather than blank. This will ensure that each column in the results |
---|
| 876 | file has something in it. |
---|
| 877 | |
---|
[522] | 878 | * The configure script is somewhat more robust to non-standard |
---|
| 879 | systems, particularly when the X11 libraries are in unusual |
---|
| 880 | places. It can also deal with the slightly different way that |
---|
| 881 | wcslib-4.3 installs itself. |
---|
| 882 | |
---|
[520] | 883 | * The installation part of the Makefile was altered so that the |
---|
| 884 | symbolic link Duchamp that points to Duchamp-1.1.7 does not have the |
---|
| 885 | absolute path encoded in it. This will enable the files to be moved |
---|
| 886 | around at a later date. |
---|
| 887 | |
---|
| 888 | Bug Fixes: |
---|
| 889 | |
---|
| 890 | * Fixed a bug that caused problems when the flux units were less than |
---|
| 891 | 5 characters long (e.g. 'K') |
---|
| 892 | |
---|
| 893 | * The new velocity width values were not getting proper headers in the |
---|
| 894 | VOTable output. This has been remedied. |
---|
| 895 | |
---|
| 896 | * Minor improvements to help non-pgplot use |
---|
| 897 | |
---|
| 898 | * Minor fix in WCS functionality. |
---|
| 899 | |
---|
| 900 | * Minor fixes to the FitsHeader class. |
---|
| 901 | |
---|
| 902 | * Improved FITS data reading, that doesn't require a nullarray |
---|
| 903 | array. This will reduce memory usage. |
---|
| 904 | |
---|
| 905 | * Improved subsection parsing, particularly for non-standard WCS |
---|
| 906 | systems. |
---|
| 907 | |
---|
| 908 | * Improving the memory allocation of the Cube class. |
---|
| 909 | |
---|
| 910 | * Fixed a bug that meant the growthThreshold values were sometimes |
---|
| 911 | being lost. |
---|
| 912 | |
---|
| 913 | * Improving the way the growing and merging is done, particularly in |
---|
| 914 | the case of non-adjacent merging. |
---|
| 915 | |
---|
[529] | 916 | * Fixed a scaling bug in the GaussSmooth function. |
---|
| 917 | |
---|
[520] | 918 | Other: |
---|
| 919 | |
---|
| 920 | * Numerous changes to the code that do not affect how Duchamp itself |
---|
| 921 | runs, but were necessary for code development with the Duchamp |
---|
| 922 | libraries (primarily as a part of the ASKAP code development). |
---|
| 923 | |
---|
[522] | 924 | |
---|
[482] | 925 | Duchamp version 1.1.6 (2008/09/08) |
---|
[480] | 926 | ---------------------------------- |
---|
| 927 | |
---|
| 928 | New features: |
---|
| 929 | |
---|
| 930 | * The velocity widths can now be quoted in two additional ways: the |
---|
| 931 | full width at 50% of the peak flux (ie. the FWHM) and the full width |
---|
| 932 | at 20% of the peak flux (w_50 and w_20 respectively). The w_50 |
---|
| 933 | parameter is now quoted in the results printed to the screen |
---|
| 934 | (instead of w_VEL), but all three are written to the results file. |
---|
| 935 | |
---|
| 936 | * The facility now exists to bypass the searching step and go straight |
---|
| 937 | to the output stage using a list of previously detected objects. The |
---|
| 938 | list is extracted from a previously-created log file. The user can |
---|
| 939 | change the way the spectra are plotted (e.g. choose to plot |
---|
| 940 | integrated rather than peak spectra), and select a subset of the |
---|
| 941 | detected objects to be printed to individual postscript files. Use |
---|
| 942 | the input parameter usePrevious (set to true) to use this facility, |
---|
| 943 | and provide a list of objects using the objectList parameter |
---|
| 944 | (eg. 1,2,4,7-10,15) |
---|
| 945 | |
---|
[482] | 946 | * A new parameter "growthThreshold" has been created, that goes with |
---|
| 947 | "threshold". If you manually specify a threshold, and you wish to |
---|
| 948 | grow detections, you need to manually specify a growthThreshold (in |
---|
| 949 | flux units). |
---|
| 950 | |
---|
[480] | 951 | Bug fixes: |
---|
| 952 | |
---|
[482] | 953 | * Cubes that do not have a spectral axis (such as Stokes cubes) were |
---|
| 954 | causing memory leaks and crashing, due to some assumptions of the |
---|
| 955 | existence of the spectral axis. These bugs have been fixed, so that |
---|
| 956 | Duchamp will run on such cubes, although the WCS transforms may not |
---|
| 957 | always work appropriately. Please let me know via bug reports of |
---|
| 958 | difficulties you encounter! |
---|
[480] | 959 | |
---|
[482] | 960 | * The growing function has had a few bugs fixed and is now more |
---|
| 961 | efficient. |
---|
| 962 | |
---|
| 963 | * The FDR method was previously overriding any manually-specified |
---|
| 964 | threshold. This has been fixed so that if the user specifies |
---|
| 965 | threshold=X, then the FDR method is not called. |
---|
| 966 | |
---|
| 967 | * Some undefined things were happening with textual output when no |
---|
| 968 | objects were detected. This has been fixed. |
---|
| 969 | |
---|
| 970 | * Memory leaks caused by FITS WCS irregularities have been fixed |
---|
| 971 | (specifically, if a FITS header had NAXIS=2 but more than two WCS |
---|
| 972 | axes were defined). |
---|
| 973 | |
---|
| 974 | |
---|
| 975 | |
---|
[438] | 976 | Duchamp version 1.1.5 (2008/03/20) |
---|
| 977 | ---------------------------------- |
---|
| 978 | |
---|
| 979 | Bug fixes: |
---|
| 980 | * A major bug was discovered in the calculation of integrated |
---|
| 981 | fluxes. The flux was incorrectly being weighted by the spatial size |
---|
| 982 | of the detection, resulting in a (often considerable) overestimation |
---|
[447] | 983 | of the integrated flux. This has been corrected. |
---|
[438] | 984 | |
---|
[447] | 985 | * The beam size calculation was also incorrect, being out by a factor |
---|
| 986 | of 1/ln(2). |
---|
[438] | 987 | |
---|
[447] | 988 | * The "make install" command previously failed to work properly if the |
---|
| 989 | library had not been created. This has been fixed so that the |
---|
| 990 | installation works even if there is no library file. |
---|
| 991 | |
---|
| 992 | New Features: |
---|
| 993 | * You can now provide a new flux unit string, so that the pixel fluxes |
---|
| 994 | will be converted to these new fluxes before any calculations are |
---|
| 995 | done. This is done with the newFluxUnits input parameter. The new |
---|
| 996 | units should be directly convertible from the old ones (given by the |
---|
| 997 | BUNIT header -- e.g. if BUNIT = Jy/beam, you can give newFluxUnits |
---|
| 998 | as mJy/beam, but not mJy). |
---|
| 999 | |
---|
| 1000 | * You can now specify the precision used in the output files for flux, |
---|
| 1001 | velocity and S/N ratio columns, via new input parameters precFlux, |
---|
| 1002 | precVel and precSNR. These will apply to the VOTable output as well |
---|
| 1003 | as the text table and information on the spectral plots. |
---|
| 1004 | |
---|
| 1005 | * The Karma annotation files previously provided just a circle at the |
---|
| 1006 | spatial location of the detected object. You now have the option to |
---|
| 1007 | draw a border around the detected pixels (in a similar manner to the |
---|
| 1008 | PGPLOT moment maps). Karma does not do this perfectly, so the lines |
---|
| 1009 | may not line up exactly with the pixel borders, so the option |
---|
| 1010 | remains to keep using the circles. This is controlled by the |
---|
| 1011 | parameter "annotationType", with possible options being "borders" |
---|
| 1012 | (the default) or "circles". |
---|
| 1013 | |
---|
| 1014 | * There is a new function getMetadata() that loads the header and WCS |
---|
| 1015 | data, but no pixel information. This is only of interest if you are |
---|
| 1016 | doing code development with the Duchamp library -- it does not |
---|
| 1017 | affect the running of Duchamp itself. |
---|
| 1018 | |
---|
[425] | 1019 | Duchamp version 1.1.4 (2008/02/15) |
---|
| 1020 | ---------------------------------- |
---|
| 1021 | |
---|
| 1022 | Most of the changes incorporated in this update result from ASKAP code |
---|
| 1023 | development (that makes use of some of the Duchamp functionality), |
---|
| 1024 | but do not actually affect the way Duchamp runs (other than, in a |
---|
| 1025 | couple of cases, making it a bit faster). Changes that are |
---|
| 1026 | relevant for regular users of Duchamp are as follows: |
---|
| 1027 | |
---|
| 1028 | * A new option has been made available (thanks to Mary Putman et al |
---|
| 1029 | for the suggestion!) to save the spectra of all detected objects in |
---|
| 1030 | a text file. This has the form of one column for the spectral |
---|
| 1031 | coordinates and one column of fluxes for each object. This is |
---|
| 1032 | enabled by the input parameters flagTextSpectra and spectraTextFile. |
---|
| 1033 | |
---|
| 1034 | * Slight changes to the output include he formatting of the way the |
---|
| 1035 | detected objects are written to the log file. This meant the |
---|
| 1036 | verification files were also updated. Also the cube statistics are |
---|
| 1037 | not printed to the results file if a user threshold is specified (as |
---|
| 1038 | they are not calculated!). |
---|
| 1039 | |
---|
| 1040 | * The determination of beam size has been made more reliable, as has |
---|
| 1041 | the BUNIT determination. |
---|
| 1042 | |
---|
| 1043 | * Fixed a bug that meant source merging was not done for 2D images |
---|
| 1044 | (not usually a problem, as the source-finding takes care of this, |
---|
| 1045 | but came up in parallelisation development). |
---|
| 1046 | |
---|
[406] | 1047 | Duchamp version 1.1.3 (2008/01/08) |
---|
| 1048 | ---------------------------------- |
---|
[404] | 1049 | |
---|
| 1050 | A minor update that just improves the build process. The location of |
---|
| 1051 | the wcslib include files was not specified correctly, so that some |
---|
| 1052 | machines were unable to find them. The configure script has been fixed |
---|
| 1053 | so that the compilation should work in all cases. |
---|
| 1054 | |
---|
[405] | 1055 | Some minor changes have also been made to the code in the PixelMap |
---|
[412] | 1056 | directory, and to param.cc, to fix warnings or errors that may appear |
---|
| 1057 | in compilation. |
---|
[404] | 1058 | |
---|
[405] | 1059 | However, there are no changes to the actual workings of the code in |
---|
| 1060 | this minor version, so if you have a working version of Duchamp 1.1.2 |
---|
| 1061 | there is probably no reason to update. |
---|
| 1062 | |
---|
[389] | 1063 | Duchamp version 1.1.2 (2007/12/07) |
---|
| 1064 | ---------------------------------- |
---|
[349] | 1065 | |
---|
[363] | 1066 | Compilation: |
---|
| 1067 | |
---|
[349] | 1068 | * The compilation had problems working correctly when the cfitsio and |
---|
[373] | 1069 | wcs libraries were not in standard locations. The configure script |
---|
[349] | 1070 | has been tweaked to make sure the libraries are found. |
---|
| 1071 | |
---|
| 1072 | * Problems with compiling in the absence of pgplot have been fixed, |
---|
| 1073 | and it should now compile fine. |
---|
| 1074 | |
---|
[362] | 1075 | * Improved the configure script for use with Mac OS X and gfortran. |
---|
[349] | 1076 | |
---|
[363] | 1077 | |
---|
| 1078 | Bugfixing: |
---|
| 1079 | |
---|
[362] | 1080 | * A major problem with the text-based output was fixed. The widths of |
---|
| 1081 | the columns were not being calculated correctly, and were running |
---|
[373] | 1082 | together. This should no longer be the case. |
---|
[349] | 1083 | |
---|
[374] | 1084 | * There was a bug in the way Duchamp interpreted spectral axes, |
---|
| 1085 | particularly AIPS types such as FELO-HEL, leading to incorrect |
---|
| 1086 | scaling of the velocity axis. This has been fixed, so that |
---|
| 1087 | non-standard types are now dealt with appropriately and the velocity |
---|
| 1088 | scaling should be accurate. |
---|
[362] | 1089 | |
---|
[376] | 1090 | * Another bug meant the beam correction was always applied to the |
---|
| 1091 | integrated spectra, regardless of whether the flux units involved |
---|
| 1092 | the beam (e.g. Jy/beam). This has been fixed. Note that the values |
---|
| 1093 | of the integrated flux presented in the results table were always |
---|
| 1094 | calculated correctly. |
---|
| 1095 | |
---|
[389] | 1096 | * Other minor changes to improve the speed and efficiency, especially |
---|
| 1097 | of the merging code. |
---|
| 1098 | |
---|
[363] | 1099 | New user parameters: |
---|
| 1100 | |
---|
[381] | 1101 | * There is now the possibility to save a FITS file that contains a |
---|
| 1102 | mask array, indicating where the detected objects are. This is |
---|
| 1103 | governed by the flagOutputMask parameter. |
---|
| 1104 | |
---|
[363] | 1105 | * The header information that is printed at the start of the results |
---|
| 1106 | file -- that is, the list of parameters, the statistics of the cube, |
---|
| 1107 | and the number of detections -- can now be written to a separate |
---|
| 1108 | file. Set the flagSeparateHeader parameter to true or 1 and it will |
---|
| 1109 | go to the file indicated by the headerFile parameter (the default is |
---|
| 1110 | duchamp-Results.hdr). |
---|
| 1111 | |
---|
[362] | 1112 | * A "scaleMax" parameter has been added, so that the wavelet |
---|
| 1113 | reconstruction can include only a specified range of scales (for |
---|
[373] | 1114 | instance, if one wants to search just for narrow features such as |
---|
[362] | 1115 | absorption lines). |
---|
| 1116 | |
---|
[389] | 1117 | * A "flagRobustStats" parameter has been added. This allows the user |
---|
| 1118 | to elect to use robust statistics (median and median absolute |
---|
| 1119 | deviation from the median) to estimate the noise parameters. If set |
---|
| 1120 | to false, the mean and standard deviation will be used. The default |
---|
| 1121 | value is true. |
---|
[362] | 1122 | |
---|
[369] | 1123 | New Feature: |
---|
[362] | 1124 | |
---|
[369] | 1125 | * When Duchamp is run on a 2D image (i.e. with no spectral output), it |
---|
| 1126 | now produces a postscript file that shows information each |
---|
| 1127 | individual source plus the image cutout of the source. This is |
---|
| 1128 | similar to the spectral output file, but without the spectra. The |
---|
| 1129 | filename is given by the spectraFile parameter. |
---|
| 1130 | |
---|
[381] | 1131 | * Ability to save a FITS file containing a mask array, with pixel |
---|
| 1132 | values of 1 for pixels in a detected object, and 0 elsewhere. |
---|
[369] | 1133 | |
---|
[381] | 1134 | |
---|
[328] | 1135 | Duchamp version 1.1.1 (2007/07/20) |
---|
| 1136 | ------------------------------------ |
---|
| 1137 | |
---|
[329] | 1138 | Minor update to the release, with just a few changes: |
---|
[328] | 1139 | |
---|
| 1140 | * The verification script was generating diffs due to differences in |
---|
| 1141 | the precision of some calculations when done on different machines. |
---|
| 1142 | One of these was the integrated flux, and this has been corrected so |
---|
| 1143 | that the same value should appear on all machines. |
---|
| 1144 | The verification script has also changed so that just the number of |
---|
| 1145 | sources and their positions are tested, as well as the |
---|
| 1146 | logfiles. This should avoid the reporting of spurious differences. |
---|
| 1147 | |
---|
| 1148 | * The grey-scale used in the image cutouts (in the spectral plots) has |
---|
| 1149 | been inverted. This makes it consistent with the scale used in the |
---|
| 1150 | maps, and hopefully easier to see when printing. |
---|
| 1151 | |
---|
[338] | 1152 | * The configure/make system has been altered to make it easier to |
---|
| 1153 | install, and to specify different external libraries. In particular, |
---|
| 1154 | it is now not necessary to have PGPLOT installed on your system to |
---|
| 1155 | run Duchamp. In the absence of PGPLOT, Duchamp will run as normal, |
---|
| 1156 | just without any graphical output. Some source code needed to be |
---|
[344] | 1157 | restructured to make this work. Please read the README file, or the |
---|
| 1158 | Installation appendix in the User's Guide, for complete details. |
---|
[328] | 1159 | |
---|
[329] | 1160 | * The time of completion is now written to the log file, so that the |
---|
| 1161 | user can have some idea of how long the program took. |
---|
[328] | 1162 | |
---|
| 1163 | |
---|
[310] | 1164 | Duchamp version 1.1 (2007/05/17) |
---|
[259] | 1165 | ------------------------------------ |
---|
| 1166 | |
---|
| 1167 | Changes made since the last numbered release: |
---|
| 1168 | |
---|
[295] | 1169 | EFFICIENCY OF EXECUTION: |
---|
| 1170 | |
---|
[259] | 1171 | * Major change to the way detections are stored. They are now recorded |
---|
| 1172 | via run-length encoding in the x-y plane, and stored as collections |
---|
| 1173 | of channel-maps. This improves the memory usage and the speed of |
---|
[298] | 1174 | execution (particularly for routines such as the merging |
---|
| 1175 | routines). The memory usage has also been improved by changing the |
---|
| 1176 | way the list of detected objects is stored. |
---|
[259] | 1177 | |
---|
[295] | 1178 | SMOOTHING: |
---|
| 1179 | |
---|
[279] | 1180 | * Addition of ability to spatially smooth the cube before |
---|
| 1181 | searching. This is done with a Gaussian kernel, the size and shape |
---|
[287] | 1182 | of which can be specified by the user, using the parameters kernMaj |
---|
| 1183 | & kernMin (which are the FWHM for the major & minor axes -- if |
---|
| 1184 | kernMin is not given it is assumed to match kernMaj) and kernPA (the |
---|
| 1185 | position angle of the major axis). There is a new parameter |
---|
[279] | 1186 | smoothType that distinguishes this method from the spectral (Hanning) |
---|
| 1187 | smoothing already in use. |
---|
| 1188 | |
---|
[295] | 1189 | DETECTIONS: |
---|
| 1190 | |
---|
[264] | 1191 | * Changed the way detection is done -- now only search in 2D images, |
---|
| 1192 | keeping all detections (ie. no minimum-pixel requirement). This |
---|
| 1193 | should be the same as doing both the 1D and 2D searches with the |
---|
| 1194 | minimum pixel requirement in, but simpler. The rejection is done at |
---|
[295] | 1195 | the end after all the merging and growing has been done. This leads |
---|
| 1196 | to a larger number of intermediate detections (ie. the number |
---|
| 1197 | before merging), which may increase the run-time slightly, although |
---|
| 1198 | this is offset by the changes to the efficiency (see above). |
---|
[264] | 1199 | |
---|
| 1200 | * Increased the range over which objects can be grown to match the |
---|
| 1201 | threshSpatial & threshVelocity parameters, as well as rejecting new |
---|
| 1202 | pixels based on the BLANK and MW tests. |
---|
| 1203 | |
---|
[295] | 1204 | INPUTS: |
---|
[259] | 1205 | |
---|
[287] | 1206 | * There has been a subtle change in the way BLANK pixels are dealt |
---|
| 1207 | with. To enable trimming of BLANK pixels, users should use the new |
---|
| 1208 | parameter flagTrim. The parameters flagBlankPix and blankPixVal are |
---|
[295] | 1209 | no longer accessible via the parameter file -- warning messages are |
---|
| 1210 | given if they are provided in the parameter file. |
---|
[287] | 1211 | |
---|
[295] | 1212 | * Added ability to specify a statsec, so that the statistics are only |
---|
| 1213 | calculated from a given subsection of the cube, rather than the full |
---|
| 1214 | cube. |
---|
| 1215 | |
---|
| 1216 | * The subsections can also specify the ability to remove a border of n |
---|
| 1217 | pixels from the edges of an axis (ie. n from the start and from the |
---|
| 1218 | end) -- as requested in Trac ticket #5. |
---|
| 1219 | |
---|
| 1220 | * Changed the default value of the reconDim parameter from 3 to 1, and |
---|
| 1221 | the default value of the flagATrous parameter to false. |
---|
| 1222 | |
---|
| 1223 | OUTPUTS: |
---|
| 1224 | |
---|
[279] | 1225 | * The output now includes three different estimates of the "centre" of |
---|
| 1226 | the detection: peak location, centroid (flux-weighted), or average. |
---|
| 1227 | |
---|
[295] | 1228 | * Some slight improvements to the user feedback during execution. |
---|
| 1229 | |
---|
[282] | 1230 | * Spectral output now includes the baseline, if one was fitted. The |
---|
| 1231 | format of the plot headers is slightly changed, to stop information |
---|
| 1232 | falling off the edge of the page. |
---|
[279] | 1233 | |
---|
[295] | 1234 | * Added command-line option -x to directly disable the PGPLOT X-window |
---|
| 1235 | map plotting. This overrides the setting of flagXOutput in the |
---|
| 1236 | parameter file. |
---|
[259] | 1237 | |
---|
[295] | 1238 | * Fallback spectral units (in case the FITS header fails to record |
---|
| 1239 | them) changed to SPC, but code has been fixed so that any problem |
---|
| 1240 | should be caught before this becomes an issue. |
---|
| 1241 | |
---|
| 1242 | BUGFIXES: |
---|
| 1243 | |
---|
[259] | 1244 | * Fixed bug (Trac ticket #4) that meant the velocity units were not |
---|
| 1245 | correctly dealt with. Duchamp should be more robust for different |
---|
| 1246 | velocity axis setups now. |
---|
| 1247 | |
---|
| 1248 | * Fixed bug (ticket #9) with the VOTable output, where the tags were |
---|
| 1249 | not closing. |
---|
| 1250 | |
---|
[305] | 1251 | * Fixed a bug that meant the integrated fluxes were not calculated |
---|
| 1252 | properly -- no allowance was made for the number of spatial |
---|
| 1253 | pixels. This should also work properly for 2D images now as well. |
---|
| 1254 | |
---|
[264] | 1255 | * Fixed minor bug in calculating the flux threshold from the p-value |
---|
| 1256 | threshold when the FDR method is used. This did not affect the |
---|
| 1257 | actual thresholding, merely the quoted flux threshold in the results |
---|
| 1258 | file. Also, the MW channels are kept out of the p-value threshold |
---|
| 1259 | determination if they are being flagged. |
---|
| 1260 | |
---|
[259] | 1261 | |
---|
| 1262 | |
---|
[211] | 1263 | Duchamp version 1.0.7 (2006/11/22) |
---|
| 1264 | ---------------------------------- |
---|
| 1265 | |
---|
| 1266 | One new feature, and some improvements and bug-fixes. |
---|
| 1267 | |
---|
[264] | 1268 | * The user can now elect to Hanning-smooth the spectral direction of |
---|
| 1269 | the cube before the searching is done. This can be done instead of the |
---|
| 1270 | wavelet reconstruction (although if both are selected, the |
---|
| 1271 | reconstruction takes precendence). This functionality is switched on |
---|
| 1272 | and off by the flagSmooth parameter, and the width of the Hanning |
---|
| 1273 | kernel is governed by the hanningWidth parameter. |
---|
[211] | 1274 | |
---|
[264] | 1275 | * The smoothed array can also be written to a FITS file and read in at |
---|
| 1276 | the start in the same manner as the reconstructed array. |
---|
[211] | 1277 | |
---|
[264] | 1278 | * Several improvements have been made to the memory |
---|
| 1279 | management. Several memory leaks were fixed, and the memory usage of |
---|
| 1280 | Duchamp is considerably less, which will be a help for running it on |
---|
| 1281 | large cubes. The speed of some routines has also been improved, by |
---|
| 1282 | removing unnecessarily repetitive loops. |
---|
[211] | 1283 | |
---|
[287] | 1284 | * The sorting routines have been changed, and should now be slightly quicker |
---|
[215] | 1285 | (and a bit more robust). |
---|
| 1286 | |
---|
[287] | 1287 | * Enabled the scale bar (plotted on the 0th moment map in the spectral |
---|
| 1288 | output file) to be able to deal with much finer spatial scales (as |
---|
| 1289 | may be expected from VLBI data). |
---|
[211] | 1290 | |
---|
[215] | 1291 | * Other minor changes to code and presentation. |
---|
[211] | 1292 | |
---|
| 1293 | |
---|
[194] | 1294 | Duchamp version 1.0.6 (2006/11/01) |
---|
| 1295 | ---------------------------------- |
---|
| 1296 | |
---|
| 1297 | Some incremental improvements and changes to the code: |
---|
| 1298 | |
---|
| 1299 | * The statistics used for the detection are now calculated once for |
---|
| 1300 | the entire cube, rather than being calculated separately for each |
---|
| 1301 | channel map and spectrum. This results in a uniform threshold value |
---|
| 1302 | across the entire cube. The way the statistics calculations are |
---|
| 1303 | implemented in the code was changed, using a new statistics class. |
---|
| 1304 | |
---|
| 1305 | * This means we can report a peak signal-to-noise value for each |
---|
| 1306 | detection. This is given in the text-based output, as well as in the |
---|
| 1307 | summary information above the spectral output for each source. |
---|
| 1308 | |
---|
[195] | 1309 | * The user can now elect not to have the moment map displayed in a |
---|
| 1310 | PGPlot window, through the use of the new flagXOutput |
---|
| 1311 | parameter. This should help in cases of running Duchamp on a dumb |
---|
| 1312 | terminal (with no X-display capabilities), or as part of a batch |
---|
| 1313 | script where the continual popping-up of the PGPlot window might |
---|
| 1314 | become annoying. |
---|
| 1315 | |
---|
[265] | 1316 | * There are different Flags reported for the case of an object lying on |
---|
[194] | 1317 | the spatial edge and spectral edge of the cube (E and S respectively). |
---|
| 1318 | |
---|
| 1319 | * A few minor bug fixes: |
---|
| 1320 | - When providing a subsection, any axes with the range given by * |
---|
| 1321 | had the pixel values offset incorrectly. This has been fixed. |
---|
| 1322 | - Negative searches now correctly invert the reconstructed array |
---|
| 1323 | when it is read in from a file. |
---|
| 1324 | |
---|
| 1325 | * Other minor changes to the code, to improve memory handling and |
---|
| 1326 | remove redundant arrays and variables. |
---|
| 1327 | |
---|
| 1328 | |
---|
[146] | 1329 | Duchamp version 1.0.5 (2006/09/06) |
---|
[142] | 1330 | ---------------------------------- |
---|
| 1331 | |
---|
[146] | 1332 | Since version 1.0, there have been a range of mostly minor |
---|
| 1333 | changes. These are generally bug-fixes, thanks to feedback from a |
---|
[157] | 1334 | number of users, as well as a few extra features. |
---|
[146] | 1335 | |
---|
[157] | 1336 | Here is a summary of the changes since version 1.0: |
---|
[142] | 1337 | |
---|
[157] | 1338 | USER INTERFACE: |
---|
[146] | 1339 | |
---|
[142] | 1340 | * The user is now able to enter the value of flag parameters in the |
---|
| 1341 | parameter file as strings, as well as integers (so one can enter |
---|
| 1342 | true or 1 to give the same result). |
---|
| 1343 | |
---|
[157] | 1344 | GRAPHICAL OUTPUT: |
---|
| 1345 | |
---|
[142] | 1346 | * Added a new function that draws the edge of the blank region on the |
---|
[146] | 1347 | maps and image cutouts. There is a new flag parameter -- |
---|
| 1348 | drawBlankEdges -- that controls the use of this function (the |
---|
| 1349 | default is true). |
---|
| 1350 | Also, the edge of the field is plotted on the image cutouts as a |
---|
| 1351 | yellow line. This distinguishes it from the purple blank pixel |
---|
| 1352 | dividing line. |
---|
[142] | 1353 | |
---|
[146] | 1354 | * The size of the tick mark in the image cutout (indicating the |
---|
| 1355 | spatial scale of the image) is now adaptable, so that it shows the |
---|
| 1356 | scale that best fits the image (ranging from 1 arcsec to 15 |
---|
| 1357 | degrees). (This is a change from the previous standard length of 15 |
---|
| 1358 | arcmin.) |
---|
[142] | 1359 | |
---|
[113] | 1360 | * The zoomed spectrum had its flux scale determined by all points in |
---|
[146] | 1361 | the zoom box,including those flagged by the Milky Way (MW) |
---|
| 1362 | range. This has been fixed so that any MW channels will not affect |
---|
| 1363 | the flux scaling, potentially improving the appearance of objects |
---|
| 1364 | detected close in velocity to strong MW emission or absorption. |
---|
[112] | 1365 | |
---|
[157] | 1366 | * Improved Karma Annotation file output, so that files without good |
---|
| 1367 | WCS are dealt with appropriately. |
---|
| 1368 | |
---|
| 1369 | TEXT-BASED OUTPUT: |
---|
| 1370 | |
---|
[113] | 1371 | * The position resolution in the IAU-format names has been increased, |
---|
| 1372 | so that distinct objects close to one another are more readily |
---|
| 1373 | distinguished. Overlapping sources at different velocities may |
---|
| 1374 | still have the same name, but this is a more general problem. |
---|
[112] | 1375 | |
---|
[146] | 1376 | * The presentation of the results in tabular format has been improved, |
---|
| 1377 | so that the precision of faint sources is sufficient to show their |
---|
| 1378 | flux, for instance, is not 0. This also applies to the information |
---|
| 1379 | presented above the spectral plots. |
---|
[112] | 1380 | |
---|
[146] | 1381 | * Improved error and warning reporting, so that the formatting and |
---|
| 1382 | presentation of information is clearer. |
---|
| 1383 | |
---|
[157] | 1384 | FITS I/O RELATED: |
---|
| 1385 | |
---|
[172] | 1386 | * The previous version was did not deal well with 4 (or greater) |
---|
| 1387 | dimensions in the FITS file -- the memory allocation was badly done, |
---|
| 1388 | and the axes needed to be in a particular order. This has been |
---|
| 1389 | fixed, so that the FITS I/O routines can now handle any sized FITS |
---|
| 1390 | file, with axes in any order (as long as there are two spatial and one |
---|
| 1391 | spectral axes). |
---|
[157] | 1392 | |
---|
| 1393 | * When the FITS file does not have a rest frequency defined, there is |
---|
| 1394 | no way to transform the frequency axis into velocity. In this case, |
---|
| 1395 | the spectral axis is left as frequency, and put into units of MHz. |
---|
| 1396 | |
---|
[172] | 1397 | * If the beam size is not indicated by the FITS header (through the |
---|
| 1398 | BMAJ and BMIN keywords), the user can manually specify the size |
---|
| 1399 | through the parameter file (using parameter beamSize). |
---|
| 1400 | |
---|
| 1401 | * The FITS I/O routines make use of the command fits_file_exists. This |
---|
| 1402 | was introduced into the CFITSIO package from version 2.5, so Duchamp |
---|
| 1403 | will only work with this version or higher. Version 3+ is preferred. |
---|
| 1404 | |
---|
[157] | 1405 | OTHER BUG-FIXING: |
---|
| 1406 | |
---|
| 1407 | * Several bugs related to the blank-pixels were dealt with. |
---|
| 1408 | The correct values were not propagating through correctly, meaning |
---|
| 1409 | that the default values were being used. Also, there was the |
---|
| 1410 | potential for blank pixels to be detected when the FDR method was |
---|
| 1411 | used. Finally, the image cutout displays occasionally did not |
---|
| 1412 | obscure the blank pixels. All these problems should be fixed now. |
---|
| 1413 | |
---|
| 1414 | * The FDR setup routine was occasionally failing with a segmentation |
---|
| 1415 | fault, due to it accessing unallocated memory. This has been fixed. |
---|
| 1416 | |
---|
| 1417 | * Fixed bugs that affected the way 2D images (rather than 3D cubes) |
---|
| 1418 | were dealt with. The minChannels test failed when minChannels=0. |
---|
| 1419 | |
---|
[165] | 1420 | * If there is no beam information in the FITS header, the user can now |
---|
| 1421 | enter a beam size as a parameter. |
---|
| 1422 | |
---|
[146] | 1423 | * Other minor fixes to the code, to improve its structure and |
---|
| 1424 | robustness. |
---|
| 1425 | |
---|
| 1426 | |
---|
[112] | 1427 | Duchamp version 1.0 (2006/06/30) |
---|
| 1428 | -------------------------------- |
---|
| 1429 | |
---|
[113] | 1430 | The first full release version. |
---|
| 1431 | |
---|
| 1432 | Several major changes compared to previous version: |
---|
| 1433 | |
---|
| 1434 | * Incorporated a FitsHeader class, to keep track of header information |
---|
| 1435 | (including WCS) from the FITS file. All units-related calculations |
---|
| 1436 | are done with this class, such as conversion to velocity, and |
---|
| 1437 | pixel-to-WCS conversion. The main advantage of this is improved |
---|
| 1438 | speed of execution, more adaptable to different units, and improved |
---|
| 1439 | code (easier for me!). |
---|
| 1440 | |
---|
| 1441 | * Able to select the dimensionality of the reconstruction, rather than |
---|
| 1442 | just doing it in 3-D. |
---|
| 1443 | |
---|
| 1444 | * Robust text output, so that the columns are sized correctly given |
---|
| 1445 | the data being written, and the relevant units (derived from the |
---|
| 1446 | FITS header) are included in the output table. |
---|
| 1447 | |
---|
| 1448 | * Improved the way the reconstructed image is saved and read back in, |
---|
| 1449 | with a better naming scheme and a better set of new FITS header |
---|
| 1450 | keywords. The MW headers are now not written. |
---|
| 1451 | |
---|
| 1452 | Other, more minor changes include: |
---|
| 1453 | |
---|
| 1454 | * MW channels now not set to 0, but just ignored for searching |
---|
| 1455 | purposes (and for the scaling of the spectral output -- they are |
---|
| 1456 | plotted though and highlighted with a hashed box). |
---|
| 1457 | |
---|
| 1458 | * The scale bar in the moment map in the spectral output file has its |
---|
| 1459 | length indicated. |
---|
| 1460 | |
---|
| 1461 | * Improved VOTable output, with more information about the way Duchamp |
---|
| 1462 | was run. |
---|
| 1463 | |
---|
| 1464 | * Made sure all statistics calculations in the reconstruction are |
---|
| 1465 | based on robust (ie. median) methods. |
---|
| 1466 | |
---|
| 1467 | Also moved to an autoconf based configure/make compilation, for ease of use. |
---|
| 1468 | |
---|
| 1469 | |
---|
| 1470 | Duchamp version 0.9.2 (2006/06/27) |
---|
| 1471 | -------------------------------- |
---|
| 1472 | |
---|
| 1473 | * Added the use of warning flags for detections: for either edge |
---|
| 1474 | location or negative enclosed flux. |
---|
| 1475 | |
---|
| 1476 | * A new command line option added so that the user can specify a FITS |
---|
| 1477 | file to be searched with the default parameters, rather than giving |
---|
| 1478 | a full parameter file. |
---|
| 1479 | |
---|
| 1480 | * The scale bar on the moment cutout now works in general case, using |
---|
| 1481 | an iterative process to get to the correct length. |
---|
| 1482 | |
---|
| 1483 | * RA axes are now done correctly on the full-scale maps. |
---|
| 1484 | |
---|
| 1485 | * Various coding fixes, improving the readability of the code, |
---|
| 1486 | particularly regarding the declaration of temporary variables. |
---|
| 1487 | |
---|
| 1488 | * Changed the way the time of execution is called : now using time.h |
---|
| 1489 | functions, rather than a system call. |
---|
| 1490 | |
---|
| 1491 | * Changed output in Detection/outputDetection.cc for the pixel |
---|
| 1492 | information of detected objects (the info printed above the spectral |
---|
| 1493 | plots) -- now print out number of voxels in object, and have |
---|
| 1494 | improved the formatting a little. |
---|
| 1495 | |
---|
| 1496 | * Improved the functionality of saving the FITS file containing the |
---|
| 1497 | reconstructed array. Added ability to save and read back in the MW |
---|
| 1498 | parameters when saving a reconstructed cube (if a reconstructed cube |
---|
| 1499 | has different MW range to that being considered, it would cause |
---|
| 1500 | problems). ReadRecon now just returns a FAILURE and will reconstruct |
---|
| 1501 | the cube anew. |
---|
| 1502 | |
---|
| 1503 | * Changed default value of flagGrowth to 0. |
---|
| 1504 | |
---|
| 1505 | |
---|
| 1506 | |
---|
| 1507 | Duchamp version 0.9 (2006/05/05) |
---|
| 1508 | -------------------------------- |
---|
| 1509 | |
---|
| 1510 | First public release version. |
---|