[229] | 1 | ----------------------------------------------------------------------- |
---|
| 2 | The Duchamp Source Finder |
---|
| 3 | ----------------------------------------------------------------------- |
---|
[1181] | 4 | Duchamp 1.3-beta -- an object finder for spectral-line data cubes |
---|
[229] | 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: |
---|
[299] | 22 | Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
[229] | 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 |
---|
[362] | 31 | ============ |
---|
[229] | 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 |
---|
[362] | 47 | ================== |
---|
[229] | 48 | |
---|
[574] | 49 | This distribution of Duchamp, dated 11/5/2009, is known as the beta |
---|
| 50 | version. It is more recent than the most recent release (v1.1.7), as |
---|
[529] | 51 | it has several new functions and features. It is being released as a |
---|
| 52 | beta version as it is close to a full release, but there are a few |
---|
[574] | 53 | checks and so on that still need to be done. When 1.2 is released, |
---|
[529] | 54 | it should be used instead. |
---|
[229] | 55 | |
---|
| 56 | The beta version is provided more for testing purposes -- if users |
---|
| 57 | want a reliable version of the code that matches the documentation, |
---|
| 58 | please use the latest release available from the webpage given below. |
---|
| 59 | |
---|
[260] | 60 | Having said all that, do note that I won't post a beta version on the |
---|
[279] | 61 | website unless I know that it is functioning in most cases, so it |
---|
[260] | 62 | should work to a large degree (and if it doesn't -- let me know!) |
---|
[229] | 63 | |
---|
[362] | 64 | |
---|
| 65 | |
---|
[229] | 66 | Obtaining and Building Duchamp |
---|
[362] | 67 | ============================== |
---|
[229] | 68 | |
---|
| 69 | The Duchamp web page is at |
---|
| 70 | http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp |
---|
| 71 | where you can download a gzipped tar archive of the source code. |
---|
| 72 | |
---|
[362] | 73 | Duchamp uses three main external libraries: pgplot (although see note |
---|
| 74 | below), cfitsio (version 2.5 and greater, version 3+ preferred) and |
---|
| 75 | wcslib. If you do not have the libraries, they can be downloaded from |
---|
| 76 | the following locations: |
---|
[229] | 77 | |
---|
[362] | 78 | PGPLOT -- http://www.astro.caltech.edu/~tjp/pgplot/ |
---|
[229] | 79 | cfitsio -- http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html |
---|
| 80 | wcslib -- http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html |
---|
| 81 | |
---|
[362] | 82 | Note that PGPLOT is optional. Duchamp can be compiled and run without |
---|
| 83 | PGPLOT, but you will miss out on the useful graphical outputs! The |
---|
| 84 | other two libraries, cftisio and wcslib, are essential. |
---|
[229] | 85 | |
---|
[362] | 86 | |
---|
| 87 | Basic Compilation and Installation |
---|
| 88 | ---------------------------------- |
---|
| 89 | |
---|
| 90 | Duchamp can be built and installed on Unix systems by typing (note |
---|
| 91 | that the terminal prompt here is represented by > -- don't type this |
---|
| 92 | character!): |
---|
| 93 | |
---|
[229] | 94 | > ./configure |
---|
| 95 | > make |
---|
| 96 | > make clean (optional -- to remove the object files from the src |
---|
| 97 | directory) |
---|
[362] | 98 | > make install |
---|
[229] | 99 | |
---|
[362] | 100 | This default setup will search in standard locations for the necessary |
---|
| 101 | libraries, and install the executable ("Duchamp") in /usr/local/bin (a |
---|
| 102 | copy will also be in the current directory). If you want this to go |
---|
| 103 | somewhere else, eg if you don't have write-access to that directory, |
---|
| 104 | or you need to tweak the libraries, see the next section. Otherwise, |
---|
| 105 | jump to the testing section. |
---|
[229] | 106 | |
---|
| 107 | |
---|
[362] | 108 | Tweaking the installation setup |
---|
| 109 | ------------------------------- |
---|
| 110 | |
---|
| 111 | To install Duchamp in a directory other than /usr/local/bin, use the |
---|
| 112 | --prefix option with configure, specifying the directory above the |
---|
| 113 | \texttt{bin/} directory. eg: |
---|
| 114 | |
---|
| 115 | > ./configure --prefix=/home/mduchamp |
---|
| 116 | |
---|
| 117 | which, if you run "make" and "make install", will result in the binary |
---|
| 118 | being put in the directory /home/mduchamp/bin. |
---|
| 119 | |
---|
| 120 | If the above-mentioned libraries have been installed in non-standard |
---|
| 121 | locations, or you have more than one version installed on your system, |
---|
| 122 | you can specify specific locations by using the --with-cfitsio=<dir>, |
---|
| 123 | --with-wcslib=<dir> or --with-pgplot=<dir> flags. For example: |
---|
| 124 | |
---|
| 125 | > ./configure --with-wcslib=/home/mduchamp/wcslib-4.2 |
---|
[229] | 126 | And then just run make in the usual fashion: |
---|
| 127 | > make |
---|
| 128 | |
---|
[362] | 129 | Duchamp can be compiled without PGPLOT if it is not installed on your |
---|
| 130 | system -- the searching and text-based output remains the same, but |
---|
| 131 | you will not have any graphical output. |
---|
| 132 | To manually specify this option, use the --without-pgplot flag, eg: |
---|
| 133 | |
---|
| 134 | > ./configure --without-pgplot |
---|
| 135 | |
---|
| 136 | (Note that CFITSIO and WCSLIB are essential, however, so |
---|
| 137 | --without-wcslib or --without-cfitsio will not work.). |
---|
| 138 | Even if you do not give the --without-pgplot option, and the PGPLOT |
---|
| 139 | library is not found, Duchamp will still compile (albeit without |
---|
| 140 | graphical capabilities). |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | Installing on Mac OS X with gfortran |
---|
| 144 | ------------------------------------ |
---|
| 145 | |
---|
| 146 | Some recent testing on a Mac with OS X and gfortran has shown that |
---|
| 147 | slight tweaking needs to be done with the use of configure. In |
---|
| 148 | addition to the options noted above, configure should be run with F77 |
---|
| 149 | set to the desired fortran compiler command. Note that this should be |
---|
| 150 | the same as that used to compile the pgplot package, if you are using |
---|
| 151 | it: gfortran is probably the best choice. |
---|
| 152 | This is done simply by: |
---|
| 153 | |
---|
| 154 | > ./configure F77=gfortran ...[other options]... |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | Testing |
---|
| 158 | ======= |
---|
| 159 | |
---|
[229] | 160 | There is a script included in the distribution that allows you to make |
---|
| 161 | sure Duchamp is running correctly. It will use a dummy FITS image in |
---|
| 162 | the verification/ directory -- this image has some Gaussian random |
---|
| 163 | noise, with five Gaussian sources present, plus a dummy WCS. The |
---|
| 164 | script runs Duchamp on this image with three different sets of inputs, |
---|
| 165 | and compares to known results, looking for differences and reporting |
---|
| 166 | any. There should be none reported if everything is working |
---|
| 167 | correctly. To run, enter the command |
---|
| 168 | |
---|
| 169 | > VerifyDuchamp.sh |
---|
| 170 | |
---|
[382] | 171 | Once you know it is working, you can install Duchamp on your system |
---|
| 172 | with the command |
---|
| 173 | |
---|
| 174 | > make install |
---|
| 175 | |
---|
[229] | 176 | You can also use the dummy image for your own testing if you like (for |
---|
| 177 | instance, testing different thresholds to get a feel for how the |
---|
| 178 | program works). |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | Using Duchamp |
---|
[362] | 182 | ============= |
---|
[229] | 183 | |
---|
| 184 | There are two possible ways to run Duchamp. The first is: |
---|
| 185 | |
---|
| 186 | > Duchamp -f image.fits |
---|
| 187 | |
---|
| 188 | where image.fits is the data cube to be searched. This method simply |
---|
| 189 | uses the default values of all parameters. |
---|
| 190 | |
---|
| 191 | The second method allows some determination of the parameter values by |
---|
| 192 | the user. Type: |
---|
| 193 | |
---|
| 194 | > Duchamp -p parameterFile |
---|
| 195 | |
---|
| 196 | where parameterFile is a file with the input parameters, including the |
---|
| 197 | name of the cube you want to search. There are two example input files |
---|
| 198 | included with the distribution. The smaller one, InputExample, shows |
---|
| 199 | the typical parameters one might want to set. The large one, |
---|
| 200 | InputComplete, lists all possible parameters that can be entered, and |
---|
| 201 | a brief description of them. To get going quickly, just replace the |
---|
| 202 | "your-file-here" in InputExample with your image name, and type |
---|
| 203 | |
---|
| 204 | > Duchamp -p InputExample |
---|
| 205 | |
---|
[298] | 206 | By default, a map of detections is displayed in a PGPLOT |
---|
| 207 | X-window. This can be disabled by using the flagXOutput parameter, or |
---|
| 208 | using the -x command-line option along with the -f or -p options. The |
---|
| 209 | -x option will override the setting in the parameter file. |
---|
| 210 | |
---|
[1160] | 211 | You can specify a flux threshold from the command line by using the -t |
---|
| 212 | option. This is particularly useful when combined with -f to enable a |
---|
| 213 | quick search to some flux level: |
---|
| 214 | |
---|
| 215 | > Duchamp -f image.fits -t 0.001 |
---|
| 216 | |
---|
[229] | 217 | A User's Guide in the docs/ directory provides complete |
---|
| 218 | documentation. It comes in both postscript and portable document |
---|
| 219 | format (pdf -- note that this contains hyperlinks). This guide will |
---|
| 220 | provide full descriptions of all parameters, and of all steps in the |
---|
| 221 | execution of Duchamp. |
---|
| 222 | |
---|
| 223 | Any questions, please contact me. To report problems or bugs, or to |
---|
| 224 | suggest improvements, please go to the Duchamp Trac wiki site: |
---|
[362] | 225 | http://svn.atnf.csiro.au/trac/duchamp/newticket |
---|
[229] | 226 | and submit a "ticket", or view previously submitted reports. |
---|
| 227 | |
---|
[362] | 228 | ------- |
---|
[229] | 229 | Author: |
---|
[574] | 230 | Matthew Whiting, Australia Telescope National Facility, May 2009 |
---|
[299] | 231 | Matthew.Whiting [at] csiro.au |
---|
[229] | 232 | |
---|