[71] | 1 | # FULL PARAMETER LIST |
---|
| 2 | # ------------------- |
---|
| 3 | # |
---|
[142] | 4 | # This file contains the full list of user-definable parameters. They are |
---|
[1321] | 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 | # |
---|
[1321] | 9 | # In the comments at the start of each section, each parameter is listed followed |
---|
| 10 | # by its datatype (in []) and, where applicable, a description of the allowed range |
---|
| 11 | # of values or types of inputs accepted (in {}), followed by a more verbose description. |
---|
[71] | 12 | # |
---|
[1321] | 13 | # |
---|
[1304] | 14 | ### INPUT RELATED |
---|
[1321] | 15 | #* imageFile [string] {filename (must exist)} -- The FITS image. THERE IS NO DEFAULT FOR THIS. |
---|
| 16 | #* flagSubsection [bool] {true or false, or 1 or 0} -- Whether to get a subsection of that image. |
---|
| 17 | #* subsection [string] {Subsection specification like [x1:x2,y1:y2,z1:z2]} -- The subsection to read in, in format [x1:x2,y1:y2,z1:z2], or * to indicate the full range |
---|
| 18 | #* flagReconExists [bool] {true or false, or 1 or 0} -- Set to true if the reconstructed cube exists as a FITS file (ie. it has been saved from a previous Duchamp run) |
---|
| 19 | #* reconFile [string] {filename (must exist)} -- The location of the FITS file containing the reconstructed cube |
---|
| 20 | #* flagSmoothExists [bool] {true or false, or 1 or 0} -- Set to true if the smoothed cube exists as a FITS file (ie. it has been saved from a previous Duchamp run) |
---|
| 21 | #* smoothFile [string] {filename (must exist)} -- The location of the FITS file containing the smoothed cube |
---|
| 22 | #* usePrevious [bool] {true or false, or 1 or 0} -- Whether to read the list of detected objects from a previously-created log file |
---|
| 23 | #* objectList [string] {comma-separated list of object numbers (integers)} -- The list of objects to plot in individual plots: used with usePrevious=true |
---|
[3] | 24 | |
---|
[1321] | 25 | imageFile your-file-here |
---|
| 26 | flagSubsection false |
---|
| 27 | subsection "" |
---|
| 28 | flagReconExists false |
---|
| 29 | reconFile your-reconstructed-file-here |
---|
[965] | 30 | flagSmoothExists false |
---|
[1321] | 31 | smoothFile your-smoothed-file-here |
---|
| 32 | usePrevious false |
---|
| 33 | objectList * |
---|
[3] | 34 | |
---|
[1304] | 35 | ### OUTPUT RELATED |
---|
[1321] | 36 | #* flagLog [bool] {true or false, or 1 or 0} -- Log the intermediate results? |
---|
| 37 | #* logfile [string] {filename} -- The file to put that in. |
---|
| 38 | #* outFile [string] {filename} -- The final output list. |
---|
| 39 | #* flagSeparateHeader [bool] {true or false, or 1 or 0} -- Whether to write the header information (i.e. parameters, statistics and number of detections) to a separate file from the outFile (so that the outFile just contains the table of detections). |
---|
| 40 | #* headerFile [string] {filename} -- The file to write the header information to. |
---|
| 41 | #* flagWriteBinaryCatalogue [bool] {true or false, or 1 or 0} -- Whether to create a binary catalogue indicating the pixel locations of detected objects (for later reuse) |
---|
| 42 | #* binaryCatalogue [string] {filename} -- The file containing the binary source catalogue |
---|
| 43 | #* flagPlotSpectra [bool] {true or false, or 1 or 0} -- Whether to produce a file showing spectra of each detection |
---|
| 44 | #* spectraFile [string] {filename} -- The postscript file of spectra |
---|
| 45 | #* flagPlotIndividualSpectra [bool] {true or false, or 1 or 0} -- Whether to also write individual source spectra postscript files |
---|
| 46 | #* flagTextSpectra [bool] {true or false, or 1 or 0} -- Whether to save a text file detailing the spectra of each source |
---|
| 47 | #* spectraTextFile [string] {filename} -- The file in which to save the text-formatted spectra |
---|
| 48 | #* flagOutputBaseline [bool] {true or false, or 1 or 0} -- Whether to save a FITS file containing the cube of baseline values |
---|
| 49 | #* fileOutputBaseline [string] {filename} -- The filename for the baseline FITS file. If not given, it defaults to the format shown (for input file image.fits) |
---|
| 50 | #* flagOutputMomentMap [bool] {true or false, or 1 or 0} -- Whether to save a FITS file containing the moment-0 map |
---|
| 51 | #* fileOutputMomentMap [string] {filename} -- The filename for the moment-0 FITS file. If not given, it defaults to the format shown (for input file image.fits) |
---|
| 52 | #* flagOutputMomentMask [bool] {true or false, or 1 or 0} -- Whether to save a FITS file containing the moment-0 mask image |
---|
| 53 | #* fileOutputMomentMask [string] {filename} -- The filename for the moment-0 mask FITS file. If not given, it defaults to the format shown (for input file image.fits) |
---|
| 54 | #* flagOutputMask [bool] {true or false, or 1 or 0} -- Whether to save a FITS file containing a mask array, showing the locations of detected objects |
---|
| 55 | #* fileOutputMask [string] {filename} -- The filename for the mask file. If not given, it defaults to the format shown (for input file image.fits) |
---|
| 56 | #* flagMaskWithObjectNum [bool] {true or false, or 1 or 0} -- If true, the detected pixels in the mask array have the object ID number, else they all have the value 1. |
---|
| 57 | #* flagOutputSmooth [bool] {true or false, or 1 or 0} -- Whether to save the smoothed arrays as a FITS file |
---|
| 58 | #* fileOutputSmooth [string] {filename} -- The filename for the smoothed array file. If not given, it defaults to the format shown (for input file image.fits). See documentation for explanation of format. |
---|
| 59 | #* flagOutputRecon/Resid [bool] {true or false, or 1 or 0} -- Whether to save the reconstruction & residual arrays as FITS files |
---|
| 60 | #* fileOutputRecon/Resid [string] {filename} -- The filename for the reconstruction or residual files. If not given, it defaults to the format shown (for input file image.fits). See documentation for explanation of format. |
---|
| 61 | #* flagVOT [bool] {true or false, or 1 or 0} -- Make a VOTable file of the results? |
---|
| 62 | #* votFile [string] {filename} -- The file to put it in |
---|
| 63 | #* flagKarma [bool] {true or false, or 1 or 0} -- Make a Karma annotation file of the results? |
---|
| 64 | #* karmaFile [string] {filename} -- The file to put it in |
---|
| 65 | #* flagDS9 [bool] {true or false, or 1 or 0} -- Make a DS9 region file of the results? |
---|
| 66 | #* ds9File [string] {filename} -- The file to put it in |
---|
| 67 | #* flagCasa [bool] {true or false, or 1 or 0} -- Make a CASA region file of the results? |
---|
| 68 | #* casaFile [string] {filename} -- The file to put it in |
---|
[1322] | 69 | #* annotationType [string] {borders/circles/ellipses} -- Which type of annotation plot to use. Options are: borders = outline around detected pixels; circles = circle centred on object with radius encompassing all detected pixels; ellipses = ellipse centred on object with size given by MAJ, MIN, PA |
---|
[1321] | 70 | #* flagMaps [bool] {true or false, or 1 or 0} -- Save postscript versions of the detection and 0th moment maps? |
---|
| 71 | #* detectionMap [string] {filename} -- The postscript file containing the detection map |
---|
| 72 | #* momentMap [string] {filename} -- The postscript files containing the 0th-moment map |
---|
| 73 | #* flagXOutput [bool] {true or false, or 1 or 0} -- Display the moment map in a pgplot window |
---|
| 74 | #* newFluxUnits [string] {units, convertible from FITS file units} -- Brightness units to convert the array values to (eg. from Jy/beam to mJy/beam) |
---|
| 75 | #* precFlux [int] {>=0} -- Desired precision for Flux value in outputs. |
---|
| 76 | #* precVel [int] {>=0} -- Desired precision for Velocity/Frequency value in outputs. |
---|
| 77 | #* precSNR [int] {>=0} -- Desired precision for peak SNR value in ouputs. |
---|
[3] | 78 | |
---|
[1321] | 79 | flagLog false |
---|
| 80 | logFile duchamp-Logfile.txt |
---|
| 81 | outFile duchamp-Results.txt |
---|
| 82 | flagSeparateHeader false |
---|
| 83 | headerFile duchamp-Results.hdr |
---|
| 84 | flagWriteBinaryCatalogue true |
---|
| 85 | binaryCatalogue duchamp-Catalogue.dpc |
---|
| 86 | flagPlotSpectra true |
---|
| 87 | spectraFile duchamp-Spectra.ps |
---|
[1150] | 88 | flagPlotIndividualSpectra false |
---|
[1321] | 89 | flagTextSpectra false |
---|
| 90 | spectraTextFile duchamp-Spectra.txt |
---|
| 91 | flagOutputBaseline false |
---|
| 92 | fileOutputBaseline image.BASE.fits |
---|
| 93 | flagOutputMomentMap false |
---|
| 94 | fileOutputMomentMap image.MOM0.fits |
---|
| 95 | flagOutputMomentMask false |
---|
| 96 | fileOutputMomentMask image.MOM0MASK.fits |
---|
| 97 | flagOutputMask false |
---|
| 98 | fileOutputMask image.MASK.fits |
---|
| 99 | flagMaskWithObjectNum false |
---|
| 100 | flagOutputSmooth false |
---|
| 101 | fileOutputSmooth image.SMOOTH-ND-X.fits |
---|
| 102 | flagOutputRecon false |
---|
| 103 | fileOutputRecon image.RECON-A-B-C-D.fits |
---|
| 104 | flagOutputResid false |
---|
| 105 | fileOutputResid image.RESID-A-B-C-D.fits |
---|
| 106 | flagVOT false |
---|
| 107 | votFile duchamp-Results.xml |
---|
| 108 | flagKarma false |
---|
| 109 | karmaFile duchamp-Results.ann |
---|
| 110 | flagDS9 false |
---|
| 111 | ds9File duchamp-Results.reg |
---|
| 112 | flagCasa false |
---|
| 113 | casaFile duchamp-Results.crf |
---|
[1322] | 114 | annotationType borders |
---|
[1321] | 115 | flagMaps true |
---|
| 116 | detectionMap duchamp-DetectionMap.ps |
---|
| 117 | momentMap duchamp-MomentMap.ps |
---|
| 118 | flagXOutput true |
---|
| 119 | newFluxUnits no-default |
---|
| 120 | precFlux 3 |
---|
| 121 | precVel 3 |
---|
| 122 | precSNR 2 |
---|
[3] | 123 | |
---|
[1304] | 124 | ### MODIFYING THE CUBE |
---|
[1321] | 125 | #* flagTrim [bool] {true or false, or 1 or 0} -- Whether to trim blank pixels from the edges of the cube. |
---|
| 126 | #* flagBaseline [bool] {true or false, or 1 or 0} -- Whether to subtract spectral baselines before searching |
---|
[1322] | 127 | #* flaggedChannels [string] {comma-separated list of channels} -- List of channels to ignore in the source-finding |
---|
[1321] | 128 | #* baselineType [string] {either 'atrous' or 'median'} -- Which type of baseline estimation to use. Only 'atrous' or 'median' modes accepted. |
---|
| 129 | #* baselineBoxWidth [int] {odd integer > 0} -- Box width used by the median baseline algorithm |
---|
[3] | 130 | |
---|
[1321] | 131 | flagTrim false |
---|
| 132 | flaggedChannels "" |
---|
| 133 | flagBaseline false |
---|
| 134 | baselineType atrous |
---|
| 135 | baselineBoxWidth 51 |
---|
[3] | 136 | |
---|
[1305] | 137 | ### GENERAL DETECTION RELATED |
---|
[1321] | 138 | #* flagStatSec [bool] {true or false, or 1 or 0} -- Whether to only use a subsection of the cube to calculate the statistics. |
---|
[1322] | 139 | #* StatSec [string] {Subsection specification like [x1:x2,y1:y2,z1:z2]} -- The subsection used for statistics calculations. It has the same format as the pixel subsection. |
---|
[1321] | 140 | #* flagRobustStats [bool] {true or false, or 1 or 0} -- Shall we use robust statistics to characterise the noise in the image? |
---|
| 141 | #* flagNegative [bool] {true or false, or 1 or 0} -- Are the features being searched for negative (set to true) or positive (false -- the default)? |
---|
[1326] | 142 | #* snrCut [float] {any} -- How many sigma above mean is a detection when sigma-clipping |
---|
| 143 | #* threshold [float] {any} -- The threshold flux dividing source and non-source. Used instead of calculating it from the cube's statistics. If not specified, it will be calculated. |
---|
[1321] | 144 | #* flagGrowth [bool] {true or false, or 1 or 0} -- Should the detections be "grown" to a lower significance value? |
---|
| 145 | #* growthCut [float] {any} -- The lower threshold used when growing detections |
---|
| 146 | #* growthThreshold [float] {any} -- The lower threshold, used in conjunction with "threshold" |
---|
| 147 | #* beamarea [float] {> 0.} -- The area of the beam in pixels (equivalent to the old beamsize parameter). This value is overridden by the BMAJ, BMIN, BPA header parameters if present. |
---|
| 148 | #* beamFWHM [float] {> 0.} -- The full-width at half-maximum of the beam, in pixels. Where given, it overrides beamarea, but is overridden by the BMAJ, BMIN, BPA headers. |
---|
| 149 | #* searchType [string] {either 'spatial' or 'spectral'} -- How the searching is done. Either "spatial", where each 2D map is searched then detections combined, or "spectral", where each 1D spectrum is searched then detections combined. |
---|
[3] | 150 | |
---|
[965] | 151 | flagStatSec false |
---|
[1321] | 152 | StatSec "" |
---|
[965] | 153 | flagRobustStats true |
---|
| 154 | flagNegative false |
---|
[1025] | 155 | snrCut 5. |
---|
[195] | 156 | threshold 0. |
---|
[965] | 157 | flagGrowth false |
---|
| 158 | growthCut 3. |
---|
[483] | 159 | growthThreshold 0. |
---|
[801] | 160 | beamArea 0. |
---|
| 161 | beamFWHM 0. |
---|
[686] | 162 | searchType spatial |
---|
[3] | 163 | |
---|
[1321] | 164 | ### RECONSTRUCTION RELATED |
---|
| 165 | #* flagATrous [bool] {true or false, or 1 or 0} -- Whether or not to do the reconstruction before searching |
---|
[1335] | 166 | #* reconDim [int] {1, 2 or 3} -- The number of dimensions in which to perform the reconstruction. |
---|
[1321] | 167 | #* scaleMin [int] {> 0} -- The minimum scale (starts at 1) to be included in the reconstruction |
---|
| 168 | #* scaleMax [int] {any} -- The maximum scale to be included in the reconstruction. If it is <=0 then the maximum scale is calculated from the size of the array being reconstructed. |
---|
[1322] | 169 | #* snrRecon [float] {> 0} -- The threshold used in filtering the wavelet coefficient arrays. |
---|
[1321] | 170 | #* reconConvergence [float] {> 0.} -- The relative change in the residual rms must be less than this to stop the a trous iterations. |
---|
| 171 | #* filterCode [int] {one of 1,2,3} -- The code number for the choice of filter to be used in the reconstruction: 1 = B3-spline filter, 2 = Triangle function, 3 = Haar wavelet. Other numbers default to 1. |
---|
[3] | 172 | |
---|
[1321] | 173 | flagATrous false |
---|
| 174 | reconDim 1 |
---|
| 175 | scaleMin 1 |
---|
| 176 | scaleMax 0 |
---|
| 177 | snrRecon 4. |
---|
[1026] | 178 | reconConvergence 0.005 |
---|
[1321] | 179 | filterCode 1 |
---|
[3] | 180 | |
---|
[1321] | 181 | ### SMOOTHING |
---|
| 182 | #* flagSmooth [bool] {true or false, or 1 or 0} -- Whether to smooth the cube. |
---|
| 183 | #* smoothType [string] {either 'spectral' or 'spatial'} -- The type of smoothing to use, either "spectral" or "spatial" |
---|
| 184 | #* hanningWidth [int] {> 0} -- The width parameter of the Hanning (spectral smoothing) function |
---|
| 185 | #* kernMaj [float] {> 0.} -- The FWHM (in pixels) of the major axis of the 2D spatial smoothing gaussian |
---|
| 186 | #* kernMin [float] {> 0.} -- The FWHM (in pixels) of the minor axis of the 2D spatial smoothing gaussian |
---|
| 187 | #* kernPA [float] {any} -- The position angle (in degrees) of the major axis of the 2D spatial smoothing gaussian |
---|
| 188 | #* smoothEdgeMethod [string] {one of 'equal', 'truncate' or 'scale'} -- How to deal with the pixels at the edge of the image when using the 2D smoothing algorith. Can be equal, truncate, or scale. |
---|
[1327] | 189 | #* spatialSmoothCutoff [float] {> 0.} -- Relative cutoff used to determine the width of the 2D smoothing kernel |
---|
[211] | 190 | |
---|
[1321] | 191 | flagSmooth false |
---|
| 192 | smoothType spectral |
---|
| 193 | hanningWidth 5 |
---|
| 194 | kernMaj 3. |
---|
| 195 | kernMin -1. |
---|
| 196 | kernPA 0. |
---|
| 197 | smoothEdgeMethod equal |
---|
| 198 | spatialSmoothCutoff 1.e-10 |
---|
[211] | 199 | |
---|
[1321] | 200 | ### FALSE DISCOVERY RATE METHOD |
---|
| 201 | #* flagFDR [bool] {true or false, or 1 or 0} -- Whether or not to use the false discovery rate method instead of simple sigma clipping. |
---|
| 202 | #* alphaFDR [float] {0. - 1.} -- The "alpha" parameter for the FDR method -- what desired fraction of discoveries will be false. Expressed as a decimal. |
---|
| 203 | #* FDRnumCorChan [int] {>0} -- The number of neighbouring channels that are correlated. This is used only in the FDR algorithm |
---|
[3] | 204 | |
---|
[965] | 205 | flagFDR false |
---|
[71] | 206 | alphaFDR 0.01 |
---|
[543] | 207 | FDRnumCorChan 2 |
---|
[3] | 208 | |
---|
[1321] | 209 | ### MERGING PARAMETERS |
---|
| 210 | #* flagAdjacent [bool] {true or false, or 1 or 0} -- Whether to use the "adjacent criterion" to judge if objects are to be merged. |
---|
| 211 | #* threshSpatial [float] {>= 0.} -- If flagAdjacent=false, this is the maximum spatial separation between objects for them to be merged. |
---|
| 212 | #* threshVelocity [float] {>= 0.} -- The maximum channel separation between objects for them to be merged. |
---|
| 213 | #* minChannels [int] {> 0} -- The minimum number of consecutive channels an object must have for it to be accepted. |
---|
| 214 | #* minPix [int] {> 0} -- Minimum number of spatial pixels a detected object must have for it to be counted |
---|
| 215 | #* minVoxels [int] {> 0} -- Minimum number of voxels a detected object must have for it to be counted |
---|
| 216 | #* maxChannels [int] {any} -- The maximum number of channels an object must have for it to be accepted. |
---|
| 217 | #* maxPix [int] {any} -- Maximum number of spatial pixels a detected object must have for it to be counted |
---|
| 218 | #* maxVoxels [int] {any} -- Maximum number of voxels a detected object must have for it to be counted |
---|
| 219 | #* flagRejectBeforeMerge [bool] {true or false, or 1 or 0} -- If true, reject sources for not meeting the above criteria before the merging stage |
---|
| 220 | #* flagTwoStageMerging [bool] {true or false, or 1 or 0} -- If true, do an initial merge of a new source to the list (that is, merge it with the first source in the list that is close, but stop there) |
---|
[3] | 221 | |
---|
[965] | 222 | flagAdjacent true |
---|
[691] | 223 | threshSpatial 3 |
---|
| 224 | threshVelocity 7 |
---|
| 225 | minChannels 3 |
---|
| 226 | minPix 2 |
---|
[720] | 227 | minVoxels 4 |
---|
[1291] | 228 | maxChannels -1 |
---|
| 229 | maxPix -1 |
---|
| 230 | maxVoxels -1 |
---|
[965] | 231 | flagRejectBeforeMerge false |
---|
| 232 | flagTwoStageMerging true |
---|
[3] | 233 | |
---|
[1321] | 234 | ### WCS PARAMETERS |
---|
| 235 | #* spectralType [string] {a valid WCS type} -- An alternative spectral WCS type to use for spectral transformations. |
---|
| 236 | #* restFrequency [float] {any} -- A value of the rest frequency to override any provided in the FITS header. Negative values will be ignored. |
---|
| 237 | #* spectralUnits [string] {valid units string} -- What units you want the spectral axis to be plotted in and values quoted in (including the units of integrated flux) |
---|
[965] | 238 | |
---|
[1321] | 239 | spectralType "" |
---|
[965] | 240 | restFrequency -1 |
---|
[1321] | 241 | spectralUnits "" |
---|
[965] | 242 | |
---|
[1321] | 243 | ### OTHER PARAMETERS |
---|
| 244 | #* verbose [bool] {true or false, or 1 or 0} -- Whether to provide progress indicators on the terminal during execution |
---|
| 245 | #* drawBorders [bool] {true or false, or 1 or 0} -- Whether to draw borders around the detections on the moment maps in the output. |
---|
| 246 | #* drawBlankEdges [bool] {true or false, or 1 or 0} -- Whether to draw an outline around any BLANK regions in the moment maps and image cutouts. |
---|
| 247 | #* spectralMethod [string] {either 'peak' or 'sum'} -- How to plot the spectra in the output -- the spectrum of the peak pixel ("peak" -- the default), or integrated over all spatial pixels present ("sum") |
---|
| 248 | #* pixelCentre [string] {one of 'centroid', 'average' or 'peak'} -- Which option to use for quoting the centre of the detection. Options are: centroid (flux-weighted average position), average (simple average with no weighting), peak (brightest pixel). |
---|
| 249 | #* sortingParam [string] {one of 'xvalue', 'yvalue', 'zvalue', 'ra', 'dec', 'vel', 'w50', 'iflux', 'pflux', 'snr'} -- The parameter by which the final detection list is sorted |
---|
[142] | 250 | |
---|
[965] | 251 | verbose true |
---|
| 252 | drawBorders true |
---|
| 253 | drawBlankEdges true |
---|
[64] | 254 | spectralMethod peak |
---|
[363] | 255 | pixelCentre centroid |
---|
[1321] | 256 | sortingParam vel |
---|