1 | ----------------------------------------------------------------------- |
---|
2 | The Duchamp Source Finder |
---|
3 | ----------------------------------------------------------------------- |
---|
4 | Duchamp 1.1.4-beta -- an object finder for spectral-line data cubes |
---|
5 | Copyright (C) 2006, Matthew Whiting, ATNF |
---|
6 | |
---|
7 | Duchamp is free software; you can redistribute it and/or modify it |
---|
8 | under the terms of the GNU General Public License as published by the |
---|
9 | Free Software Foundation; either version 2 of the License, or (at your |
---|
10 | option) any later version. |
---|
11 | |
---|
12 | Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
13 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
14 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
15 | for more details. |
---|
16 | |
---|
17 | You should have received a copy of the GNU General Public License |
---|
18 | along with Duchamp; if not, write to the Free Software Foundation, |
---|
19 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
20 | |
---|
21 | Correspondence concerning Duchamp may be directed to: |
---|
22 | Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
23 | Postal address: Dr. Matthew Whiting |
---|
24 | Australia Telescope National Facility, CSIRO |
---|
25 | PO Box 76 |
---|
26 | Epping NSW 1710 |
---|
27 | AUSTRALIA |
---|
28 | ----------------------------------------------------------------------- |
---|
29 | |
---|
30 | Introduction |
---|
31 | ============ |
---|
32 | |
---|
33 | Duchamp is a stand-alone program designed to find objects in |
---|
34 | astronomical data cubes, particularly spectral-line observations. Its |
---|
35 | features include a wavelet-based reconstruction technique for reducing |
---|
36 | the noise in the cube (and thereby enhancing detectability of |
---|
37 | sources), easy-to-use text-based interface, flexibility to control all |
---|
38 | relevant parameters such as detection thresholds, and a useful range |
---|
39 | of text- and graphics-based output. |
---|
40 | |
---|
41 | Duchamp works on any FITS image using the CFITSIO package, and uses |
---|
42 | Mark Calabretta's WCSLIB library to provide accurate position and |
---|
43 | velocity information for all detected sources. |
---|
44 | |
---|
45 | |
---|
46 | The "Beta" Version |
---|
47 | ================== |
---|
48 | |
---|
49 | This distribution of Duchamp, dated 15/2/2008, is known as the beta |
---|
50 | version. (The version number when "Duchamp -v" is run is given as 1.1.4 |
---|
51 | though.) It is more recent than the most recent release (v1.1.4), as |
---|
52 | it has several new functions and features. The user should be aware |
---|
53 | that these may not yet be documented and, while they have been tested |
---|
54 | on a limited number of cases, their stability is not assured to the |
---|
55 | same level as a proper numbered release. |
---|
56 | |
---|
57 | The beta version is provided more for testing purposes -- if users |
---|
58 | want a reliable version of the code that matches the documentation, |
---|
59 | please use the latest release available from the webpage given below. |
---|
60 | |
---|
61 | Having said all that, do note that I won't post a beta version on the |
---|
62 | website unless I know that it is functioning in most cases, so it |
---|
63 | should work to a large degree (and if it doesn't -- let me know!) |
---|
64 | |
---|
65 | |
---|
66 | |
---|
67 | Obtaining and Building Duchamp |
---|
68 | ============================== |
---|
69 | |
---|
70 | The Duchamp web page is at |
---|
71 | http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp |
---|
72 | where you can download a gzipped tar archive of the source code. |
---|
73 | |
---|
74 | Duchamp uses three main external libraries: pgplot (although see note |
---|
75 | below), cfitsio (version 2.5 and greater, version 3+ preferred) and |
---|
76 | wcslib. If you do not have the libraries, they can be downloaded from |
---|
77 | the following locations: |
---|
78 | |
---|
79 | PGPLOT -- http://www.astro.caltech.edu/~tjp/pgplot/ |
---|
80 | cfitsio -- http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html |
---|
81 | wcslib -- http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html |
---|
82 | |
---|
83 | Note that PGPLOT is optional. Duchamp can be compiled and run without |
---|
84 | PGPLOT, but you will miss out on the useful graphical outputs! The |
---|
85 | other two libraries, cftisio and wcslib, are essential. |
---|
86 | |
---|
87 | |
---|
88 | Basic Compilation and Installation |
---|
89 | ---------------------------------- |
---|
90 | |
---|
91 | Duchamp can be built and installed on Unix systems by typing (note |
---|
92 | that the terminal prompt here is represented by > -- don't type this |
---|
93 | character!): |
---|
94 | |
---|
95 | > ./configure |
---|
96 | > make |
---|
97 | > make clean (optional -- to remove the object files from the src |
---|
98 | directory) |
---|
99 | > make install |
---|
100 | |
---|
101 | This default setup will search in standard locations for the necessary |
---|
102 | libraries, and install the executable ("Duchamp") in /usr/local/bin (a |
---|
103 | copy will also be in the current directory). If you want this to go |
---|
104 | somewhere else, eg if you don't have write-access to that directory, |
---|
105 | or you need to tweak the libraries, see the next section. Otherwise, |
---|
106 | jump to the testing section. |
---|
107 | |
---|
108 | |
---|
109 | Tweaking the installation setup |
---|
110 | ------------------------------- |
---|
111 | |
---|
112 | To install Duchamp in a directory other than /usr/local/bin, use the |
---|
113 | --prefix option with configure, specifying the directory above the |
---|
114 | \texttt{bin/} directory. eg: |
---|
115 | |
---|
116 | > ./configure --prefix=/home/mduchamp |
---|
117 | |
---|
118 | which, if you run "make" and "make install", will result in the binary |
---|
119 | being put in the directory /home/mduchamp/bin. |
---|
120 | |
---|
121 | If the above-mentioned libraries have been installed in non-standard |
---|
122 | locations, or you have more than one version installed on your system, |
---|
123 | you can specify specific locations by using the --with-cfitsio=<dir>, |
---|
124 | --with-wcslib=<dir> or --with-pgplot=<dir> flags. For example: |
---|
125 | |
---|
126 | > ./configure --with-wcslib=/home/mduchamp/wcslib-4.2 |
---|
127 | And then just run make in the usual fashion: |
---|
128 | > make |
---|
129 | |
---|
130 | Duchamp can be compiled without PGPLOT if it is not installed on your |
---|
131 | system -- the searching and text-based output remains the same, but |
---|
132 | you will not have any graphical output. |
---|
133 | To manually specify this option, use the --without-pgplot flag, eg: |
---|
134 | |
---|
135 | > ./configure --without-pgplot |
---|
136 | |
---|
137 | (Note that CFITSIO and WCSLIB are essential, however, so |
---|
138 | --without-wcslib or --without-cfitsio will not work.). |
---|
139 | Even if you do not give the --without-pgplot option, and the PGPLOT |
---|
140 | library is not found, Duchamp will still compile (albeit without |
---|
141 | graphical capabilities). |
---|
142 | |
---|
143 | |
---|
144 | Installing on Mac OS X with gfortran |
---|
145 | ------------------------------------ |
---|
146 | |
---|
147 | Some recent testing on a Mac with OS X and gfortran has shown that |
---|
148 | slight tweaking needs to be done with the use of configure. In |
---|
149 | addition to the options noted above, configure should be run with F77 |
---|
150 | set to the desired fortran compiler command. Note that this should be |
---|
151 | the same as that used to compile the pgplot package, if you are using |
---|
152 | it: gfortran is probably the best choice. |
---|
153 | This is done simply by: |
---|
154 | |
---|
155 | > ./configure F77=gfortran ...[other options]... |
---|
156 | |
---|
157 | |
---|
158 | Testing |
---|
159 | ======= |
---|
160 | |
---|
161 | There is a script included in the distribution that allows you to make |
---|
162 | sure Duchamp is running correctly. It will use a dummy FITS image in |
---|
163 | the verification/ directory -- this image has some Gaussian random |
---|
164 | noise, with five Gaussian sources present, plus a dummy WCS. The |
---|
165 | script runs Duchamp on this image with three different sets of inputs, |
---|
166 | and compares to known results, looking for differences and reporting |
---|
167 | any. There should be none reported if everything is working |
---|
168 | correctly. To run, enter the command |
---|
169 | |
---|
170 | > VerifyDuchamp.sh |
---|
171 | |
---|
172 | Once you know it is working, you can install Duchamp on your system |
---|
173 | with the command |
---|
174 | |
---|
175 | > make install |
---|
176 | |
---|
177 | You can also use the dummy image for your own testing if you like (for |
---|
178 | instance, testing different thresholds to get a feel for how the |
---|
179 | program works). |
---|
180 | |
---|
181 | |
---|
182 | Using Duchamp |
---|
183 | ============= |
---|
184 | |
---|
185 | There are two possible ways to run Duchamp. The first is: |
---|
186 | |
---|
187 | > Duchamp -f image.fits |
---|
188 | |
---|
189 | where image.fits is the data cube to be searched. This method simply |
---|
190 | uses the default values of all parameters. |
---|
191 | |
---|
192 | The second method allows some determination of the parameter values by |
---|
193 | the user. Type: |
---|
194 | |
---|
195 | > Duchamp -p parameterFile |
---|
196 | |
---|
197 | where parameterFile is a file with the input parameters, including the |
---|
198 | name of the cube you want to search. There are two example input files |
---|
199 | included with the distribution. The smaller one, InputExample, shows |
---|
200 | the typical parameters one might want to set. The large one, |
---|
201 | InputComplete, lists all possible parameters that can be entered, and |
---|
202 | a brief description of them. To get going quickly, just replace the |
---|
203 | "your-file-here" in InputExample with your image name, and type |
---|
204 | |
---|
205 | > Duchamp -p InputExample |
---|
206 | |
---|
207 | By default, a map of detections is displayed in a PGPLOT |
---|
208 | X-window. This can be disabled by using the flagXOutput parameter, or |
---|
209 | using the -x command-line option along with the -f or -p options. The |
---|
210 | -x option will override the setting in the parameter file. |
---|
211 | |
---|
212 | A User's Guide in the docs/ directory provides complete |
---|
213 | documentation. It comes in both postscript and portable document |
---|
214 | format (pdf -- note that this contains hyperlinks). This guide will |
---|
215 | provide full descriptions of all parameters, and of all steps in the |
---|
216 | execution of Duchamp. |
---|
217 | |
---|
218 | Any questions, please contact me. To report problems or bugs, or to |
---|
219 | suggest improvements, please go to the Duchamp Trac wiki site: |
---|
220 | http://svn.atnf.csiro.au/trac/duchamp/newticket |
---|
221 | and submit a "ticket", or view previously submitted reports. |
---|
222 | |
---|
223 | ------- |
---|
224 | Author: |
---|
225 | Matthew Whiting, Australia Telescope National Facility, October 2007 |
---|
226 | Matthew.Whiting [at] csiro.au |
---|
227 | |
---|