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 | % ----------------------------------------------------------------------- |
---|
28 | \secA{User Inputs} |
---|
29 | \label{sec-param} |
---|
30 | |
---|
31 | Input to the program is provided by means of a parameter |
---|
32 | file. Parameters are listed in the file, followed by the value that |
---|
33 | should be assigned to them. The syntax used is |
---|
34 | \begin{quote} |
---|
35 | \texttt{parameterName value}. |
---|
36 | \end{quote} |
---|
37 | Parameter names are not case-sensitive, and lines in the input |
---|
38 | file that start with \texttt{\#} are ignored. If a parameter is listed |
---|
39 | more than once, the latter value is used, but otherwise the order in |
---|
40 | which the parameters are listed in the input file is |
---|
41 | arbitrary. Example input files can be seen in |
---|
42 | Appendix~\ref{app-input}. |
---|
43 | |
---|
44 | If a parameter is not listed, the default value is assumed. The |
---|
45 | defaults are chosen to provide a good result (using the reconstruction |
---|
46 | method), so the user doesn't need to specify many new parameters in |
---|
47 | the input file. Note that the image file \textbf{must} be specified! |
---|
48 | The parameters that can be set are listed in Appendix~\ref{app-param}, |
---|
49 | with their default values in parentheses. |
---|
50 | |
---|
51 | The parameters with names starting with \texttt{flag} are stored as |
---|
52 | \texttt{bool} variables, and so are either \texttt{true = 1} or |
---|
53 | \texttt{false = 0}. They can be entered in the file either in text or |
---|
54 | integer format -- \duchamp will read them correctly in either case. |
---|
55 | |
---|
56 | An example input file is included in the distribution tar file. It is |
---|
57 | as follows: |
---|
58 | |
---|
59 | \begin{verbatim} |
---|
60 | imageFile your-file-here |
---|
61 | logFile logfile.txt |
---|
62 | outFile results.txt |
---|
63 | spectraFile spectra.ps |
---|
64 | minPix 2 |
---|
65 | flagATrous 1 |
---|
66 | snrRecon 5. |
---|
67 | snrCut 3. |
---|
68 | minChannels 3 |
---|
69 | flagBaseline 1 |
---|
70 | \end{verbatim} |
---|
71 | |
---|
72 | You would, of course, replace the ``\texttt{your-file-here}'' with the |
---|
73 | FITS file you wanted to search. Further examples are given in |
---|
74 | Appendix~\ref{app-input}. |
---|