source: tags/release-1.6.1/docs/app-param.tex

Last change on this file was 1335, checked in by MatthewWhiting, 10 years ago

Minor change to allowed values of reconDim

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