source: trunk/InputComplete @ 201

Last change on this file since 201 was 195, checked in by Matthew Whiting, 18 years ago

Implemented a request (from ticket:1) for the ability to not display the pgplot
window showing the moment map. This is now switched on and off by the
flagXOutput parameter.
Updated code and documentation.

File size: 5.5 KB
RevLine 
[71]1# FULL PARAMETER LIST
2# -------------------
3#
[142]4# This file contains the full list of user-definable parameters. They are
5#  grouped here according to their use, and the values quoted are the defaults:
6#  if a given parameter is not included in your parameter file, this is the
7#  value it will take.
[71]8#
9#
[3]10# INPUT RELATED
11# imageFile -- the FITS image.
12# flagSubsection -- whether to get a subsection of that image.
13# subsection -- the subsection to read in, in format [x1:x2,y1:y2,z1:z2],
14#               or * to indicate the full range
[142]15# flagReconExists -- set to true if the reconstructed image exists as a FITS
16#                    file (ie. it has been saved from a previous Duchamp run)
[71]17# reconFile -- the location of the FITS file containing the reconstructed image
[3]18
19imageFile       your-file-here
[71]20flagSubsection  0
[3]21subsection      [*,*,*]
[71]22flagReconExists 0
23reconFile       your-reconstructed-file-here
[3]24
25# OUTPUT RELATED
[142]26# flagLog -- log the intermediate results?   
27# logfile-- the file to put that in.
[3]28# outFile -- the final output list.
29# spectraFile -- the postscript file of spectra
[142]30# flagOutputRecon/Resid -- whether to save the reconstruction & residual arrays
31#                          as FITS files
32# flagVOT -- make a VOTable file of the results? 
33# votFile -- the file to put it in
34# flagKarma -- make a Karma annotation file of the results? 
35# karmaFile -- the file to put it in
[17]36# flagMaps -- save postscript versions of the detection and 0th moment maps?
[3]37# detectionMap, momentMap -- the postscript files produced.
[195]38# flagXOutput -- display the moment map in a pgplot window
[3]39
40flagLog         1
[87]41logFile         duchamp-Logfile.txt
42outFile         duchamp-Results.txt
43spectraFile     duchamp-Spectra.ps
[3]44flagOutputRecon 0
45flagOutputResid 0
46flagVOT         0
[87]47votFile         duchamp-Results.xml
[26]48flagKarma       0
[87]49karmaFile       duchamp-Results.ann
[3]50flagMaps        1
[87]51detectionMap    duchamp-DetectionMap.ps
52momentMap       duchamp-MomentMap.ps
[195]53flagXOutput     1
[3]54
55# FIXING UP THE CUBE
56# flagBlankPix -- whether to replace & ignore blank pixels.
[142]57# blankPixValue -- what value they should take. This is overridden by
58#                  FITS header information.
[3]59# flagBaseline -- whether to subtract spectral baselines before searching
[142]60# flagMW -- ignore a range of channels (to remove Milky Way emission)?
61# minMW, maxMW -- the first and last channels to be ignored
[3]62
63flagBlankPix    1
64blankPixValue   -8.00061
[71]65flagMW          0
[3]66minMW           75
67maxMW           112
[87]68flagBaseline    0
[3]69
70# GENERAL DETECTION RELATED
[142]71# flagNegative -- Are the features being searched for negative (set to true)
72#                 or positive (false -- the default)?
[3]73# snrCut --  How many sigma above mean is a detection when sigma-clipping
[195]74# threshold -- The threshold flux dividing source and non-source. Used instead
75#              of calculating it from the cube's statistics. If not specified,
76#              it will be calculated.
[3]77# flagGrowth -- Should the detections be "grown" to a lower significance value?
78# growthCut -- The lower threshold used when growing detections
79
[63]80flagNegative    0
[71]81snrCut          3.
[195]82threshold       0.
[3]83flagGrowth      0
[87]84growthCut       2.
[3]85
86# RECONSTRUCTION RELATED
87# flagATrous -- Whether or not to do the reconstruction before searching
[142]88# reconDim -- The number of dimensions in which to perform the reconstruction.
89# scaleMin -- The minimum scale (starts at 1) to be included in the
90#              reconstruction
[3]91# snrRecon -- The threshold used in filtering the wavelet coefficient arrays.
[142]92# filterCode -- The code number for the choice of filter to be used in the
93#               reconstruction:  1 = B3-spline filter, 2 = Triangle function,
94#                                3 = Haar wavelet. Other numbers default to 2.
[3]95
96flagATrous      1
[103]97reconDim        3
[3]98scaleMin        1
[71]99snrRecon        4.
[106]100filterCode      1
[3]101
102# FALSE DISCOVERY RATE METHOD
103# flagFDR -- Whether or not to use the false discovery rate method instead of
104#   simple sigma clipping.
[142]105# alphaFDR -- The "alpha" parameter for the FDR method -- what desired
106#             percentage of discoveries will be false. Expressed as a decimal.
[3]107
108flagFDR         0
[71]109alphaFDR        0.01
[3]110
111# MERGING PARAMETERS
[142]112# flagAdjacent -- Whether to use the "adjacent criterion" to judge if objects
113#                  are to be merged.
114# threshSpatial -- If flagAdjacent=false, this is the maximum spatial
115#                   separation between objects for them to be merged.
116# threshVelocity -- The maximum channel separation between objects for them
117#                   to be merged.
118# minChannels -- The minimum number of consecutive channels an object must have
119#                 for it to be accepted.
120# minPix -- Minimum number of spatial pixels a detected object must have for
121#            it to be counted
[3]122
123flagAdjacent    1
124threshSpatial   3
125threshVelocity  7
[71]126minChannels     3
127minPix          2
[3]128
129# OTHER PARAMETERS
[142]130# verbose -- whether to provide progress indicators on the terminal during
131#             execution
132# drawBorders -- whether to draw borders around the detections on the moment
133#                 maps in the output.
134# drawBlankEdges -- whether to draw an outline around any BLANK regions in the
135#                    moment maps and image cutouts.
136# spectralMethod -- how to plot the spectra in the output -- the spectrum of
137#                    the peak pixel ("peak" -- the default), or integrated over
138#                    all spatial pixels present ("sum")
139# spectralUnits -- what units you want the spectral axis to be plotted in and
140#                   values quoted in (including the units of integrated flux)
141
[3]142verbose         1
143drawBorders     1
[142]144drawBlankEdges  1
[64]145spectralMethod  peak
[103]146spectralUnits   km/s
Note: See TracBrowser for help on using the repository browser.