[303] | 1 | % ----------------------------------------------------------------------- |
---|
| 2 | % app-param.tex: Section listing all the possible input parameters and |
---|
| 3 | % their defaults. |
---|
| 4 | % ----------------------------------------------------------------------- |
---|
| 5 | % Copyright (C) 2006, Matthew Whiting, ATNF |
---|
| 6 | % |
---|
| 7 | % This program 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 [at] 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 | % ----------------------------------------------------------------------- |
---|
[158] | 29 | \secA{Available parameters} |
---|
| 30 | \label{app-param} |
---|
| 31 | |
---|
| 32 | The full list of parameters that can be listed in the input file are |
---|
| 33 | given here. If not listed, they take the default value given in |
---|
| 34 | parentheses. Since the order of the parameters in the input file does |
---|
| 35 | not matter, they are grouped here in logical sections. |
---|
| 36 | |
---|
[208] | 37 | \secB*{Input related} |
---|
[306] | 38 | \begin{Lentry} |
---|
| 39 | \item[{ImageFile [no default]}] The filename of the |
---|
| 40 | data cube to be analysed. |
---|
| 41 | \item[{flagSubsection [false]}] A flag to indicate whether one |
---|
[158] | 42 | wants a subsection of the requested image. |
---|
[306] | 43 | \item[{Subsection [ [*,*,*] ]}] The requested subsection |
---|
[258] | 44 | -- see \S\ref{sec-input} for details on the subsection format. If |
---|
| 45 | the full range of a dimension is required, use a \texttt{*} (thus the |
---|
| 46 | default is the full cube). |
---|
[306] | 47 | \item[{flagReconExists [false]}] A flag to indicate whether the |
---|
[158] | 48 | reconstructed array has been saved by a previous run of \duchamp. If |
---|
| 49 | set true, the reconstructed array will be read from the file given |
---|
| 50 | by \texttt{reconFile}, rather than calculated directly. |
---|
[306] | 51 | \item[{reconFile [no default]}] The FITS file that contains the |
---|
[158] | 52 | reconstructed array. If \texttt{flagReconExists} is true and this |
---|
[231] | 53 | parameter is not defined, the default file that is looked for will |
---|
[258] | 54 | be determined by the \atrous parameters (see \S\ref{sec-recon}). |
---|
[306] | 55 | \item[{flagSmoothExists [false]}] A flag to indicate whether the |
---|
[208] | 56 | Hanning-smoothed array has been saved by a previous run of \duchamp. If |
---|
| 57 | set true, the smoothed array will be read from the file given |
---|
| 58 | by \texttt{smoothFile}, rather than calculated directly. |
---|
[306] | 59 | \item[{smoothFile [no default]}] The FITS file that has |
---|
| 60 | a previously smoothed array. If \texttt{flagSmoothExists} |
---|
| 61 | is true and this parameter is not defined, the default file that is |
---|
| 62 | looked for will be determined by the smoothing parameters (see |
---|
[208] | 63 | \S\ref{sec-smoothing}). |
---|
[480] | 64 | \item[{usePrevious [false]}] A flag to indicate that \duchamp should |
---|
| 65 | read the list of objects from a previously-created log file, rather |
---|
| 66 | than doing the searching itself. The set of outputs will be created |
---|
| 67 | according to the flags in the following section. |
---|
| 68 | \item[{objectList [no default]}] When \texttt{usePrevious=true}, this |
---|
| 69 | list is used to output individual spectral plots, as well as a |
---|
| 70 | postscript file for all spectral plots as given by |
---|
| 71 | \texttt{SpectraFile}. The filenames of the plots will be the same as |
---|
| 72 | \texttt{SpectraFile}, but with -XX at the end, where XX is the |
---|
| 73 | object number (\eg \texttt{duchamp-Spectra-07.ps}). The format of |
---|
| 74 | the parameter value should be a string listing individual objects or |
---|
| 75 | object ranges: \eg 1,2,4-7,8,14. |
---|
[306] | 76 | \end{Lentry} |
---|
[208] | 77 | |
---|
| 78 | \secB*{Output related} |
---|
[306] | 79 | \begin{Lentry} |
---|
| 80 | \item[{OutFile [duchamp-\\Results.txt]}] The file containing the |
---|
[158] | 81 | final list of detections. This also records the list of input |
---|
[364] | 82 | parameters. |
---|
| 83 | \item[{flagSeparateHeader [false]}] A flag to indicate that the header |
---|
| 84 | information that would normally be printed at the start of the |
---|
| 85 | results file (containing information on the parameters, image |
---|
| 86 | statistics and number of detections) should instead be written to a |
---|
| 87 | separate file. |
---|
| 88 | \item[{HeaderFile [duchamp-\\Results.hdr]}] The file to which the |
---|
[373] | 89 | header information should be written when |
---|
[364] | 90 | \texttt{flagSeparateHeader=true}. |
---|
[1151] | 91 | \item[{flagWriteBinaryCatalogue [true]}] Whether to write a binary |
---|
| 92 | catalogue of the detections, for later re-use (see |
---|
[1159] | 93 | \S\ref{sec-reuse} for details). |
---|
[1151] | 94 | \item[{binaryCatalogue [duchamp-Catalogue.dpc]}] The filename for the |
---|
| 95 | binary catalogue. |
---|
[831] | 96 | \item[{flagPlotSpectra [true]}] Whether to produce a postscript file |
---|
[840] | 97 | containing spectra of all detected objects. If PGPlot has not been |
---|
| 98 | enabled, this parameter defaults to \texttt{false}. |
---|
[306] | 99 | \item[{SpectraFile [duchamp-\\Spectra.ps]}] The postscript file |
---|
[1021] | 100 | that contains the resulting integrated spectra and images of the |
---|
[425] | 101 | detections. |
---|
[1151] | 102 | \item[{flagPlotIndividualSpectra [false]}] Whether to produce |
---|
| 103 | individual spectral plots for listed sources. |
---|
[425] | 104 | \item[{flagTextSpectra [false]}] A flag to say whether the spectra |
---|
| 105 | should be saved in text form in a single file. See below for a |
---|
| 106 | description. |
---|
| 107 | \item[{spectraTextFile [duchamp-\\Spectra.txt]}] The file containing |
---|
| 108 | the spectra of each object in ascii format. This file will have a |
---|
| 109 | column showing the spectral coordinates, and one column for each of |
---|
| 110 | the detected objects, showing the flux values as plotted in the |
---|
| 111 | graphical output of \texttt{spectraFile}. |
---|
[306] | 112 | \item[{flagLog [false]}] A flag to indicate whether the |
---|
[231] | 113 | details of intermediate detections should be logged. |
---|
[306] | 114 | \item[{LogFile [duchamp-\\Logfile.txt]}] The file in which |
---|
[1021] | 115 | intermediate detections and the pixel content of the final list of |
---|
| 116 | detections are logged. These are detections that have not been |
---|
| 117 | merged. This is primarily for use in debugging and diagnostic |
---|
| 118 | purposes: normal use of the program will probably not require it. |
---|
[670] | 119 | \item[{flagOutputMomentMap [false]}] A flag to say whether or not to save a |
---|
| 120 | FITS file containing the moment-0 map. |
---|
| 121 | \item[fileOutputMomentMap{ [see text]}] The file to which the moment-0 array is |
---|
| 122 | written. If left blank (the default), the naming scheme detailed in |
---|
[1142] | 123 | \S\ref{sec-momentOut} is used. |
---|
| 124 | \item[{flagOutputMomentMask [false]}] A flag to say whether or not to save a |
---|
| 125 | FITS file containing the moment-0 mask (a mask showing which spatial |
---|
| 126 | pixels are detected in one or more channels). |
---|
| 127 | \item[fileOutputMomentMask{ [see text]}] The file to which the moment-0 mask is |
---|
| 128 | written. If left blank (the default), the naming scheme detailed in |
---|
[1028] | 129 | \S\ref{sec-maskOut} is used. |
---|
[380] | 130 | \item[{flagOutputMask [false]}] A flag to say whether or not to save a |
---|
| 131 | FITS file containing a mask array, with values 1 where there is a |
---|
[525] | 132 | detected object and 0 elsewhere. |
---|
| 133 | \item[fileOutputMask{ [see text]}] The file to which the mask array is |
---|
| 134 | written. If left blank (the default), the naming scheme detailed in |
---|
[1028] | 135 | \S\ref{sec-maskOut} is used. |
---|
[522] | 136 | \item[{flagMaskWithObjectNum [false]}] If this flag is true, the |
---|
| 137 | detected pixels in the mask image have the corresponding object ID |
---|
| 138 | as their value. If false, they have the value 1. All non-detected |
---|
| 139 | pixels have the value 0. |
---|
[306] | 140 | \item[{flagOutputRecon [false]}] A flag to say whether or not |
---|
[525] | 141 | to save the reconstructed cube as a FITS file. |
---|
| 142 | \item[fileOutputRecon{ [see text]}] The file to which the reconstructed array |
---|
| 143 | is written. If left blank (the default), the naming scheme detailed |
---|
[1028] | 144 | in \S\ref{sec-reconIO} is used. |
---|
[306] | 145 | \item[{flagOutputResid [false]}] As for |
---|
[158] | 146 | \texttt{flagOutputRecon}, but for the residual array -- the |
---|
[525] | 147 | difference between the original cube and the reconstructed cube. |
---|
| 148 | \item[fileOutputResid{ [see text]}] The file to which the residual array |
---|
| 149 | is written. If left blank (the default), the naming scheme detailed |
---|
[1028] | 150 | in \S\ref{sec-reconIO} is used. |
---|
[306] | 151 | \item[{flagOutputSmooth [false]}] A flag to say whether or not |
---|
[525] | 152 | to save the smoothed cube as a FITS file. |
---|
| 153 | \item[fileOutputSmooth{ [see text]}] The file to which the smoothed array |
---|
| 154 | is written. If left blank (the default), the naming scheme detailed |
---|
[1028] | 155 | in \S\ref{sec-reconIO} is used. |
---|
[1162] | 156 | \item[{flagOutputBaseline [false]}] A flag to say whether or not |
---|
| 157 | to save the cube of spectral baseline values as a FITS file. |
---|
| 158 | \item[fileOutputBaseline{ [see text]}] The file to which the baseline |
---|
| 159 | values are written. If left blank (the default), the naming scheme |
---|
| 160 | detailed in \S\ref{sec-baselineOut} is used. |
---|
[306] | 161 | \item[{flagVOT [false]}] A flag to say whether to create a |
---|
| 162 | VOTable file with the detection information. This will be an XML |
---|
| 163 | file in the Virtual Observatory VOTable format. |
---|
| 164 | \item[{votFile [duchamp-\\Results.xml]}] The VOTable file with |
---|
[158] | 165 | the list of final detections. Some input parameters are also |
---|
[306] | 166 | recorded. |
---|
| 167 | \item[{flagKarma [false]}] A flag to say whether to create a |
---|
[158] | 168 | Karma annotation file corresponding to the information in |
---|
[306] | 169 | \texttt{outfile}. This can be used as an overlay in Karma |
---|
[158] | 170 | programs such as \texttt{kvis}. |
---|
[306] | 171 | \item[{karmaFile [duchamp-\\Results.ann]}] The Karma annotation |
---|
[447] | 172 | file showing the list of final detections. |
---|
[1078] | 173 | \item[{flagDS9 [false]}] A flag to say whether to create a |
---|
| 174 | DS9 region file corresponding to the information in |
---|
| 175 | \texttt{outfile}. This can be used as an overlay in SAOImage DS9 or |
---|
| 176 | casaviewer. |
---|
[1151] | 177 | \item[{ds9File [duchamp-\\Results.ann]}] The DS9 region file showing |
---|
[1078] | 178 | the list of final detections. |
---|
[1151] | 179 | \item[{flagCasa [false]}] A flag to say whether to create a |
---|
| 180 | CASA region file corresponding to the information in |
---|
| 181 | \texttt{outfile}. This can be used as an overlay in casaviewer (when |
---|
| 182 | this functionality is available) or import into casapy. |
---|
| 183 | \item[{casaFile [duchamp-\\Results.crf]}] The CASA region file showing |
---|
| 184 | the list of final detections. |
---|
[447] | 185 | \item[{annotationType [borders]}] Which type of annotation plot to |
---|
| 186 | use. Specifying ``borders'' gives an outline around the detected |
---|
[1161] | 187 | spatial pixels, ``circles'' gives a circle centred on the |
---|
[447] | 188 | centre of the object with radius large enough to encompass all |
---|
[1161] | 189 | spatial pixels, and ``ellipses'' gives an ellipse centred on the |
---|
| 190 | centre of the object of size given by the MAJ, MIN \& PA values. |
---|
[840] | 191 | \item[{flagMaps [true]}] A flag to say whether to save postscript |
---|
[1021] | 192 | files showing the 0th moment map of the whole cube |
---|
| 193 | (\texttt{momentMap}) and the detection image |
---|
[840] | 194 | (\texttt{detectionMap}). If PGPlot has not been enabled, this |
---|
| 195 | parameter defaults to \texttt{false}. |
---|
[306] | 196 | \item[{momentMap [duchamp-\\MomentMap.ps]}] A postscript file |
---|
[158] | 197 | containing a map of the 0th moment of the detected sources, as well |
---|
| 198 | as pixel and WCS coordinates. |
---|
[306] | 199 | \item[{detectionMap [duchamp-\\DetectionMap.ps]}] A postscript |
---|
| 200 | file with a map showing each of the detected objects, coloured in |
---|
| 201 | greyscale by the number of detected channels in each spatial |
---|
| 202 | pixel. Also shows pixel and WCS coordinates. |
---|
| 203 | \item[{flagXOutput [true]}] A flag to say whether to display a |
---|
[294] | 204 | 0th moment map in a PGPlot X-window. This will be in addition to any |
---|
| 205 | that are saved to a file. This parameter can be overridden by the |
---|
| 206 | use of the \texttt{-x} command-line option, which disables the |
---|
[840] | 207 | X-windows output. If PGPlot has not been enabled, this parameter |
---|
| 208 | defaults to \texttt{false}. |
---|
[447] | 209 | \item[{newFluxUnits [no default]}] Flux units that the pixel values |
---|
| 210 | should be converted into. These should be directly compatible with |
---|
[1021] | 211 | the units in the FITS header, given by the BUNIT keyword. |
---|
[447] | 212 | \item[{precFlux [3]}] The desired precision (\ie number of decimal |
---|
| 213 | places) for flux values given in the output files and tables. |
---|
| 214 | \item[{precVel [3]}] The desired precision (\ie number of decimal |
---|
| 215 | places) for velocity/frequency values given in the output files and |
---|
| 216 | tables. |
---|
| 217 | \item[{precSNR [2]}] The desired precision (\ie number of decimal |
---|
| 218 | places) for the peak SNR value given in the output files and tables. |
---|
[306] | 219 | \end{Lentry} |
---|
[158] | 220 | |
---|
| 221 | \secB*{Modifying the cube} |
---|
[306] | 222 | \begin{Lentry} |
---|
| 223 | \item[{flagTrim [false]}] A flag to say whether to trim |
---|
[285] | 224 | BLANK pixels from the edges of the cube -- these are typically |
---|
| 225 | pixels set to some particular value because they fall outside the |
---|
| 226 | imaged area, and trimming them can help speed up the execution. |
---|
[306] | 227 | \item[{flagMW [false]}] A flag to say whether to ignore |
---|
[158] | 228 | channels contaminated by Milky Way (or other) emission -- the |
---|
| 229 | searching algorithms will not look at these channels. |
---|
[306] | 230 | \item[{maxMW [112]}] The maximum channel number that contains |
---|
[673] | 231 | ``Milky Way'' emission. This is the channel number in the original |
---|
| 232 | cube, before any subsection is applied. |
---|
| 233 | \item[{minMW [75]}] The minimum channel number that contains ``Milky |
---|
| 234 | Way'' emission. This is the channel number in the original cube, |
---|
| 235 | before any subsection is applied. Note that the range specified by |
---|
[158] | 236 | \texttt{maxMW} and \texttt{minMW} is inclusive. |
---|
[306] | 237 | \item[{flagBaseline [false]}] A flag to say whether to remove |
---|
[158] | 238 | the baseline from each spectrum in the cube for the purposes of |
---|
| 239 | reconstruction and detection. |
---|
[306] | 240 | \end{Lentry} |
---|
[158] | 241 | |
---|
| 242 | \secB*{Detection related} |
---|
| 243 | |
---|
| 244 | \secC*{General detection} |
---|
[306] | 245 | \begin{Lentry} |
---|
[1021] | 246 | \item[{searchType [spatial]}] How the searches are done. Only |
---|
| 247 | ``spatial'' and ``spectral'' are accepted. A value of ``spatial'' |
---|
| 248 | means each 2D channel map is searched, whereas ``spectral'' means |
---|
| 249 | each 1D spectrum is searched. |
---|
[306] | 250 | \item[{flagStatSec [false]}] A flag indicating whether the |
---|
[258] | 251 | statistics should be calculated on a subsection of the cube, rather |
---|
[265] | 252 | than the full cube. Note that this only applies to the statistics |
---|
| 253 | used to determine the threshold, and not for other statistical |
---|
| 254 | calculations (such as those in the reconstruction phase). |
---|
[306] | 255 | \item[{StatSec [ [*,*,*] ]}] The subsection of the cube used |
---|
[258] | 256 | for calculating statistics -- see \S\ref{sec-input} for details on |
---|
| 257 | the subsection format. Only used if \texttt{flagStatSec=true}. |
---|
[386] | 258 | \item[{flagRobustStats [true]}] A flag indicating whether to use the |
---|
| 259 | robust statistics (median and MADFM) to estimate the noise |
---|
[1021] | 260 | parameters of the cube, rather than the mean and rms. See |
---|
| 261 | \S\ref{sec-stats} for details. |
---|
[306] | 262 | \item[{flagNegative [false]}] A flag indicating that the |
---|
| 263 | features of interest are negative. The cube is inverted prior to |
---|
| 264 | searching. |
---|
[1035] | 265 | \item[{snrCut [5.]}] The threshold, in multiples of $\sigma$ above |
---|
[306] | 266 | the mean. |
---|
| 267 | \item[{threshold [no default]}] The actual value of the |
---|
[194] | 268 | threshold. Normally the threshold is calculated from the cube's |
---|
| 269 | statistics, but the user can manually specify a value to be used |
---|
| 270 | that overrides the calculated value. If this is not specified, the |
---|
[462] | 271 | calculated value is used, but this value will take precedence over |
---|
| 272 | other means of calculating the threshold (\ie via \texttt{snrCut} or |
---|
| 273 | the FDR method). |
---|
[306] | 274 | \item[{flagGrowth [false]}] A flag indicating whether or not to |
---|
[158] | 275 | grow the detected objects to a smaller threshold. |
---|
[462] | 276 | \item[{growthCut [3.]}] The smaller threshold using in growing |
---|
[158] | 277 | detections. In units of $\sigma$ above the mean. |
---|
[462] | 278 | \item[{growthThreshold [no default]}] Alternatively, the threshold to |
---|
| 279 | which detections are grown can be specified in flux units (in the |
---|
| 280 | same manner as the \texttt{threshold} parameter). When the |
---|
| 281 | \texttt{threshold} parameter is given, this option \textbf{must} be |
---|
| 282 | used instead of \texttt{growthCut}. |
---|
[801] | 283 | \item[{beamFWHM [0.]}] The full-width at half maximum of the beam, in |
---|
[675] | 284 | pixels. If the header keywords BMAJ and BMIN are present, then |
---|
| 285 | these will be used to calculate the beam area, and this parameter |
---|
| 286 | will be ignored. This will take precedence over \texttt{beamArea} |
---|
| 287 | (but is ignored if not specified). |
---|
[801] | 288 | \item[{beamArea [0.]}] The \textbf{area} of the beam in pixels (\ie |
---|
[675] | 289 | how many pixel does the beam cover?). As above, if the header |
---|
| 290 | keywords BMAJ and BMIN are present, then these will be used to |
---|
| 291 | calculate the beam area, and this parameter will be ignored. |
---|
[306] | 292 | \end{Lentry} |
---|
[158] | 293 | |
---|
[258] | 294 | \secC*{\Atrous reconstruction} |
---|
[306] | 295 | \begin{Lentry} |
---|
| 296 | \item[{flagATrous [false]}] A flag indicating whether or not to |
---|
[258] | 297 | reconstruct the cube using the \atrous wavelet |
---|
[158] | 298 | reconstruction. See \S\ref{sec-recon} for details. |
---|
[306] | 299 | \item[{reconDim [1]}] The number of dimensions to use in the |
---|
[158] | 300 | reconstruction. 1 means reconstruct each spectrum separately, 2 |
---|
| 301 | means each channel map is done separately, and 3 means do the whole |
---|
| 302 | cube in one go. |
---|
[306] | 303 | \item[{scaleMin [1]}] The minimum wavelet scale to be used in the |
---|
[158] | 304 | reconstruction. A value of 1 means ``use all scales''. |
---|
[364] | 305 | \item[{scaleMax [0]}] The maximum wavelet scale to be used in the |
---|
| 306 | reconstruction. If the value is $\le0$ then the maximum scale is |
---|
| 307 | calculated from the size of the input array. Similarly, if the value |
---|
| 308 | given is larger than this calculated value, the calculated value is |
---|
| 309 | used instead. |
---|
[306] | 310 | \item[{snrRecon [4]}] The thresholding cutoff used in the |
---|
[1021] | 311 | reconstruction -- only wavelet coefficients at least this many $\sigma$ above |
---|
| 312 | the mean are included in the reconstruction. |
---|
[1029] | 313 | \item[{reconConvergence [0.005]}] The convergence criterion used in |
---|
[1026] | 314 | the reconstruction. The \atrous algorithm iterates until the |
---|
| 315 | relative change in the standard deviation of the residuals is less |
---|
| 316 | than this amount. |
---|
[306] | 317 | \item[{filterCode [1]}] The code number of the filter to use in |
---|
[158] | 318 | the reconstruction. The options are: |
---|
| 319 | \begin{itemize} |
---|
| 320 | \item \textbf{1:} B$_3$-spline filter: coefficients = |
---|
| 321 | $(\frac{1}{16}, \frac{1}{4}, \frac{3}{8}, \frac{1}{4}, \frac{1}{16})$ |
---|
| 322 | \item \textbf{2:} Triangle filter: coefficients = |
---|
| 323 | $(\frac{1}{4}, \frac{1}{2}, \frac{1}{4})$ |
---|
| 324 | \item \textbf{3:} Haar wavelet: coefficients = |
---|
| 325 | $(0, \frac{1}{2}, \frac{1}{2})$ |
---|
| 326 | \end{itemize} |
---|
[306] | 327 | \end{Lentry} |
---|
[158] | 328 | |
---|
[208] | 329 | \secC*{Smoothing the cube} |
---|
[306] | 330 | \begin{Lentry} |
---|
| 331 | \item[{flagSmooth [false]}] A flag indicating whether to |
---|
[275] | 332 | smooth the cube. See \S\ref{sec-smoothing} for details. |
---|
[306] | 333 | \item[{smoothType [spectral]}] The smoothing method used: either |
---|
| 334 | ``spectral'' (with a 1D Hanning filter) or ``spatial'' (with a 2D |
---|
| 335 | Gaussian filter). |
---|
| 336 | \item[{hanningWidth [5]}] The width of the Hanning smoothing |
---|
| 337 | kernel. |
---|
| 338 | \item[{kernMaj [3]}] The full-width-half-maximum (FWHM) of the |
---|
| 339 | 2D Gaussian smoothing kernel's major axis. |
---|
| 340 | \item[{kernMin [3]}] The FWHM of the 2D Gaussian smoothing kernel's |
---|
| 341 | minor axis. |
---|
| 342 | \item[{kernPA [0]}] The position angle, in degrees, |
---|
| 343 | anticlockwise from vertical (\ie usually East of North). |
---|
| 344 | \end{Lentry} |
---|
[208] | 345 | |
---|
[158] | 346 | \secC*{FDR method} |
---|
[306] | 347 | \begin{Lentry} |
---|
| 348 | \item[{flagFDR [false]}] A flag indicating whether or not to use |
---|
[158] | 349 | the False Discovery Rate method in thresholding the pixels. |
---|
[306] | 350 | \item[{alphaFDR [0.01]}] The $\alpha$ parameter used in the FDR |
---|
| 351 | analysis. The average number of false detections, as a fraction of |
---|
| 352 | the total number, will be less than $\alpha$ (see |
---|
[543] | 353 | \S\ref{sec-detection}). |
---|
| 354 | \item[{FDRnumCorChan [2]}] The number of neighbouring spectral |
---|
| 355 | channels that are assumed to be correlated. This is needed by the |
---|
| 356 | FDR algorithm to calculate the normalisation constant $c_N$ (see |
---|
[306] | 357 | \S\ref{sec-detection}). |
---|
| 358 | \end{Lentry} |
---|
[158] | 359 | |
---|
| 360 | \secC*{Merging detections} |
---|
[306] | 361 | \begin{Lentry} |
---|
| 362 | \item[{minPix [2]}] The minimum number of spatial pixels for a |
---|
[158] | 363 | single detection to be counted. |
---|
[306] | 364 | \item[{minChannels [3]}] At least one contiguous set of this many |
---|
| 365 | channels must be present in the detection for it to be accepted. |
---|
[964] | 366 | \item[{minVoxels [minPix $+$ minChannels - 1]}] The minimum size of |
---|
| 367 | the object, in terms of the total number of voxels, for it to be |
---|
| 368 | accepted. This will be \textit{at least} minPix$+$minChannels$-$1, |
---|
| 369 | but can be set higher. |
---|
[672] | 370 | \item[{flagRejectBeforeMerge [false]}] A flag indicating whether to |
---|
| 371 | reject sources that fail to meet the \texttt{minPix} or |
---|
| 372 | \texttt{minChannels} criteria \textbf{before} the merging |
---|
| 373 | stage. Default behaviour is to do the rejection last. |
---|
[691] | 374 | \item[{flagTwoStageMerging [true]}] A flag indicating whether to do an |
---|
| 375 | initial merge of newly-detected sources into the source list as they |
---|
| 376 | are found. If \texttt{false}, new sources are simply added to the |
---|
| 377 | end of the list for later merging. |
---|
[306] | 378 | \item[{flagAdjacent [true]}] A flag indicating whether to use |
---|
[158] | 379 | the ``adjacent pixel'' criterion to decide whether to merge |
---|
| 380 | objects. If not, the next two parameters are used to determine |
---|
| 381 | whether objects are within the necessary thresholds. |
---|
[306] | 382 | \item[{threshSpatial [3.]}] The maximum allowed minimum spatial |
---|
[158] | 383 | separation (in pixels) between two detections for them to be merged |
---|
| 384 | into one. Only used if \texttt{flagAdjacent = false}. |
---|
[306] | 385 | \item[{threshVelocity [7.]}] The maximum allowed minimum channel |
---|
[158] | 386 | separation between two detections for them to be merged into |
---|
| 387 | one. |
---|
[306] | 388 | \end{Lentry} |
---|
[158] | 389 | |
---|
[964] | 390 | \secC*{WCS parameters} |
---|
| 391 | \begin{Lentry} |
---|
| 392 | \item[{spectralType []}] The user can specify an alternative WCS |
---|
| 393 | spectral type that the spectral axis can be expressed in. This |
---|
| 394 | specification should conform to the standards described in |
---|
| 395 | \citet{greisen06}, although it is possible to provide just the first |
---|
| 396 | four letters (the ``S-type'', \eg 'VELO'). |
---|
| 397 | \item[{restFrequency [-1]}] If provided, this will be used in |
---|
| 398 | preference to the rest frequency given in the FITS header to |
---|
| 399 | calculate velocities and related quantities. A negative value (such |
---|
| 400 | as the default) will mean this is not used and the FITS header |
---|
| 401 | value, if present, is used instead. |
---|
| 402 | \item[{spectralUnits []}] The user can specify the units of |
---|
| 403 | the spectral axis, overriding those given in the FITS header. If the |
---|
| 404 | spectral type is being changed, these units should be appropriate |
---|
| 405 | for that quantity. If not provided, the FITS header information is |
---|
| 406 | used. |
---|
| 407 | \end{Lentry} |
---|
| 408 | |
---|
[158] | 409 | \secC*{Other parameters} |
---|
[306] | 410 | \begin{Lentry} |
---|
| 411 | \item[{spectralMethod [peak]}] This indicates which method is used |
---|
[158] | 412 | to plot the output spectra: \texttt{peak} means plot the spectrum |
---|
| 413 | containing the detection's peak pixel; \texttt{sum} means sum the |
---|
| 414 | spectra of each detected spatial pixel, and correct for the beam |
---|
| 415 | size. Any other choice defaults to \texttt{peak}. |
---|
[306] | 416 | \item[{pixelCentre [centroid]}] Which of the three ways of |
---|
[285] | 417 | expressing the ``centre'' of a detection (see \S\ref{sec-results} |
---|
| 418 | for a description of the options) to use for the X, Y, \& Z |
---|
| 419 | columns in the output list. Alternatives are: \texttt{centroid, peak, |
---|
[571] | 420 | average}. |
---|
| 421 | \item[{sortingParam [vel]}] The parameter on which to sort the output |
---|
[964] | 422 | list of detected objects. Options are: xvalue, yvalue, zvalue, ra, |
---|
| 423 | dec, vel, w50, iflux, pflux (integrated and peak flux respectively), |
---|
| 424 | or snr. If the parameter begins with a '-' (\eg '-vel'), the order |
---|
| 425 | of the sort is reversed. |
---|
[306] | 426 | \item[{drawBorders [true]}] A flag indicating whether to draw |
---|
| 427 | borders around the detected objects in the moment maps included in |
---|
| 428 | the output (see for example Fig.~\ref{fig-spect}). |
---|
| 429 | \item[{drawBlankEdges [true]}] A flag indicating whether to |
---|
| 430 | draw the dividing line between BLANK and non-BLANK pixels on the |
---|
| 431 | 2D images (see for example Fig.~\ref{fig-moment}). |
---|
| 432 | \item[{verbose [true]}] A flag indicating whether to print the |
---|
| 433 | progress of any computationally intensive algorithms (\eg |
---|
[231] | 434 | reconstruction, searching or merging algorithms) to the screen. |
---|
[306] | 435 | \end{Lentry} |
---|
[158] | 436 | |
---|
[964] | 437 | |
---|
| 438 | %%% Local Variables: |
---|
| 439 | %%% mode: latex |
---|
| 440 | %%% TeX-master: "Guide" |
---|
| 441 | %%% End: |
---|