[303] | 1 | % ----------------------------------------------------------------------- |
---|
| 2 | % userInputs.tex: Quick guide to how the input parameters are read. |
---|
| 3 | % ----------------------------------------------------------------------- |
---|
| 4 | % Copyright (C) 2006, Matthew Whiting, ATNF |
---|
| 5 | % |
---|
| 6 | % This program is free software; you can redistribute it and/or modify it |
---|
| 7 | % under the terms of the GNU General Public License as published by the |
---|
| 8 | % Free Software Foundation; either version 2 of the License, or (at your |
---|
| 9 | % option) any later version. |
---|
| 10 | % |
---|
| 11 | % Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
| 12 | % ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
| 13 | % FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
| 14 | % for more details. |
---|
| 15 | % |
---|
| 16 | % You should have received a copy of the GNU General Public License |
---|
| 17 | % along with Duchamp; if not, write to the Free Software Foundation, |
---|
| 18 | % Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
| 19 | % |
---|
| 20 | % Correspondence concerning Duchamp may be directed to: |
---|
| 21 | % Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
| 22 | % Postal address: Dr. Matthew Whiting |
---|
| 23 | % Australia Telescope National Facility, CSIRO |
---|
| 24 | % PO Box 76 |
---|
| 25 | % Epping NSW 1710 |
---|
| 26 | % AUSTRALIA |
---|
| 27 | % ----------------------------------------------------------------------- |
---|
[158] | 28 | \secA{User Inputs} |
---|
[1159] | 29 | |
---|
| 30 | \secB{Parameter file input} |
---|
[158] | 31 | \label{sec-param} |
---|
| 32 | |
---|
[1159] | 33 | \duchamp allows a large degree of control over the way the different |
---|
| 34 | algorithms work. This is done by means of input parameters, specified |
---|
| 35 | through a parameter file. The parameter file is provided at runtime, |
---|
| 36 | via |
---|
[232] | 37 | \begin{quote} |
---|
[1159] | 38 | {\footnotesize |
---|
| 39 | \texttt{> Duchamp -p [parameter file]} |
---|
| 40 | } |
---|
| 41 | \end{quote} |
---|
| 42 | The parameter file simply contains a list of parameter names followed |
---|
| 43 | by the value that should be assigned to them. The syntax used is |
---|
| 44 | \begin{quote} |
---|
[309] | 45 | \texttt{parameterName value}. |
---|
[232] | 46 | \end{quote} |
---|
| 47 | Parameter names are not case-sensitive, and lines in the input |
---|
[158] | 48 | file that start with \texttt{\#} are ignored. If a parameter is listed |
---|
| 49 | more than once, the latter value is used, but otherwise the order in |
---|
| 50 | which the parameters are listed in the input file is |
---|
| 51 | arbitrary. Example input files can be seen in |
---|
| 52 | Appendix~\ref{app-input}. |
---|
| 53 | |
---|
| 54 | If a parameter is not listed, the default value is assumed. The |
---|
[1028] | 55 | defaults are chosen to provide a good result (a simple $5\sigma$ |
---|
| 56 | search with no pre-processing), so the user doesn't need to specify |
---|
| 57 | many new parameters in the input file. Note that the image file |
---|
| 58 | \textbf{must} be specified! The parameters that can be set are listed |
---|
| 59 | in Appendix~\ref{app-param}, with their default values in parentheses. |
---|
[158] | 60 | |
---|
| 61 | The parameters with names starting with \texttt{flag} are stored as |
---|
| 62 | \texttt{bool} variables, and so are either \texttt{true = 1} or |
---|
| 63 | \texttt{false = 0}. They can be entered in the file either in text or |
---|
[258] | 64 | integer format -- \duchamp will read them correctly in either case. |
---|
[158] | 65 | |
---|
[162] | 66 | An example input file is included in the distribution tar file. It is |
---|
| 67 | as follows: |
---|
[158] | 68 | |
---|
| 69 | \begin{verbatim} |
---|
| 70 | imageFile your-file-here |
---|
| 71 | logFile logfile.txt |
---|
| 72 | outFile results.txt |
---|
| 73 | spectraFile spectra.ps |
---|
| 74 | minPix 2 |
---|
| 75 | flagATrous 1 |
---|
| 76 | snrRecon 5. |
---|
| 77 | snrCut 3. |
---|
| 78 | minChannels 3 |
---|
| 79 | flagBaseline 1 |
---|
[231] | 80 | \end{verbatim} |
---|
[158] | 81 | |
---|
| 82 | You would, of course, replace the ``\texttt{your-file-here}'' with the |
---|
| 83 | FITS file you wanted to search. Further examples are given in |
---|
| 84 | Appendix~\ref{app-input}. |
---|
[1159] | 85 | |
---|
| 86 | \secB{Command-line control} |
---|
| 87 | |
---|
| 88 | \duchamp provides the ability to run without constructing a parameter |
---|
| 89 | file first. Using the \texttt{-f} command-line flag to specify an |
---|
| 90 | image will make use of the default values for all parameters: |
---|
| 91 | \begin{quote} |
---|
| 92 | {\footnotesize |
---|
| 93 | \texttt{> Duchamp -f [FITS image]} |
---|
| 94 | } |
---|
| 95 | \end{quote} |
---|
| 96 | |
---|
| 97 | It is possible to specify a flux threshold as well on the command |
---|
| 98 | line, using the \texttt{-t} flag. This allows the user to quickly |
---|
| 99 | search a given image to a given depth (\ie give me all sources in this |
---|
| 100 | image above 1mJy. |
---|
| 101 | \begin{quote} |
---|
| 102 | {\footnotesize |
---|
| 103 | \texttt{> Duchamp -f [FITS image] -t [THRESHOLD]} |
---|
| 104 | } |
---|
| 105 | \end{quote} |
---|
| 106 | The \texttt{-t} flag can also be used with the \texttt{-p} option -- |
---|
| 107 | it sets the \texttt{threshold} parameter, and overrides the value |
---|
| 108 | provided in the parameter file specified. The flux threshold should be |
---|
| 109 | in the same brightness units as specified in the FITS image. |
---|
| 110 | |
---|
| 111 | The other command-line flag that can be used is \texttt{-x}. This |
---|
| 112 | turns off the X-window output (that graphically shows where the |
---|
| 113 | detected objects are). This makes scripted use of \duchamp somewhat |
---|
| 114 | easier. |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | %%% Local Variables: |
---|
| 119 | %%% mode: latex |
---|
| 120 | %%% TeX-master: "Guide" |
---|
| 121 | %%% End: |
---|