[158] | 1 | \secA{User Inputs} |
---|
| 2 | \label{sec-param} |
---|
| 3 | |
---|
| 4 | Input to the program is provided by means of a parameter |
---|
| 5 | file. Parameters are listed in the file, followed by the value that |
---|
| 6 | should be assigned to them. The syntax used is \texttt{paramName |
---|
| 7 | value}. Parameter names are not case-sensitive, and lines in the input |
---|
| 8 | file that start with \texttt{\#} are ignored. If a parameter is listed |
---|
| 9 | more than once, the latter value is used, but otherwise the order in |
---|
| 10 | which the parameters are listed in the input file is |
---|
| 11 | arbitrary. Example input files can be seen in |
---|
| 12 | Appendix~\ref{app-input}. |
---|
| 13 | |
---|
| 14 | If a parameter is not listed, the default value is assumed. The |
---|
| 15 | defaults are chosen to provide a good result (using the reconstruction |
---|
| 16 | method), so the user doesn't need to specify many new parameters in |
---|
| 17 | the input file. Note that the image file \textbf{must} be specified! |
---|
| 18 | The parameters that can be set are listed in Appendix~\ref{app-param}, |
---|
| 19 | with their default values in parentheses. |
---|
| 20 | |
---|
| 21 | The parameters with names starting with \texttt{flag} are stored as |
---|
| 22 | \texttt{bool} variables, and so are either \texttt{true = 1} or |
---|
| 23 | \texttt{false = 0}. They can be entered in the file either in text or |
---|
| 24 | integer format -- \duchamp\ will read them correctly in either case. |
---|
| 25 | |
---|
[162] | 26 | An example input file is included in the distribution tar file. It is |
---|
| 27 | as follows: |
---|
[158] | 28 | |
---|
| 29 | \begin{verbatim} |
---|
| 30 | imageFile your-file-here |
---|
| 31 | logFile logfile.txt |
---|
| 32 | outFile results.txt |
---|
| 33 | spectraFile spectra.ps |
---|
| 34 | minPix 2 |
---|
| 35 | flagATrous 1 |
---|
| 36 | snrRecon 5. |
---|
| 37 | snrCut 3. |
---|
| 38 | minChannels 3 |
---|
| 39 | flagBaseline 1 |
---|
| 40 | \end{verbatim}. |
---|
| 41 | |
---|
| 42 | You would, of course, replace the ``\texttt{your-file-here}'' with the |
---|
| 43 | FITS file you wanted to search. Further examples are given in |
---|
| 44 | Appendix~\ref{app-input}. |
---|