source: trunk/CHANGES @ 761

Last change on this file since 761 was 761, checked in by MatthewWhiting, 14 years ago

Minor change.

File size: 35.7 KB
Line 
1Duchamp version 1.1.10 (2010/11/15)
2-------------------------------------
3
4Improvements:
5
6* The major change for this release is a greatly improved growing
7  algorithm. The previous incarnation was very inefficient (testing
8  all pixels in an object, most of which only have neighbours that are
9  already in the object), and could take an unnecessarily large amount
10  of time in the case of extended sources. The improved algorithm
11  makes use of voxel flags to quickly identify those voxels not yet in
12  an object and only examines them. For a certain test case
13  (observations of extended Galactic HI), the time required reduced
14  from about a day to about a minute! (Note that compact sources, such
15  as HI galaxies, will not show this degree of speedup...) Many thanks
16  to Tara Murphy for pointing out this bug and her help in
17  diagnosing/fixing the problem.
18
19* There have been a number of further improvements to the code to
20  speed it up, based on some profiling. The most important was the
21  function to add pixels to a 2D object, but there were several other
22  minor changes as well.
23
24* The minimum size of the detections can now also be specified in
25  terms of the total number of voxels (in addition or instead of
26  specifying the minimum spatial pixels or channels).
27
28* The way memory is allocated when reading the image has been
29  streamlined. The amount of memory being allocated is also now
30  reported - this is in an effort to allow users to identify problems
31  with running out of memory.
32
33* The version number is now reported in the results and log files.
34
35* Only the filename of the input image (ie. not the leading
36  directories) is now shown on the detection and moment-0 maps. This
37  is to avoid problems with large directory paths being too wide for
38  the plot.
39
40* The verification script was improved for readability (although no
41  functional change was made).
42
43Bug fixes:
44
45* Growing was not being done when a single source was found. Now
46  fixed.
47
48* For particular WCS setups, the RA can be interpreted as being
49  negative, which corrupted the Source ID (ie. the IAU-format
50  string). This has been fixed.
51
52* When the flux units were changed, problems had been seen when
53  writing a reconstructed cube to a FITS file. Any unit change is now
54  undone prior to writing and there should now be no problem.
55
56* Filenames with spaces in them were not handled well. New functions
57  were included and moved to a more obvious location. These filenames
58  now work as expected.
59
60* Spectral axes of type FREQ that had a rest frequency were not being
61  put into velocity units. Now fixed.
62
63* Improvements to the output to screen, making sure everything is
64  covered by the verbose flag.
65
66* Better management of the allocation of arrays.
67
68* The minSize parameter in Image was never initialised, leading to
69  unpredictable behaviour. Now fixed.
70
71Code development notes:
72
73* New functionality includes: a function to return a vector list of
74  voxels in an Object3D or Detection; a new generic Search function
75  (basically a front-end to each of the individual functions); more
76  complete copy constructors for the DataArray classes;
77
78Duchamp version 1.1.9 (2010/03/26)
79-------------------------------------
80
81Improvements:
82
83* There is now the ability to save the moment-0 map as a FITS
84  file. This is controlled by the parameters flagOutputMomentMap and
85  fileOutputMomentMap, which work in the same way for the mask file.
86
87* There is a new parameter flagRejectBeforeMerge that, when true,
88  rejects sources according to the minPix/minChannels requirements
89  before the merging and growing is done. This defaults to false (so
90  default behaviour is as before). Thanks to Tobias Westmeier for
91  suggesting this and the above improvement.
92
93* There is also a new parameter flagTwoStageMerging. When true (the
94  default), newly-detected objects are merged with the first close
95  object in the list. When false, they are simply added to the end of
96  the list. In both cases, a second round of merging is done to pick
97  up all close matches.
98
99* The way the beam is specified in the absence of the BMAJ/BMIN/BPA
100  parameters has been slightly changed. The use of "beamSize" was
101  somewhat ambiguous (it meant the number of pixels covered by the
102  beam, not the FWHM), so new parameters have been introduced. The
103  beam can be specified by beamArea (which replaces beamSize), or
104  beamFWHM (the FWHM of the beam in pixels). If beamFWHM is provided,
105  it will be used, else the beamArea will be.
106
107* There is a new parameter searchType that allows the user to choose
108  how the searching is done. The behaviour up till now has been to
109  search the 2D channel maps one at a time to build up the 3D
110  detections. This is the default, and can be obtained by setting
111  searchType=spatial. Alternatively, you can set searchType=spectral
112  to do the searching in the 1D spectra.
113
114* Profiling of the code has led to a few changes that have sped up
115  some calculations, particularly those involving the median. Rather
116  than using std::sort, the code now simply uses std::nth_element,
117  which shows a substantial speedup factor.
118
119* When using the objectList parameter, the maps will now only show the
120  selected objects, rather than all detected objects.
121
122* There is a new verification test that looks at the "growing"
123  functionality.
124
125Bug fixes:
126
127* When saving a mask FITS file, there was an occasional memory leak
128  that caused Duchamp to crash (only when the cube was suitably
129  large). This has been fixed.
130
131* The median calculation had a bug that led to an incorrect value
132  being reported. The difference will not be great (the element of an
133  array being reported as the median was out by one), but could be
134  noticeable depending on the dataset.
135
136* The MW range parameters did not respond to the use of a
137  subsection. They should refer to channel ranges in the original
138  cube, and changes have been made to the code to reflect this.
139
140* There was an occasional error in writing out FITS keywords, due to
141  the way comment strings were intialised. This has been improved and
142  made more robust.
143
144* Testing with gcc-4.3.2 showed a number of compilation warnings &
145  errors, which have been fixed.
146
147* The Gaussian smoothing kernel was too small - it is now made big
148  enough to encompass all possible values. It was also being
149  incorrectly scaled. This had no functional effect on the detection
150  of objects, but for other uses was incorrect. This has been
151  rectified.
152
153* Some outputs that weren't caught by the verbose flag now are.
154
155
156Code development notes:
157
158  The following notes only apply if you want to use the code as a
159  library, rather than the stand-alone package. These have generally
160  come out of the ASKAP software development. If you just use the
161  stand-alone package, they won't be a concern.
162
163* The API for storing detected objects has changed, making it more
164  robust from a programming point of view.
165
166* Additional versions of some functions (and the Gaussian smoothing
167  class) have been added - this has come out of the ASKAP development
168  work.
169
170* A number of instances of "unsigned int" being used for loops have
171  been changed to iterators or "size_t". There shouldn't be any
172  functional change from this -- the code should just build more
173  cleanly.
174
175* The Detection class now records whether the parameters have been
176  set, and unsets that flag when objects are merged. This allows
177  external programs to track which objects have been merged and deal
178  with them appropriately.
179
180
181Duchamp version 1.1.8 (2009/07/20)
182----------------------------------
183
184Improvements:
185
186* The final source list can now be sorted on one of a range of object
187  parameters: x-value, y-value, z-value, ra, dec, vel, w50, iflux,
188  pflux (integrated and peak flux respectively), or snr. Simply use
189  the new input parameter sortingParam. Its default value is vel, so
190  the default behaviour stays the same.
191
192* The FDR method involves calculating how many pixels are
193  correlated. This previously involved multiplying the beam area by 2,
194  implying that 2 neighbouring channels were correlated. This factor
195  is now a user-selectable parameter, so that if you know how many
196  spectral channels should be correlated, you can set the parameter
197  FDRnumCorChan and the FDR calculation will be done correctly.
198
199* Screen output now has more information on the growing threshold when
200  the cube statistics are printed.
201
202
203Bug fixes:
204
205* When reading in previous detections, there was a bug causing a
206  segmentation fault. This has been fixed and made more robust.
207
208* There was an apparent bug when writing out the reconstructed cubes
209  to a FITS file that caused the new file to be very large. Changing
210  the cfitsio function used has fixed this.
211
212* Using NCP projections near the equator could result in a large
213  stream of error messages, due to coordinate transformations being
214  done in blank regions outside of the acceptable range of world
215  coordinates. This has been fixed.
216
217* The function that grows objects had a major bug, that stopped it
218  working when flagAdjacent=false. This has been fixed and should work
219  fine.
220
221* The input parameter spectraTextFile was not being read
222  properly. This has been remedied.
223
224* The units for the integrated flux were wrong for some types of pixel
225  flux units. This has been fixed.
226
227* A minor bug caused incorrect calculation of the 20% widths.
228
229* All calls to uint were changed to unsigned int, as some compilers
230  had problems recognising that they were the same thing.
231
232* src/fitsHeader.cc was missing an include statement for stdlib.h,
233  again causing some compilers to fail.
234
235
236Duchamp version 1.1.7 (2009/01/16)
237----------------------------------
238
239Improvements:
240
241* The mask file that can be created with flagMask can now specify
242  which object a given detected pixel belongs to, by taking the object
243  ID as its value. This applies if you set flagMaskWithObjectNum=true
244  (it defaults to false, which means each detected pixel has the value
245  1). Non-detected pixels still have the value 0.
246
247* The names of the output FITS files are now able to be specified
248  directly by input parameters. These will override the default names
249  that Duchamp provides.
250
251* The Karma annotation file now specifies a font - previously it did
252  not and so was at the mercy of whatever was specified in other
253  annotation files being viewed at the same time. Please let me know
254  if the font I've chosen (lucidasans-12) is not suitable.
255
256* The default flag, used in the absence of 'E', 'S' or 'N', is now '-'
257  rather than blank. This will ensure that each column in the results
258  file has something in it.
259
260* The configure script is somewhat more robust to non-standard
261  systems, particularly when the X11 libraries are in unusual
262  places. It can also deal with the slightly different way that
263  wcslib-4.3 installs itself.
264
265* The installation part of the Makefile was altered so that the
266  symbolic link Duchamp that points to Duchamp-1.1.7 does not have the
267  absolute path encoded in it. This will enable the files to be moved
268  around at a later date.
269
270Bug Fixes:
271
272* Fixed a bug that caused problems when the flux units were less than
273  5 characters long (e.g. 'K')
274
275* The new velocity width values were not getting proper headers in the
276  VOTable output. This has been remedied.
277
278* Minor improvements to help non-pgplot use
279
280* Minor fix in WCS functionality.
281
282* Minor fixes to the FitsHeader class.
283
284* Improved FITS data reading, that doesn't require a nullarray
285  array. This will reduce memory usage.
286
287* Improved subsection parsing, particularly for non-standard WCS
288  systems.
289
290* Improving the memory allocation of the Cube class.
291
292* Fixed a bug that meant the growthThreshold values were sometimes
293  being lost.
294
295* Improving the way the growing and merging is done, particularly in
296  the case of non-adjacent merging.
297
298* Fixed a scaling bug in the GaussSmooth function.
299
300Other:
301
302* Numerous changes to the code that do not affect how Duchamp itself
303  runs, but were necessary for code development with the Duchamp
304  libraries (primarily as a part of the ASKAP code development).
305
306
307Duchamp version 1.1.6 (2008/09/08)
308----------------------------------
309
310New features:
311
312* The velocity widths can now be quoted in two additional ways: the
313  full width at 50% of the peak flux (ie. the FWHM) and the full width
314  at 20% of the peak flux (w_50 and w_20 respectively). The w_50
315  parameter is now quoted in the results printed to the screen
316  (instead of w_VEL), but all three are written to the results file.
317
318* The facility now exists to bypass the searching step and go straight
319  to the output stage using a list of previously detected objects. The
320  list is extracted from a previously-created log file. The user can
321  change the way the spectra are plotted (e.g. choose to plot
322  integrated rather than peak spectra), and select a subset of the
323  detected objects to be printed to individual postscript files. Use
324  the input parameter usePrevious (set to true) to use this facility,
325  and provide a list of objects using the objectList parameter
326  (eg. 1,2,4,7-10,15)
327
328* A new parameter "growthThreshold" has been created, that goes with
329  "threshold". If you manually specify a threshold, and you wish to
330  grow detections, you need to manually specify a growthThreshold (in
331  flux units).
332
333Bug fixes:
334
335* Cubes that do not have a spectral axis (such as Stokes cubes) were
336  causing memory leaks and crashing, due to some assumptions of the
337  existence of the spectral axis. These bugs have been fixed, so that
338  Duchamp will run on such cubes, although the WCS transforms may not
339  always work appropriately. Please let me know via bug reports of
340  difficulties you encounter!
341
342* The growing function has had a few bugs fixed and is now more
343  efficient.
344
345* The FDR method was previously overriding any manually-specified
346  threshold. This has been fixed so that if the user specifies
347  threshold=X, then the FDR method is not called.
348
349* Some undefined things were happening with textual output when no
350  objects were detected. This has been fixed.
351
352* Memory leaks caused by FITS WCS irregularities have been fixed
353  (specifically, if a FITS header had NAXIS=2 but more than two WCS
354  axes were defined).
355
356
357
358Duchamp version 1.1.5 (2008/03/20)
359----------------------------------
360
361Bug fixes:
362* A major bug was discovered in the calculation of integrated
363  fluxes. The flux was incorrectly being weighted by the spatial size
364  of the detection, resulting in a (often considerable) overestimation
365  of the integrated flux. This has been corrected.
366
367* The beam size calculation was also incorrect, being out by a factor
368  of 1/ln(2).
369
370* The "make install" command previously failed to work properly if the
371  library had not been created. This has been fixed so that the
372  installation works even if there is no library file.
373
374New Features:
375* You can now provide a new flux unit string, so that the pixel fluxes
376  will be converted to these new fluxes before any calculations are
377  done. This is done with the newFluxUnits input parameter. The new
378  units should be directly convertible from the old ones (given by the
379  BUNIT header -- e.g. if BUNIT = Jy/beam, you can give newFluxUnits
380  as mJy/beam, but not mJy).
381
382* You can now specify the precision used in the output files for flux,
383  velocity and S/N ratio columns, via new input parameters precFlux,
384  precVel and precSNR. These will apply to the VOTable output as well
385  as the text table and information on the spectral plots.
386
387* The Karma annotation files previously provided just a circle at the
388  spatial location of the detected object. You now have the option to
389  draw a border around the detected pixels (in a similar manner to the
390  PGPLOT moment maps). Karma does not do this perfectly, so the lines
391  may not line up exactly with the pixel borders, so the option
392  remains to keep using the circles. This is controlled by the
393  parameter "annotationType", with possible options being "borders"
394  (the default) or "circles".
395
396* There is a new function getMetadata() that loads the header and WCS
397  data, but no pixel information. This is only of interest if you are
398  doing code development with the Duchamp library -- it does not
399  affect the running of Duchamp itself.
400
401Duchamp version 1.1.4 (2008/02/15)
402----------------------------------
403
404Most of the changes incorporated in this update result from ASKAP code
405development (that makes use of some of the Duchamp functionality),
406but do not actually affect the way Duchamp runs (other than, in a
407couple of cases, making it a bit faster). Changes that are
408relevant for regular users of Duchamp are as follows:
409
410* A new option has been made available (thanks to Mary Putman et al
411  for the suggestion!) to save the spectra of all detected objects in
412  a text file. This has the form of one column for the spectral
413  coordinates and one column of fluxes for each object. This is
414  enabled by the input parameters flagTextSpectra and spectraTextFile.
415
416* Slight changes to the output include he formatting of the way the
417  detected objects are written to the log file. This meant the
418  verification files were also updated. Also the cube statistics are
419  not printed to the results file if a user threshold is specified (as
420  they are not calculated!).
421
422* The determination of beam size has been made more reliable, as has
423  the BUNIT determination.
424
425* Fixed a bug that meant source merging was not done for 2D images
426  (not usually a problem, as the source-finding takes care of this,
427  but came up in parallelisation development).
428
429Duchamp version 1.1.3 (2008/01/08)
430----------------------------------
431
432A minor update that just improves the build process. The location of
433the wcslib include files was not specified correctly, so that some
434machines were unable to find them. The configure script has been fixed
435so that the compilation should work in all cases.
436
437Some minor changes have also been made to the code in the PixelMap
438directory, and to param.cc, to fix warnings or errors that may appear
439in compilation.
440
441However, there are no changes to the actual workings of the code in
442this minor version, so if you have a working version of Duchamp 1.1.2
443there is probably no reason to update.
444
445Duchamp version 1.1.2 (2007/12/07)
446----------------------------------
447
448Compilation:
449
450* The compilation had problems working correctly when the cfitsio and
451  wcs libraries were not in standard locations. The configure script
452  has been tweaked to make sure the libraries are found.
453
454* Problems with compiling in the absence of pgplot have been fixed,
455  and it should now compile fine.
456
457* Improved the configure script for use with Mac OS X and gfortran.
458
459
460Bugfixing:
461
462* A major problem with the text-based output was fixed. The widths of
463  the columns were not being calculated correctly, and were running
464  together. This should no longer be the case.
465
466* There was a bug in the way Duchamp interpreted spectral axes,
467  particularly AIPS types such as FELO-HEL, leading to incorrect
468  scaling of the velocity axis. This has been fixed, so that
469  non-standard types are now dealt with appropriately and the velocity
470  scaling should be accurate.
471
472* Another bug meant the beam correction was always applied to the
473  integrated spectra, regardless of whether the flux units involved
474  the beam (e.g. Jy/beam). This has been fixed. Note that the values
475  of the integrated flux presented in the results table were always
476  calculated correctly.
477
478* Other minor changes to improve the speed and efficiency, especially
479  of the merging code.
480
481New user parameters:
482
483* There is now the possibility to save a FITS file that contains a
484  mask array, indicating where the detected objects are. This is
485  governed by the flagOutputMask parameter.
486
487* The header information that is printed at the start of the results
488  file -- that is, the list of parameters, the statistics of the cube,
489  and the number of detections -- can now be written to a separate
490  file. Set the flagSeparateHeader parameter to true or 1 and it will
491  go to the file indicated by the headerFile parameter (the default is
492  duchamp-Results.hdr).
493
494* A "scaleMax" parameter has been added, so that the wavelet
495  reconstruction can include only a specified range of scales (for
496  instance, if one wants to search just for narrow features such as
497  absorption lines).
498
499* A "flagRobustStats" parameter has been added. This allows the user
500  to elect to use robust statistics (median and median absolute
501  deviation from the median) to estimate the noise parameters. If set
502  to false, the mean and standard deviation will be used. The default
503  value is true.
504
505New Feature:
506
507* When Duchamp is run on a 2D image (i.e. with no spectral output), it
508  now produces a postscript file that shows information each
509  individual source plus the image cutout of the source. This is
510  similar to the spectral output file, but without the spectra. The
511  filename is given by the spectraFile parameter.
512
513* Ability to save a FITS file containing a mask array, with pixel
514  values of 1 for pixels in a detected object, and 0 elsewhere.
515
516
517Duchamp version 1.1.1 (2007/07/20)
518------------------------------------
519
520Minor update to the release, with just a few changes:
521
522* The verification script was generating diffs due to differences in
523  the precision of some calculations when done on different machines.
524  One of these was the integrated flux, and this has been corrected so
525  that the same value should appear on all machines.
526  The verification script has also changed so that just the number of
527  sources and their positions are tested, as well as the
528  logfiles. This should avoid the reporting of spurious differences.
529
530* The grey-scale used in the image cutouts (in the spectral plots) has
531  been inverted. This makes it consistent with the scale used in the
532  maps, and hopefully easier to see when printing.
533
534* The configure/make system has been altered to make it easier to
535  install, and to specify different external libraries. In particular,
536  it is now not necessary to have PGPLOT installed on your system to
537  run Duchamp. In the absence of PGPLOT, Duchamp will run as normal,
538  just without any graphical output. Some source code needed to be
539  restructured to make this work. Please read the README file, or the
540  Installation appendix in the User's Guide, for complete details.
541
542* The time of completion is now written to the log file, so that the
543  user can have some idea of how long the program took.
544
545
546Duchamp version 1.1 (2007/05/17)
547------------------------------------
548
549Changes made since the last numbered release:
550
551EFFICIENCY OF EXECUTION:
552
553* Major change to the way detections are stored. They are now recorded
554  via run-length encoding in the x-y plane, and stored as collections
555  of channel-maps. This improves the memory usage and the speed of
556  execution (particularly for routines such as the merging
557  routines). The memory usage has also been improved by changing the
558  way the list of detected objects is stored.
559
560SMOOTHING:
561
562* Addition of ability to spatially smooth the cube before
563  searching. This is done with a Gaussian kernel, the size and shape
564  of which can be specified by the user, using the parameters kernMaj
565  & kernMin (which are the FWHM for the major & minor axes -- if
566  kernMin is not given it is assumed to match kernMaj) and kernPA (the
567  position angle of the major axis).  There is a new parameter
568  smoothType that distinguishes this method from the spectral (Hanning)
569  smoothing already in use.
570
571DETECTIONS:
572
573* Changed the way detection is done -- now only search in 2D images,
574  keeping all detections (ie. no minimum-pixel requirement). This
575  should be the same as doing both the 1D and 2D searches with the
576  minimum pixel requirement in, but simpler. The rejection is done at
577  the end after all the merging and growing has been done. This leads
578  to a larger number of intermediate detections (ie.  the number
579  before merging), which may increase the run-time slightly, although
580  this is offset by the changes to the efficiency (see above).
581
582* Increased the range over which objects can be grown to match the
583  threshSpatial & threshVelocity parameters, as well as rejecting new
584  pixels based on the BLANK and MW tests.
585
586INPUTS:
587
588* There has been a subtle change in the way BLANK pixels are dealt
589  with. To enable trimming of BLANK pixels, users should use the new
590  parameter flagTrim. The parameters flagBlankPix and blankPixVal are
591  no longer accessible via the parameter file -- warning messages are
592  given if they are provided in the parameter file.
593
594* Added ability to specify a statsec, so that the statistics are only
595  calculated from a given subsection of the cube, rather than the full
596  cube.
597
598* The subsections can also specify the ability to remove a border of n
599  pixels from the edges of an axis (ie. n from the start and from the
600  end) -- as requested in Trac ticket #5.
601
602* Changed the default value of the reconDim parameter from 3 to 1, and
603  the default value of the flagATrous parameter to false.
604
605OUTPUTS:
606
607* The output now includes three different estimates of the "centre" of
608  the detection: peak location, centroid (flux-weighted), or average.
609
610* Some slight improvements to the user feedback during execution.
611
612* Spectral output now includes the baseline, if one was fitted. The
613  format of the plot headers is slightly changed, to stop information
614  falling off the edge of the page.
615
616* Added command-line option -x to directly disable the PGPLOT X-window
617  map plotting. This overrides the setting of flagXOutput in the
618  parameter file.
619
620* Fallback spectral units (in case the FITS header fails to record
621  them) changed to SPC, but code has been fixed so that any problem
622  should be caught before this becomes an issue.
623
624BUGFIXES:
625
626* Fixed bug (Trac ticket #4) that meant the velocity units were not
627  correctly dealt with. Duchamp should be more robust for different
628  velocity axis setups now.
629
630* Fixed bug (ticket #9) with the VOTable output, where the tags were
631  not closing.
632
633* Fixed a bug that meant the integrated fluxes were not calculated
634  properly -- no allowance was made for the number of spatial
635  pixels. This should also work properly for 2D images now as well.
636
637* Fixed minor bug in calculating the flux threshold from the p-value
638  threshold when the FDR method is used. This did not affect the
639  actual thresholding, merely the quoted flux threshold in the results
640  file. Also, the MW channels are kept out of the p-value threshold
641  determination if they are being flagged.
642
643
644
645Duchamp version 1.0.7 (2006/11/22)
646----------------------------------
647
648One new feature, and some improvements and bug-fixes.
649
650* The user can now elect to Hanning-smooth the spectral direction of
651  the cube before the searching is done. This can be done instead of the
652  wavelet reconstruction (although if both are selected, the
653  reconstruction takes precendence). This functionality is switched on
654  and off by the flagSmooth parameter, and the width of the Hanning
655  kernel is governed by the hanningWidth parameter.
656
657* The smoothed array can also be written to a FITS file and read in at
658  the start in the same manner as the reconstructed array.
659
660* Several improvements have been made to the memory
661  management. Several memory leaks were fixed, and the memory usage of
662  Duchamp is considerably less, which will be a help for running it on
663  large cubes. The speed of some routines has also been improved, by
664  removing unnecessarily repetitive loops.
665
666* The sorting routines have been changed, and should now be slightly quicker
667  (and a bit more robust).
668
669* Enabled the scale bar (plotted on the 0th moment map in the spectral
670  output file) to be able to deal with much finer spatial scales (as
671  may be expected from VLBI data).
672
673* Other minor changes to code and presentation.
674
675
676Duchamp version 1.0.6 (2006/11/01)
677----------------------------------
678
679Some incremental improvements and changes to the code:
680
681* The statistics used for the detection are now calculated once for
682  the entire cube, rather than being calculated separately for each
683  channel map and spectrum. This results in a uniform threshold value
684  across the entire cube. The way the statistics calculations are
685  implemented in the code was changed, using a new statistics class.
686
687* This means we can report a peak signal-to-noise value for each
688  detection. This is given in the text-based output, as well as in the
689  summary information above the spectral output for each source.
690
691* The user can now elect not to have the moment map displayed in a
692  PGPlot window, through the use of the new flagXOutput
693  parameter. This should help in cases of running Duchamp on a dumb
694  terminal (with no X-display capabilities), or as part of a batch
695  script where the continual popping-up of the PGPlot window might
696  become annoying.
697
698* There are different Flags reported for the case of an object lying on
699  the spatial edge and spectral edge of the cube (E and S respectively).
700
701* A few minor bug fixes:
702  - When providing a subsection, any axes with the range given by *
703    had the pixel values offset incorrectly. This has been fixed.
704  - Negative searches now correctly invert the reconstructed array
705    when it is read in from a file.
706
707* Other minor changes to the code, to improve memory handling and
708  remove redundant arrays and variables.
709
710
711Duchamp version 1.0.5 (2006/09/06)
712----------------------------------
713
714Since version 1.0, there have been a range of mostly minor
715changes. These are generally bug-fixes, thanks to feedback from a
716number of users, as well as a few extra features.
717
718Here is a summary of the changes since version 1.0:
719
720USER INTERFACE:
721
722* The user is now able to enter the value of flag parameters in the
723  parameter file as strings, as well as integers (so one can enter
724  true or 1 to give the same result).
725
726GRAPHICAL OUTPUT:
727
728* Added a new function that draws the edge of the blank region on the
729  maps and image cutouts. There is a new flag parameter --
730  drawBlankEdges -- that controls the use of this function (the
731  default is true).
732  Also, the edge of the field is plotted on the image cutouts as a
733  yellow line. This distinguishes it from the purple blank pixel
734  dividing line.
735
736* The size of the tick mark in the image cutout (indicating the
737  spatial scale of the image) is now adaptable, so that it shows the
738  scale that best fits the image (ranging from 1 arcsec to 15
739  degrees). (This is a change from the previous standard length of 15
740  arcmin.)
741
742* The zoomed spectrum had its flux scale determined by all points in
743  the zoom box,including those flagged by the Milky Way (MW)
744  range. This has been fixed so that any MW channels will not affect
745  the flux scaling, potentially improving the appearance of objects
746  detected close in velocity to strong MW emission or absorption.
747
748* Improved Karma Annotation file output, so that files without good
749  WCS are dealt with appropriately.
750
751TEXT-BASED OUTPUT:
752
753* The position resolution in the IAU-format names has been increased,
754  so that distinct objects close to one another are more readily
755  distinguished.  Overlapping sources at different velocities may
756  still have the same name, but this is a more general problem.
757
758* The presentation of the results in tabular format has been improved,
759  so that the precision of faint sources is sufficient to show their
760  flux, for instance, is not 0. This also applies to the information
761  presented above the spectral plots.
762
763* Improved error and warning reporting, so that the formatting and
764  presentation of information is clearer.
765
766FITS I/O RELATED:
767
768* The previous version was did not deal well with 4 (or greater)
769  dimensions in the FITS file -- the memory allocation was badly done,
770  and the axes needed to be in a particular order. This has been
771  fixed, so that the FITS I/O routines can now handle any sized FITS
772  file, with axes in any order (as long as there are two spatial and one
773  spectral axes).
774
775* When the FITS file does not have a rest frequency defined, there is
776  no way to transform the frequency axis into velocity. In this case,
777  the spectral axis is left as frequency, and put into units of MHz.
778
779* If the beam size is not indicated by the FITS header (through the
780  BMAJ and BMIN keywords), the user can manually specify the size
781  through the parameter file (using parameter beamSize).
782
783* The FITS I/O routines make use of the command fits_file_exists. This
784  was introduced into the CFITSIO package from version 2.5, so Duchamp
785  will only work with this version or higher. Version 3+ is preferred.
786
787OTHER BUG-FIXING:
788
789* Several bugs related to the blank-pixels were dealt with.
790  The correct values were not propagating through correctly, meaning
791  that the default values were being used. Also, there was the
792  potential for blank pixels to be detected when the FDR method was
793  used. Finally, the image cutout displays occasionally did not
794  obscure the blank pixels. All these problems should be fixed now.
795
796* The FDR setup routine was occasionally failing with a segmentation
797  fault, due to it accessing unallocated memory. This has been fixed.
798
799* Fixed bugs that affected the way 2D images (rather than 3D cubes)
800  were dealt with. The minChannels test failed when minChannels=0.
801
802* If there is no beam information in the FITS header, the user can now
803  enter a beam size as a parameter.
804
805* Other minor fixes to the code, to improve its structure and
806  robustness.
807
808
809Duchamp version 1.0 (2006/06/30)
810--------------------------------
811
812The first full release version.
813
814Several major changes compared to previous version:
815
816* Incorporated a FitsHeader class, to keep track of header information
817  (including WCS) from the FITS file. All units-related calculations
818  are done with this class, such as conversion to velocity, and
819  pixel-to-WCS conversion.  The main advantage of this is improved
820  speed of execution, more adaptable to different units, and improved
821  code (easier for me!).
822
823* Able to select the dimensionality of the reconstruction, rather than
824  just doing it in 3-D.
825
826* Robust text output, so that the columns are sized correctly given
827  the data being written, and the relevant units (derived from the
828  FITS header) are included in the output table.
829
830* Improved the way the reconstructed image is saved and read back in,
831  with a better naming scheme and a better set of new FITS header
832  keywords. The MW headers are now not written.
833
834Other, more minor changes include:
835
836* MW channels now not set to 0, but just ignored for searching
837  purposes (and for the scaling of the spectral output -- they are
838  plotted though and highlighted with a hashed box).
839
840* The scale bar in the moment map in the spectral output file has its
841  length indicated.
842
843* Improved VOTable output, with more information about the way Duchamp
844  was run.
845
846* Made sure all statistics calculations in the reconstruction are
847  based on robust (ie. median) methods.
848
849Also moved to an autoconf based configure/make compilation, for ease of use.
850
851
852Duchamp version 0.9.2 (2006/06/27)
853--------------------------------
854
855* Added the use of warning flags for detections: for either edge
856  location or negative enclosed flux.
857
858* A new command line option added so that the user can specify a FITS
859  file to be searched with the default parameters, rather than giving
860  a full parameter file.
861
862* The scale bar on the moment cutout now works in general case, using
863  an iterative process to get to the correct length.
864
865* RA axes are now done correctly on the full-scale maps.
866
867* Various coding fixes, improving the readability of the code,
868  particularly regarding the declaration of temporary variables.
869
870* Changed the way the time of execution is called : now using time.h
871  functions, rather than a system call.
872
873* Changed output in Detection/outputDetection.cc for the pixel
874  information of detected objects (the info printed above the spectral
875  plots) -- now print out number of voxels in object, and have
876  improved the formatting a little.
877
878* Improved the functionality of saving the FITS file containing the
879  reconstructed array. Added ability to save and read back in the MW
880  parameters when saving a reconstructed cube (if a reconstructed cube
881  has different MW range to that being considered, it would cause
882  problems). ReadRecon now just returns a FAILURE and will reconstruct
883  the cube anew.
884
885* Changed default value of flagGrowth to 0.
886
887
888
889Duchamp version 0.9 (2006/05/05)
890--------------------------------
891
892First public release version.
Note: See TracBrowser for help on using the repository browser.