source: trunk/CHANGES @ 194

Last change on this file since 194 was 194, checked in by Matthew Whiting, 18 years ago

Update of the documentation and installation files in preparation for version 1.0.6.
Guide now mentions recent changes of how the cube stats are calculated and how the S/Nmax value is reported.

File size: 8.2 KB
Line 
1Duchamp version 1.0.6 (2006/11/01)
2----------------------------------
3
4Some incremental improvements and changes to the code:
5
6* The statistics used for the detection are now calculated once for
7  the entire cube, rather than being calculated separately for each
8  channel map and spectrum. This results in a uniform threshold value
9  across the entire cube. The way the statistics calculations are
10  implemented in the code was changed, using a new statistics class.
11
12* This means we can report a peak signal-to-noise value for each
13  detection. This is given in the text-based output, as well as in the
14  summary information above the spectral output for each source.
15
16* There a different Flags reported for the case of an object lying on
17  the spatial edge and spectral edge of the cube (E and S respectively).
18
19* A few minor bug fixes:
20  - When providing a subsection, any axes with the range given by *
21    had the pixel values offset incorrectly. This has been fixed.
22  - Negative searches now correctly invert the reconstructed array
23    when it is read in from a file.
24
25* Other minor changes to the code, to improve memory handling and
26  remove redundant arrays and variables.
27
28
29Duchamp version 1.0.5 (2006/09/06)
30----------------------------------
31
32Since version 1.0, there have been a range of mostly minor
33changes. These are generally bug-fixes, thanks to feedback from a
34number of users, as well as a few extra features.
35
36Here is a summary of the changes since version 1.0:
37
38USER INTERFACE:
39
40* The user is now able to enter the value of flag parameters in the
41  parameter file as strings, as well as integers (so one can enter
42  true or 1 to give the same result).
43
44GRAPHICAL OUTPUT:
45
46* Added a new function that draws the edge of the blank region on the
47  maps and image cutouts. There is a new flag parameter --
48  drawBlankEdges -- that controls the use of this function (the
49  default is true).
50  Also, the edge of the field is plotted on the image cutouts as a
51  yellow line. This distinguishes it from the purple blank pixel
52  dividing line.
53
54* The size of the tick mark in the image cutout (indicating the
55  spatial scale of the image) is now adaptable, so that it shows the
56  scale that best fits the image (ranging from 1 arcsec to 15
57  degrees). (This is a change from the previous standard length of 15
58  arcmin.)
59
60* The zoomed spectrum had its flux scale determined by all points in
61  the zoom box,including those flagged by the Milky Way (MW)
62  range. This has been fixed so that any MW channels will not affect
63  the flux scaling, potentially improving the appearance of objects
64  detected close in velocity to strong MW emission or absorption.
65
66* Improved Karma Annotation file output, so that files without good
67  WCS are dealt with appropriately.
68
69TEXT-BASED OUTPUT:
70
71* The position resolution in the IAU-format names has been increased,
72  so that distinct objects close to one another are more readily
73  distinguished.  Overlapping sources at different velocities may
74  still have the same name, but this is a more general problem.
75
76* The presentation of the results in tabular format has been improved,
77  so that the precision of faint sources is sufficient to show their
78  flux, for instance, is not 0. This also applies to the information
79  presented above the spectral plots.
80
81* Improved error and warning reporting, so that the formatting and
82  presentation of information is clearer.
83
84FITS I/O RELATED:
85
86* The previous version was did not deal well with 4 (or greater)
87  dimensions in the FITS file -- the memory allocation was badly done,
88  and the axes needed to be in a particular order. This has been
89  fixed, so that the FITS I/O routines can now handle any sized FITS
90  file, with axes in any order (as long as there are two spatial and one
91  spectral axes).
92
93* When the FITS file does not have a rest frequency defined, there is
94  no way to transform the frequency axis into velocity. In this case,
95  the spectral axis is left as frequency, and put into units of MHz.
96
97* If the beam size is not indicated by the FITS header (through the
98  BMAJ and BMIN keywords), the user can manually specify the size
99  through the parameter file (using parameter beamSize).
100
101* The FITS I/O routines make use of the command fits_file_exists. This
102  was introduced into the CFITSIO package from version 2.5, so Duchamp
103  will only work with this version or higher. Version 3+ is preferred.
104
105OTHER BUG-FIXING:
106
107* Several bugs related to the blank-pixels were dealt with.
108  The correct values were not propagating through correctly, meaning
109  that the default values were being used. Also, there was the
110  potential for blank pixels to be detected when the FDR method was
111  used. Finally, the image cutout displays occasionally did not
112  obscure the blank pixels. All these problems should be fixed now.
113
114* The FDR setup routine was occasionally failing with a segmentation
115  fault, due to it accessing unallocated memory. This has been fixed.
116
117* Fixed bugs that affected the way 2D images (rather than 3D cubes)
118  were dealt with. The minChannels test failed when minChannels=0.
119
120* If there is no beam information in the FITS header, the user can now
121  enter a beam size as a parameter.
122
123* Other minor fixes to the code, to improve its structure and
124  robustness.
125
126
127Duchamp version 1.0 (2006/06/30)
128--------------------------------
129
130The first full release version.
131
132Several major changes compared to previous version:
133
134* Incorporated a FitsHeader class, to keep track of header information
135  (including WCS) from the FITS file. All units-related calculations
136  are done with this class, such as conversion to velocity, and
137  pixel-to-WCS conversion.  The main advantage of this is improved
138  speed of execution, more adaptable to different units, and improved
139  code (easier for me!).
140
141* Able to select the dimensionality of the reconstruction, rather than
142  just doing it in 3-D.
143
144* Robust text output, so that the columns are sized correctly given
145  the data being written, and the relevant units (derived from the
146  FITS header) are included in the output table.
147
148* Improved the way the reconstructed image is saved and read back in,
149  with a better naming scheme and a better set of new FITS header
150  keywords. The MW headers are now not written.
151
152Other, more minor changes include:
153
154* MW channels now not set to 0, but just ignored for searching
155  purposes (and for the scaling of the spectral output -- they are
156  plotted though and highlighted with a hashed box).
157
158* The scale bar in the moment map in the spectral output file has its
159  length indicated.
160
161* Improved VOTable output, with more information about the way Duchamp
162  was run.
163
164* Made sure all statistics calculations in the reconstruction are
165  based on robust (ie. median) methods.
166
167Also moved to an autoconf based configure/make compilation, for ease of use.
168
169
170Duchamp version 0.9.2 (2006/06/27)
171--------------------------------
172
173* Added the use of warning flags for detections: for either edge
174  location or negative enclosed flux.
175
176* A new command line option added so that the user can specify a FITS
177  file to be searched with the default parameters, rather than giving
178  a full parameter file.
179
180* The scale bar on the moment cutout now works in general case, using
181  an iterative process to get to the correct length.
182
183* RA axes are now done correctly on the full-scale maps.
184
185* Various coding fixes, improving the readability of the code,
186  particularly regarding the declaration of temporary variables.
187
188* Changed the way the time of execution is called : now using time.h
189  functions, rather than a system call.
190
191* Changed output in Detection/outputDetection.cc for the pixel
192  information of detected objects (the info printed above the spectral
193  plots) -- now print out number of voxels in object, and have
194  improved the formatting a little.
195
196* Improved the functionality of saving the FITS file containing the
197  reconstructed array. Added ability to save and read back in the MW
198  parameters when saving a reconstructed cube (if a reconstructed cube
199  has different MW range to that being considered, it would cause
200  problems). ReadRecon now just returns a FAILURE and will reconstruct
201  the cube anew.
202
203* Changed default value of flagGrowth to 0.
204
205
206
207Duchamp version 0.9 (2006/05/05)
208--------------------------------
209
210First public release version.
Note: See TracBrowser for help on using the repository browser.