source: trunk/CHANGES @ 1377

Last change on this file since 1377 was 1376, checked in by MatthewWhiting, 10 years ago

A few more updates to CHANGES to reflect the new files in this release.

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