[229] | 1 | ----------------------------------------------------------------------- |
---|
| 2 | The Duchamp Source Finder |
---|
| 3 | ----------------------------------------------------------------------- |
---|
| 4 | Duchamp -- 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@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 24/01/2007, is known as the beta |
---|
| 50 | version. (The version number when "Duchamp -v" is run is given as |
---|
[258] | 51 | 1.1b.). It is more recent than the most recent release (v1.0.7), as |
---|
[229] | 52 | it has several new functions and features. The user should be aware |
---|
| 53 | that these are likely to be undocumented and, while they have been |
---|
| 54 | tested on a limited number of cases, their stability is not assured to |
---|
| 55 | the 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 | |
---|
[260] | 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 typical cases, so it |
---|
| 63 | should work to a large degree (and if it doesn't -- let me know!) |
---|
[229] | 64 | |
---|
| 65 | Obtaining and Building Duchamp |
---|
| 66 | ------------------------------ |
---|
| 67 | |
---|
| 68 | The Duchamp web page is at |
---|
| 69 | http://www.atnf.csiro.au/people/Matthew.Whiting/Duchamp |
---|
| 70 | where you can download a gzipped tar archive of the source code. |
---|
| 71 | |
---|
| 72 | Duchamp uses three main external libraries: pgplot, cfitsio (version |
---|
| 73 | 2.5 and greater, version 3+ preferred) and wcslib. If you do not have |
---|
| 74 | the libraries, they can be downloaded from the following locations: |
---|
| 75 | |
---|
| 76 | PGPlot -- http://www.astro.caltech.edu/~tjp/pgplot/ |
---|
| 77 | cfitsio -- http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html |
---|
| 78 | wcslib -- http://www.atnf.csiro.au/people/Mark.Calabretta/WCS/index.html |
---|
| 79 | |
---|
| 80 | Duchamp can be built on Unix systems by typing (note that the terminal |
---|
| 81 | prompt here is represented by > -- don't type this character!): |
---|
| 82 | |
---|
| 83 | > ./configure |
---|
| 84 | > make |
---|
| 85 | > make clean (optional -- to remove the object files from the src |
---|
| 86 | directory) |
---|
| 87 | |
---|
| 88 | This way, configure should find all the necessary libraries, but if |
---|
| 89 | the above-mentioned libraries have been installed in non-standard |
---|
| 90 | locations, you can specify additional directories to look in. There |
---|
| 91 | are separate options for library files (eg. libcpgplot.a) and header |
---|
| 92 | files (eg. cpgplot.h). |
---|
| 93 | |
---|
| 94 | For example, suppose wcslib had been locally installed in |
---|
| 95 | /home/mduchamp/wcslib. There will then be two libraries created that |
---|
| 96 | are likely to be in separate subdirectories: C/ and pgsbox/. Each |
---|
| 97 | subdirectory needs to be searched for library and header files, so one |
---|
| 98 | could build Duchamp by typing: |
---|
| 99 | |
---|
| 100 | > ./configure \ |
---|
| 101 | LIBDIRS="/home/mduchamp/wcslib/C /home/mduchamp/wcslib/pgsbox" \ |
---|
| 102 | INCDIRS="/home/mduchamp/wcslib/C /home/mduchamp/wcslib/pgsbox" |
---|
| 103 | And then just run make in the usual fashion: |
---|
| 104 | > make |
---|
| 105 | |
---|
| 106 | There is a script included in the distribution that allows you to make |
---|
| 107 | sure Duchamp is running correctly. It will use a dummy FITS image in |
---|
| 108 | the verification/ directory -- this image has some Gaussian random |
---|
| 109 | noise, with five Gaussian sources present, plus a dummy WCS. The |
---|
| 110 | script runs Duchamp on this image with three different sets of inputs, |
---|
| 111 | and compares to known results, looking for differences and reporting |
---|
| 112 | any. There should be none reported if everything is working |
---|
| 113 | correctly. To run, enter the command |
---|
| 114 | |
---|
| 115 | > VerifyDuchamp.sh |
---|
| 116 | |
---|
| 117 | You can also use the dummy image for your own testing if you like (for |
---|
| 118 | instance, testing different thresholds to get a feel for how the |
---|
| 119 | program works). |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | Using Duchamp |
---|
| 123 | --------------- |
---|
| 124 | |
---|
| 125 | There are two possible ways to run Duchamp. The first is: |
---|
| 126 | |
---|
| 127 | > Duchamp -f image.fits |
---|
| 128 | |
---|
| 129 | where image.fits is the data cube to be searched. This method simply |
---|
| 130 | uses the default values of all parameters. |
---|
| 131 | |
---|
| 132 | The second method allows some determination of the parameter values by |
---|
| 133 | the user. Type: |
---|
| 134 | |
---|
| 135 | > Duchamp -p parameterFile |
---|
| 136 | |
---|
| 137 | where parameterFile is a file with the input parameters, including the |
---|
| 138 | name of the cube you want to search. There are two example input files |
---|
| 139 | included with the distribution. The smaller one, InputExample, shows |
---|
| 140 | the typical parameters one might want to set. The large one, |
---|
| 141 | InputComplete, lists all possible parameters that can be entered, and |
---|
| 142 | a brief description of them. To get going quickly, just replace the |
---|
| 143 | "your-file-here" in InputExample with your image name, and type |
---|
| 144 | |
---|
| 145 | > Duchamp -p InputExample |
---|
| 146 | |
---|
| 147 | A User's Guide in the docs/ directory provides complete |
---|
| 148 | documentation. It comes in both postscript and portable document |
---|
| 149 | format (pdf -- note that this contains hyperlinks). This guide will |
---|
| 150 | provide full descriptions of all parameters, and of all steps in the |
---|
| 151 | execution of Duchamp. |
---|
| 152 | |
---|
| 153 | Any questions, please contact me. To report problems or bugs, or to |
---|
| 154 | suggest improvements, please go to the Duchamp Trac wiki site: |
---|
| 155 | http://sourcecode.atnf.csiro.au/cgi-bin/trac_duchamp.cgi/newticket |
---|
| 156 | and submit a "ticket", or view previously submitted reports. |
---|
| 157 | |
---|
| 158 | Author: |
---|
| 159 | Matthew Whiting, Australia Telescope National Facility, January 2007 |
---|
| 160 | Matthew.Whiting@csiro.au |
---|
| 161 | |
---|