[299] | 1 | // ----------------------------------------------------------------------- |
---|
| 2 | // param.cc: Dealing with the set of parameters for Duchamp. |
---|
| 3 | // ----------------------------------------------------------------------- |
---|
| 4 | // Copyright (C) 2006, Matthew Whiting, ATNF |
---|
| 5 | // |
---|
| 6 | // This program is free software; you can redistribute it and/or modify it |
---|
| 7 | // under the terms of the GNU General Public License as published by the |
---|
| 8 | // Free Software Foundation; either version 2 of the License, or (at your |
---|
| 9 | // option) any later version. |
---|
| 10 | // |
---|
| 11 | // Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
| 12 | // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
| 13 | // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
| 14 | // for more details. |
---|
| 15 | // |
---|
| 16 | // You should have received a copy of the GNU General Public License |
---|
| 17 | // along with Duchamp; if not, write to the Free Software Foundation, |
---|
| 18 | // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
| 19 | // |
---|
| 20 | // Correspondence concerning Duchamp may be directed to: |
---|
| 21 | // Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
| 22 | // Postal address: Dr. Matthew Whiting |
---|
| 23 | // Australia Telescope National Facility, CSIRO |
---|
| 24 | // PO Box 76 |
---|
| 25 | // Epping NSW 1710 |
---|
| 26 | // AUSTRALIA |
---|
| 27 | // ----------------------------------------------------------------------- |
---|
[3] | 28 | #include <iostream> |
---|
| 29 | #include <iomanip> |
---|
| 30 | #include <fstream> |
---|
| 31 | #include <sstream> |
---|
| 32 | #include <string> |
---|
[534] | 33 | #include <algorithm> |
---|
[205] | 34 | #include <stdlib.h> |
---|
[269] | 35 | #include <ctype.h> |
---|
[3] | 36 | #include <math.h> |
---|
[410] | 37 | #include <unistd.h> |
---|
[393] | 38 | #include <duchamp/param.hh> |
---|
| 39 | #include <duchamp/fitsHeader.hh> |
---|
| 40 | #include <duchamp/duchamp.hh> |
---|
[420] | 41 | #include <duchamp/pgheader.hh> |
---|
[393] | 42 | #include <duchamp/ATrous/filter.hh> |
---|
| 43 | #include <duchamp/Utils/utils.hh> |
---|
| 44 | #include <duchamp/Utils/Section.hh> |
---|
[438] | 45 | #include <duchamp/Detection/columns.hh> |
---|
[3] | 46 | |
---|
[378] | 47 | namespace duchamp |
---|
[309] | 48 | { |
---|
| 49 | |
---|
[378] | 50 | /****************************************************************/ |
---|
| 51 | /////////////////////////////////////////////////// |
---|
| 52 | //// Accessor Functions for Parameter class: |
---|
| 53 | /////////////////////////////////////////////////// |
---|
| 54 | Param::~Param() |
---|
| 55 | { |
---|
[528] | 56 | /// Deletes the offsets array if the sizeOffsets parameter is |
---|
| 57 | /// positive. |
---|
[378] | 58 | if(this->sizeOffsets>0) delete [] this->offsets; |
---|
| 59 | } |
---|
[309] | 60 | |
---|
[378] | 61 | Param::Param() |
---|
| 62 | { |
---|
| 63 | this->defaultValues(); |
---|
| 64 | } |
---|
[3] | 65 | |
---|
[378] | 66 | void Param::defaultValues() |
---|
| 67 | { |
---|
[528] | 68 | /// Provides default intial values for the parameters. Note that |
---|
| 69 | /// imageFile has no default value! |
---|
| 70 | |
---|
[378] | 71 | std::string baseSection = "[*,*,*]"; |
---|
| 72 | // Input files |
---|
| 73 | this->imageFile = ""; |
---|
| 74 | this->flagSubsection = false; |
---|
| 75 | this->pixelSec.setSection(baseSection); |
---|
| 76 | this->flagReconExists = false; |
---|
| 77 | this->reconFile = ""; |
---|
| 78 | this->flagSmoothExists = false; |
---|
| 79 | this->smoothFile = ""; |
---|
[475] | 80 | this->usePrevious = false; |
---|
| 81 | this->objectList = ""; |
---|
[378] | 82 | // Output files |
---|
| 83 | this->flagLog = false; |
---|
| 84 | this->logFile = "duchamp-Logfile.txt"; |
---|
| 85 | this->outFile = "duchamp-Results.txt"; |
---|
| 86 | this->flagSeparateHeader= false; |
---|
| 87 | this->headerFile = "duchamp-Results.hdr"; |
---|
[831] | 88 | this->flagPlotSpectra = true; |
---|
[378] | 89 | this->spectraFile = "duchamp-Spectra.ps"; |
---|
[424] | 90 | this->flagTextSpectra = false; |
---|
| 91 | this->spectraTextFile = "duchamp-Spectra.txt"; |
---|
[670] | 92 | this->flagOutputMomentMap = false; |
---|
| 93 | this->fileOutputMomentMap = ""; |
---|
[379] | 94 | this->flagOutputMask = false; |
---|
[525] | 95 | this->fileOutputMask = ""; |
---|
[521] | 96 | this->flagMaskWithObjectNum = false; |
---|
[378] | 97 | this->flagOutputSmooth = false; |
---|
[525] | 98 | this->fileOutputSmooth = ""; |
---|
[378] | 99 | this->flagOutputRecon = false; |
---|
[525] | 100 | this->fileOutputRecon = ""; |
---|
[378] | 101 | this->flagOutputResid = false; |
---|
[525] | 102 | this->fileOutputResid = ""; |
---|
[378] | 103 | this->flagVOT = false; |
---|
| 104 | this->votFile = "duchamp-Results.xml"; |
---|
| 105 | this->flagKarma = false; |
---|
| 106 | this->karmaFile = "duchamp-Results.ann"; |
---|
[446] | 107 | this->annotationType = "borders"; |
---|
[378] | 108 | this->flagMaps = true; |
---|
| 109 | this->detectionMap = "duchamp-DetectionMap.ps"; |
---|
| 110 | this->momentMap = "duchamp-MomentMap.ps"; |
---|
| 111 | this->flagXOutput = true; |
---|
[439] | 112 | this->precFlux = Column::prFLUX; |
---|
| 113 | this->precVel = Column::prVEL; |
---|
| 114 | this->precSNR = Column::prSNR; |
---|
[378] | 115 | // Cube related parameters |
---|
| 116 | this->flagBlankPix = true; |
---|
| 117 | this->blankPixValue = -8.00061; |
---|
| 118 | this->blankKeyword = 1; |
---|
| 119 | this->bscaleKeyword = -8.00061; |
---|
| 120 | this->bzeroKeyword = 0.; |
---|
[434] | 121 | this->newFluxUnits = ""; |
---|
[378] | 122 | // Milky-Way parameters |
---|
| 123 | this->flagMW = false; |
---|
| 124 | this->maxMW = 112; |
---|
| 125 | this->minMW = 75; |
---|
[788] | 126 | this->areaBeam = 0.; |
---|
| 127 | this->fwhmBeam = 0.; |
---|
[791] | 128 | this->beamAsUsed.empty(); |
---|
[686] | 129 | this->searchType = "spatial"; |
---|
[378] | 130 | // Trim-related |
---|
| 131 | this->flagTrim = false; |
---|
| 132 | this->hasBeenTrimmed = false; |
---|
| 133 | this->borderLeft = 0; |
---|
| 134 | this->borderRight = 0; |
---|
| 135 | this->borderBottom = 0; |
---|
| 136 | this->borderTop = 0; |
---|
| 137 | // Subsection offsets |
---|
| 138 | this->sizeOffsets = 0; |
---|
| 139 | this->xSubOffset = 0; |
---|
| 140 | this->ySubOffset = 0; |
---|
| 141 | this->zSubOffset = 0; |
---|
| 142 | // Baseline related |
---|
| 143 | this->flagBaseline = false; |
---|
| 144 | // Detection-related |
---|
| 145 | this->flagNegative = false; |
---|
| 146 | // Object growth |
---|
| 147 | this->flagGrowth = false; |
---|
[458] | 148 | this->growthCut = 3.; |
---|
[461] | 149 | this->flagUserGrowthThreshold = false; |
---|
| 150 | this->growthThreshold = 0.; |
---|
[378] | 151 | // FDR analysis |
---|
| 152 | this->flagFDR = false; |
---|
| 153 | this->alphaFDR = 0.01; |
---|
[543] | 154 | this->FDRnumCorChan = 2; |
---|
[378] | 155 | // Other detection |
---|
| 156 | this->flagStatSec = false; |
---|
| 157 | this->statSec.setSection(baseSection); |
---|
[385] | 158 | this->flagRobustStats = true; |
---|
[378] | 159 | this->snrCut = 3.; |
---|
| 160 | this->threshold = 0.; |
---|
| 161 | this->flagUserThreshold = false; |
---|
| 162 | // Smoothing |
---|
| 163 | this->flagSmooth = false; |
---|
| 164 | this->smoothType = "spectral"; |
---|
| 165 | this->hanningWidth = 5; |
---|
| 166 | this->kernMaj = 3.; |
---|
| 167 | this->kernMin = -1.; |
---|
| 168 | this->kernPA = 0.; |
---|
| 169 | // A trous reconstruction parameters |
---|
| 170 | this->flagATrous = false; |
---|
| 171 | this->reconDim = 1; |
---|
| 172 | this->scaleMin = 1; |
---|
| 173 | this->scaleMax = 0; |
---|
| 174 | this->snrRecon = 4.; |
---|
| 175 | this->filterCode = 1; |
---|
| 176 | this->reconFilter.define(this->filterCode); |
---|
| 177 | // Volume-merging parameters |
---|
| 178 | this->flagAdjacent = true; |
---|
| 179 | this->threshSpatial = 3.; |
---|
| 180 | this->threshVelocity = 7.; |
---|
| 181 | this->minChannels = 3; |
---|
| 182 | this->minPix = 2; |
---|
[720] | 183 | this->minVoxels = 4; |
---|
[672] | 184 | this->flagRejectBeforeMerge = false; |
---|
[691] | 185 | this->flagTwoStageMerging = true; |
---|
[378] | 186 | // Input-Output related |
---|
| 187 | this->spectralMethod = "peak"; |
---|
| 188 | this->spectralUnits = "km/s"; |
---|
| 189 | this->pixelCentre = "centroid"; |
---|
[571] | 190 | this->sortingParam = "vel"; |
---|
[378] | 191 | this->borders = true; |
---|
| 192 | this->blankEdge = true; |
---|
| 193 | this->verbose = true; |
---|
[419] | 194 | } |
---|
[204] | 195 | |
---|
[378] | 196 | Param::Param (const Param& p) |
---|
| 197 | { |
---|
| 198 | operator=(p); |
---|
[309] | 199 | } |
---|
[137] | 200 | |
---|
[378] | 201 | Param& Param::operator= (const Param& p) |
---|
| 202 | { |
---|
| 203 | if(this == &p) return *this; |
---|
| 204 | this->imageFile = p.imageFile; |
---|
| 205 | this->flagSubsection = p.flagSubsection; |
---|
| 206 | this->pixelSec = p.pixelSec; |
---|
| 207 | this->flagReconExists = p.flagReconExists; |
---|
| 208 | this->reconFile = p.reconFile; |
---|
| 209 | this->flagSmoothExists = p.flagSmoothExists; |
---|
[475] | 210 | this->smoothFile = p.smoothFile; |
---|
| 211 | this->usePrevious = p.usePrevious; |
---|
| 212 | this->objectList = p.objectList; |
---|
[378] | 213 | this->flagLog = p.flagLog; |
---|
| 214 | this->logFile = p.logFile; |
---|
| 215 | this->outFile = p.outFile; |
---|
| 216 | this->flagSeparateHeader= p.flagSeparateHeader; |
---|
| 217 | this->headerFile = p.headerFile; |
---|
| 218 | this->spectraFile = p.spectraFile; |
---|
[424] | 219 | this->flagTextSpectra = p.flagTextSpectra; |
---|
| 220 | this->spectraTextFile = p.spectraTextFile; |
---|
[670] | 221 | this->flagOutputMomentMap = p.flagOutputMomentMap; |
---|
| 222 | this->fileOutputMomentMap = p.fileOutputMomentMap; |
---|
[379] | 223 | this->flagOutputMask = p.flagOutputMask; |
---|
[525] | 224 | this->fileOutputMask = p.fileOutputMask; |
---|
[521] | 225 | this->flagMaskWithObjectNum = p.flagMaskWithObjectNum; |
---|
[378] | 226 | this->flagOutputSmooth = p.flagOutputSmooth; |
---|
[525] | 227 | this->fileOutputSmooth = p.fileOutputSmooth; |
---|
[378] | 228 | this->flagOutputRecon = p.flagOutputRecon; |
---|
[525] | 229 | this->fileOutputRecon = p.fileOutputRecon; |
---|
[378] | 230 | this->flagOutputResid = p.flagOutputResid; |
---|
[525] | 231 | this->fileOutputResid = p.fileOutputResid; |
---|
[378] | 232 | this->flagVOT = p.flagVOT; |
---|
| 233 | this->votFile = p.votFile; |
---|
| 234 | this->flagKarma = p.flagKarma; |
---|
| 235 | this->karmaFile = p.karmaFile; |
---|
[446] | 236 | this->annotationType = p.annotationType; |
---|
[378] | 237 | this->flagMaps = p.flagMaps; |
---|
| 238 | this->detectionMap = p.detectionMap; |
---|
| 239 | this->momentMap = p.momentMap; |
---|
| 240 | this->flagXOutput = p.flagXOutput; |
---|
[438] | 241 | this->precFlux = p.precFlux; |
---|
| 242 | this->precVel = p.precVel; |
---|
| 243 | this->precSNR = p.precSNR; |
---|
[378] | 244 | this->flagBlankPix = p.flagBlankPix; |
---|
| 245 | this->blankPixValue = p.blankPixValue; |
---|
| 246 | this->blankKeyword = p.blankKeyword; |
---|
| 247 | this->bscaleKeyword = p.bscaleKeyword; |
---|
| 248 | this->bzeroKeyword = p.bzeroKeyword; |
---|
[434] | 249 | this->newFluxUnits = p.newFluxUnits; |
---|
[378] | 250 | this->flagMW = p.flagMW; |
---|
| 251 | this->maxMW = p.maxMW; |
---|
| 252 | this->minMW = p.minMW; |
---|
[662] | 253 | this->areaBeam = p.areaBeam; |
---|
| 254 | this->fwhmBeam = p.fwhmBeam; |
---|
[791] | 255 | this->beamAsUsed = p.beamAsUsed; |
---|
[686] | 256 | this->searchType = p.searchType; |
---|
[378] | 257 | this->flagTrim = p.flagTrim; |
---|
| 258 | this->hasBeenTrimmed = p.hasBeenTrimmed; |
---|
| 259 | this->borderLeft = p.borderLeft; |
---|
| 260 | this->borderRight = p.borderRight; |
---|
| 261 | this->borderBottom = p.borderBottom; |
---|
| 262 | this->borderTop = p.borderTop; |
---|
| 263 | if(this->sizeOffsets>0) delete [] this->offsets; |
---|
| 264 | this->sizeOffsets = p.sizeOffsets; |
---|
| 265 | if(this->sizeOffsets>0){ |
---|
| 266 | this->offsets = new long[this->sizeOffsets]; |
---|
| 267 | for(int i=0;i<this->sizeOffsets;i++) this->offsets[i] = p.offsets[i]; |
---|
| 268 | } |
---|
| 269 | this->xSubOffset = p.xSubOffset; |
---|
| 270 | this->ySubOffset = p.ySubOffset; |
---|
| 271 | this->zSubOffset = p.zSubOffset; |
---|
| 272 | this->flagBaseline = p.flagBaseline; |
---|
| 273 | this->flagNegative = p.flagNegative; |
---|
| 274 | this->flagGrowth = p.flagGrowth; |
---|
| 275 | this->growthCut = p.growthCut; |
---|
[503] | 276 | this->growthThreshold = p.growthThreshold; |
---|
| 277 | this->flagUserGrowthThreshold = p.flagUserGrowthThreshold; |
---|
[378] | 278 | this->flagFDR = p.flagFDR; |
---|
| 279 | this->alphaFDR = p.alphaFDR; |
---|
[543] | 280 | this->FDRnumCorChan = p.FDRnumCorChan; |
---|
[378] | 281 | this->flagStatSec = p.flagStatSec; |
---|
[385] | 282 | this->statSec = p.statSec; |
---|
| 283 | this->flagRobustStats = p.flagRobustStats; |
---|
[378] | 284 | this->snrCut = p.snrCut; |
---|
| 285 | this->threshold = p.threshold; |
---|
| 286 | this->flagUserThreshold = p.flagUserThreshold; |
---|
| 287 | this->flagSmooth = p.flagSmooth; |
---|
| 288 | this->smoothType = p.smoothType; |
---|
| 289 | this->hanningWidth = p.hanningWidth; |
---|
| 290 | this->kernMaj = p.kernMaj; |
---|
| 291 | this->kernMin = p.kernMin; |
---|
| 292 | this->kernPA = p.kernPA; |
---|
| 293 | this->flagATrous = p.flagATrous; |
---|
| 294 | this->reconDim = p.reconDim; |
---|
| 295 | this->scaleMin = p.scaleMin; |
---|
| 296 | this->scaleMax = p.scaleMax; |
---|
| 297 | this->snrRecon = p.snrRecon; |
---|
| 298 | this->filterCode = p.filterCode; |
---|
| 299 | this->reconFilter = p.reconFilter; |
---|
| 300 | this->flagAdjacent = p.flagAdjacent; |
---|
| 301 | this->threshSpatial = p.threshSpatial; |
---|
| 302 | this->threshVelocity = p.threshVelocity; |
---|
| 303 | this->minChannels = p.minChannels; |
---|
| 304 | this->minPix = p.minPix; |
---|
[720] | 305 | this->minVoxels = p.minVoxels; |
---|
[691] | 306 | this->flagRejectBeforeMerge = p.flagRejectBeforeMerge; |
---|
| 307 | this->flagTwoStageMerging = p.flagTwoStageMerging; |
---|
[378] | 308 | this->spectralMethod = p.spectralMethod; |
---|
| 309 | this->spectralUnits = p.spectralUnits; |
---|
| 310 | this->pixelCentre = p.pixelCentre; |
---|
[571] | 311 | this->sortingParam = p.sortingParam; |
---|
[378] | 312 | this->borders = p.borders; |
---|
[571] | 313 | this->blankEdge = p.blankEdge; |
---|
[378] | 314 | this->verbose = p.verbose; |
---|
| 315 | return *this; |
---|
| 316 | } |
---|
| 317 | //-------------------------------------------------------------------- |
---|
[266] | 318 | |
---|
[698] | 319 | OUTCOME Param::getopts(int argc, char ** argv, std::string progname) |
---|
[378] | 320 | { |
---|
[528] | 321 | /// A function that reads in the command-line options, in a manner |
---|
| 322 | /// tailored for use with the main Duchamp program. |
---|
| 323 | /// |
---|
| 324 | /// \param argc The number of command line arguments. |
---|
| 325 | /// \param argv The array of command line arguments. |
---|
[378] | 326 | |
---|
[698] | 327 | OUTCOME returnValue = FAILURE; |
---|
[378] | 328 | if(argc==1){ |
---|
[474] | 329 | if(progname=="Selavy") std::cout << SELAVY_ERR_USAGE_MSG; |
---|
| 330 | else if(progname=="Duchamp") std::cout << ERR_USAGE_MSG; |
---|
| 331 | else std::cout << ERR_USAGE_MSG; |
---|
[378] | 332 | returnValue = FAILURE; |
---|
| 333 | } |
---|
| 334 | else { |
---|
| 335 | std::string file; |
---|
| 336 | bool changeX = false; |
---|
| 337 | this->defaultValues(); |
---|
| 338 | char c; |
---|
| 339 | while( ( c = getopt(argc,argv,"p:f:hvx") )!=-1){ |
---|
| 340 | switch(c) { |
---|
| 341 | case 'p': |
---|
| 342 | file = optarg; |
---|
| 343 | if(this->readParams(file)==FAILURE){ |
---|
| 344 | std::stringstream errmsg; |
---|
| 345 | errmsg << "Could not open parameter file " << file << ".\n"; |
---|
[474] | 346 | duchampError(progname,errmsg.str()); |
---|
[378] | 347 | } |
---|
| 348 | else returnValue = SUCCESS; |
---|
| 349 | break; |
---|
| 350 | case 'f': |
---|
| 351 | file = optarg; |
---|
| 352 | this->imageFile = file; |
---|
| 353 | returnValue = SUCCESS; |
---|
| 354 | break; |
---|
| 355 | case 'v': |
---|
| 356 | std::cout << PROGNAME << " version " << VERSION << std::endl; |
---|
| 357 | break; |
---|
| 358 | case 'x': |
---|
| 359 | changeX = true; |
---|
| 360 | break; |
---|
| 361 | case 'h': |
---|
| 362 | default : |
---|
[474] | 363 | if(progname=="Selavy") std::cout << SELAVY_ERR_USAGE_MSG; |
---|
| 364 | else if(progname=="Duchamp") std::cout << ERR_USAGE_MSG; |
---|
| 365 | else std::cout << ERR_USAGE_MSG; |
---|
[378] | 366 | break; |
---|
[266] | 367 | } |
---|
| 368 | } |
---|
[378] | 369 | if(changeX){ |
---|
| 370 | if(returnValue == SUCCESS) this->setFlagXOutput(false); |
---|
| 371 | else { |
---|
[474] | 372 | duchampError(progname, |
---|
[378] | 373 | "You need to specify either a parameter file or FITS image.\n"); |
---|
| 374 | std::cout << "\n" << ERR_USAGE_MSG; |
---|
| 375 | } |
---|
[294] | 376 | } |
---|
| 377 | } |
---|
[378] | 378 | return returnValue; |
---|
[266] | 379 | } |
---|
[378] | 380 | //-------------------------------------------------------------------- |
---|
[266] | 381 | |
---|
[378] | 382 | bool Param::isBlank(float &value) |
---|
| 383 | { |
---|
[528] | 384 | /// Tests whether the value passed as the argument is BLANK or not. |
---|
| 385 | /// \param value Pixel value to be tested. |
---|
| 386 | /// \return False if flagBlankPix is false. Else, compare to the |
---|
| 387 | /// relevant FITS keywords, using integer comparison. |
---|
| 388 | |
---|
[378] | 389 | return this->flagBlankPix && |
---|
| 390 | (this->blankKeyword == int((value-this->bzeroKeyword)/this->bscaleKeyword)); |
---|
[419] | 391 | } |
---|
[266] | 392 | |
---|
[378] | 393 | bool *Param::makeBlankMask(float *array, int size) |
---|
| 394 | { |
---|
[528] | 395 | /// This returns an array of bools, saying whether each pixel in the |
---|
| 396 | /// given array is BLANK or not. If the pixel is BLANK, set mask to |
---|
| 397 | /// false, else set to true. The array is allocated by the function. |
---|
| 398 | |
---|
[378] | 399 | bool *mask = new bool[size]; |
---|
| 400 | for(int i=0;i<size;i++) mask[i] = !this->isBlank(array[i]); |
---|
| 401 | return mask; |
---|
| 402 | } |
---|
[275] | 403 | |
---|
| 404 | |
---|
[506] | 405 | bool *Param::makeStatMask(float *array, long *dim) |
---|
| 406 | { |
---|
[528] | 407 | /// This returns an array of bools, saying whether each pixel in |
---|
| 408 | /// the given array is suitable for a stats calculation. It needs |
---|
| 409 | /// to be in the StatSec (if defined), not blank and not a MW |
---|
| 410 | /// channel. The array is allocated by the function with a 'new' call. |
---|
| 411 | |
---|
[506] | 412 | bool *mask = new bool[dim[0]*dim[1]*dim[2]]; |
---|
| 413 | for(int x=0;x<dim[0];x++) { |
---|
| 414 | for(int y=0;y<dim[1];y++) { |
---|
| 415 | for(int z=0;z<dim[2];z++) { |
---|
| 416 | int i = x+y*dim[0]+z*dim[0]*dim[1]; |
---|
| 417 | mask[i] = !this->isBlank(array[i]) && !this->isInMW(z) && this->isStatOK(x,y,z); |
---|
| 418 | } |
---|
| 419 | } |
---|
| 420 | } |
---|
| 421 | return mask; |
---|
| 422 | } |
---|
| 423 | |
---|
| 424 | |
---|
[378] | 425 | bool Param::isInMW(int z) |
---|
| 426 | { |
---|
[528] | 427 | /// Tests whether we are flagging Milky Way channels, and if so |
---|
| 428 | /// whether the given channel number is in the Milky Way range. The |
---|
| 429 | /// channels are assumed to start at number 0. |
---|
| 430 | /// \param z The channel number |
---|
| 431 | /// \return True if we are flagging Milky Way channels and z is in |
---|
| 432 | /// the range. |
---|
| 433 | |
---|
[673] | 434 | return ( this->flagMW && (z>=this->getMinMW()) && (z<=this->getMaxMW()) ); |
---|
[378] | 435 | } |
---|
[266] | 436 | |
---|
[378] | 437 | bool Param::isStatOK(int x, int y, int z) |
---|
| 438 | { |
---|
[528] | 439 | /// Test whether a given pixel position lies within the subsection |
---|
| 440 | /// given by the statSec parameter. Only tested if the flagSubsection |
---|
| 441 | /// parameter is true -- if it isn't, we just return true since all |
---|
| 442 | /// pixels are therefore available for statstical calculations. |
---|
| 443 | /// \param x X-value of pixel being tested. |
---|
| 444 | /// \param y Y-value of pixel being tested. |
---|
| 445 | /// \param z Z-value of pixel being tested. |
---|
| 446 | /// \return True if pixel is able to be used for statistical |
---|
| 447 | /// calculations. False otherwise. |
---|
| 448 | |
---|
[272] | 449 | int xval=x,yval=y,zval=z; |
---|
| 450 | if(flagSubsection){ |
---|
| 451 | xval += pixelSec.getStart(0); |
---|
| 452 | yval += pixelSec.getStart(1); |
---|
| 453 | zval += pixelSec.getStart(2); |
---|
| 454 | } |
---|
| 455 | return !flagStatSec || statSec.isInside(xval,yval,zval); |
---|
[419] | 456 | } |
---|
[266] | 457 | |
---|
[475] | 458 | std::vector<int> Param::getObjectRequest() |
---|
| 459 | { |
---|
[528] | 460 | /// Returns a list of the object numbers requested via the objectList parameter. |
---|
| 461 | /// \return a vector of integers, one for each number in the objectList set. |
---|
| 462 | |
---|
[475] | 463 | std::stringstream ss1; |
---|
| 464 | std::string tmp; |
---|
| 465 | std::vector<int> tmplist; |
---|
| 466 | ss1.str(this->objectList); |
---|
| 467 | while(!ss1.eof()){ |
---|
| 468 | getline(ss1,tmp,','); |
---|
[623] | 469 | for(size_t i=0;i<tmp.size();i++) if(tmp[i]=='-') tmp[i]=' '; |
---|
[475] | 470 | int a,b; |
---|
| 471 | std::stringstream ss2; |
---|
| 472 | ss2.str(tmp); |
---|
| 473 | ss2 >>a; |
---|
| 474 | if(!ss2.eof()) ss2 >> b; |
---|
| 475 | else b=a; |
---|
| 476 | for(int n=a;n<=b;n++){ |
---|
| 477 | tmplist.push_back(n); |
---|
| 478 | } |
---|
| 479 | } |
---|
| 480 | return tmplist; |
---|
| 481 | } |
---|
| 482 | |
---|
| 483 | std::vector<bool> Param::getObjectChoices() |
---|
| 484 | { |
---|
[528] | 485 | /// Returns a list of bool values, indicating whether a given |
---|
| 486 | /// object was requested or not. The size of the vector is |
---|
| 487 | /// determined by the maximum value in objectList. For instance, |
---|
| 488 | /// if objectList="2,3,5-8", then the returned vector will be |
---|
| 489 | /// [0,1,1,0,1,1,1,1]. |
---|
| 490 | /// \return Vector of bool values. |
---|
| 491 | |
---|
[475] | 492 | std::vector<int> objectChoices = this->getObjectRequest(); |
---|
| 493 | int maxNum = *std::max_element(objectChoices.begin(), objectChoices.end()); |
---|
| 494 | std::vector<bool> choices(maxNum,false); |
---|
[623] | 495 | for(std::vector<int>::iterator obj = objectChoices.begin();obj!=objectChoices.end();obj++) |
---|
| 496 | choices[*obj-1] = true; |
---|
[475] | 497 | return choices; |
---|
| 498 | } |
---|
| 499 | |
---|
| 500 | std::vector<bool> Param::getObjectChoices(int numObjects) |
---|
| 501 | { |
---|
[528] | 502 | /// Returns a list of bool values, indicating whether a given |
---|
| 503 | /// object was requested or not. The size of the vector is given |
---|
| 504 | /// by the numObjects parameter. So, if objectList="2,3,5-8", then |
---|
| 505 | /// the returned vector from a getObjectChoices(10) call will be |
---|
| 506 | /// [0,1,1,0,1,1,1,1,0,0]. |
---|
| 507 | /// \param numObjects How many objects there are in total. |
---|
| 508 | /// \return Vector of bool values. |
---|
| 509 | |
---|
[475] | 510 | if(this->objectList==""){ |
---|
| 511 | std::vector<bool> choices(numObjects,true); |
---|
| 512 | return choices; |
---|
| 513 | } |
---|
| 514 | else{ |
---|
| 515 | std::vector<int> objectChoices = this->getObjectRequest(); |
---|
| 516 | std::vector<bool> choices(numObjects,false); |
---|
[623] | 517 | for(std::vector<int>::iterator obj = objectChoices.begin();obj!=objectChoices.end();obj++) |
---|
| 518 | if(*obj<=numObjects) choices[*obj-1] = true; |
---|
[475] | 519 | return choices; |
---|
| 520 | } |
---|
| 521 | } |
---|
| 522 | |
---|
[378] | 523 | /****************************************************************/ |
---|
[528] | 524 | /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// |
---|
| 525 | /// / Other Functions using the Parameter class: |
---|
| 526 | /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// |
---|
[3] | 527 | |
---|
[698] | 528 | OUTCOME Param::readParams(std::string paramfile) |
---|
[378] | 529 | { |
---|
[528] | 530 | /// The parameters are read in from a disk file, on the assumption that each |
---|
| 531 | /// line of the file has the format "parameter value" (eg. alphafdr 0.1) |
---|
| 532 | /// |
---|
| 533 | /// The case of the parameter name does not matter, nor does the |
---|
| 534 | /// formatting of the spaces (it can be any amount of whitespace or |
---|
| 535 | /// tabs). |
---|
| 536 | /// |
---|
| 537 | /// \param paramfile A std::string containing the parameter filename. |
---|
| 538 | /// |
---|
| 539 | /// \return FAILURE if the parameter file does not exist. SUCCESS if |
---|
| 540 | /// it is able to read it. |
---|
| 541 | |
---|
[378] | 542 | std::ifstream fin(paramfile.c_str()); |
---|
| 543 | if(!fin.is_open()) return FAILURE; |
---|
| 544 | std::string line; |
---|
| 545 | while( !std::getline(fin,line,'\n').eof()){ |
---|
[3] | 546 | |
---|
[378] | 547 | if(line[0]!='#'){ |
---|
| 548 | std::stringstream ss; |
---|
| 549 | ss.str(line); |
---|
| 550 | std::string arg; |
---|
| 551 | ss >> arg; |
---|
| 552 | arg = makelower(arg); |
---|
[733] | 553 | if(arg=="imagefile") this->imageFile = readFilename(ss); |
---|
[378] | 554 | if(arg=="flagsubsection") this->flagSubsection = readFlag(ss); |
---|
| 555 | if(arg=="subsection") this->pixelSec.setSection(readSval(ss)); |
---|
| 556 | if(arg=="flagreconexists") this->flagReconExists = readFlag(ss); |
---|
| 557 | if(arg=="reconfile") this->reconFile = readSval(ss); |
---|
| 558 | if(arg=="flagsmoothexists")this->flagSmoothExists = readFlag(ss); |
---|
| 559 | if(arg=="smoothfile") this->smoothFile = readSval(ss); |
---|
[791] | 560 | if(arg=="beamarea") { this->areaBeam = readFval(ss); std::cerr << "**** Beam area = " << this->areaBeam << "\n";} |
---|
| 561 | if(arg=="beamfwhm") { this->fwhmBeam = readFval(ss); std::cerr << "**** Beam FWHM = " << this->fwhmBeam << "\n";} |
---|
[475] | 562 | if(arg=="useprevious") this->usePrevious = readFlag(ss); |
---|
| 563 | if(arg=="objectlist") this->objectList = readSval(ss); |
---|
[71] | 564 | |
---|
[378] | 565 | if(arg=="flaglog") this->flagLog = readFlag(ss); |
---|
| 566 | if(arg=="logfile") this->logFile = readSval(ss); |
---|
| 567 | if(arg=="outfile") this->outFile = readSval(ss); |
---|
| 568 | if(arg=="flagseparateheader") this->flagSeparateHeader = readFlag(ss); |
---|
[733] | 569 | if(arg=="headerfile") this->headerFile = readFilename(ss); |
---|
[831] | 570 | if(arg=="flagplotspectra") this->flagPlotSpectra = readFlag(ss); |
---|
[733] | 571 | if(arg=="spectrafile") this->spectraFile = readFilename(ss); |
---|
[424] | 572 | if(arg=="flagtextspectra") this->flagTextSpectra = readFlag(ss); |
---|
[733] | 573 | if(arg=="spectratextfile") this->spectraTextFile = readFilename(ss); |
---|
[670] | 574 | if(arg=="flagoutputmomentmap") this->flagOutputMomentMap = readFlag(ss); |
---|
[733] | 575 | if(arg=="fileoutputmomentmap") this->fileOutputMomentMap = readFilename(ss); |
---|
[379] | 576 | if(arg=="flagoutputmask") this->flagOutputMask = readFlag(ss); |
---|
[733] | 577 | if(arg=="fileoutputmask") this->fileOutputMask = readFilename(ss); |
---|
[521] | 578 | if(arg=="flagmaskwithobjectnum") this->flagMaskWithObjectNum = readFlag(ss); |
---|
[378] | 579 | if(arg=="flagoutputsmooth")this->flagOutputSmooth = readFlag(ss); |
---|
[733] | 580 | if(arg=="fileoutputsmooth")this->fileOutputSmooth = readFilename(ss); |
---|
[378] | 581 | if(arg=="flagoutputrecon") this->flagOutputRecon = readFlag(ss); |
---|
[733] | 582 | if(arg=="fileoutputrecon") this->fileOutputRecon = readFilename(ss); |
---|
[378] | 583 | if(arg=="flagoutputresid") this->flagOutputResid = readFlag(ss); |
---|
[733] | 584 | if(arg=="fileoutputresid") this->fileOutputResid = readFilename(ss); |
---|
[378] | 585 | if(arg=="flagvot") this->flagVOT = readFlag(ss); |
---|
[733] | 586 | if(arg=="votfile") this->votFile = readFilename(ss); |
---|
[378] | 587 | if(arg=="flagkarma") this->flagKarma = readFlag(ss); |
---|
[733] | 588 | if(arg=="karmafile") this->karmaFile = readFilename(ss); |
---|
[446] | 589 | if(arg=="annotationtype") this->annotationType = readSval(ss); |
---|
[378] | 590 | if(arg=="flagmaps") this->flagMaps = readFlag(ss); |
---|
[733] | 591 | if(arg=="detectionmap") this->detectionMap = readFilename(ss); |
---|
| 592 | if(arg=="momentmap") this->momentMap = readFilename(ss); |
---|
[378] | 593 | if(arg=="flagxoutput") this->flagXOutput = readFlag(ss); |
---|
[434] | 594 | if(arg=="newfluxunits") this->newFluxUnits = readSval(ss); |
---|
[438] | 595 | if(arg=="precflux") this->precFlux = readIval(ss); |
---|
| 596 | if(arg=="precvel") this->precVel = readIval(ss); |
---|
| 597 | if(arg=="precsnr") this->precSNR = readIval(ss); |
---|
[3] | 598 | |
---|
[378] | 599 | if(arg=="flagtrim") this->flagTrim = readFlag(ss); |
---|
| 600 | if(arg=="flagmw") this->flagMW = readFlag(ss); |
---|
| 601 | if(arg=="maxmw") this->maxMW = readIval(ss); |
---|
| 602 | if(arg=="minmw") this->minMW = readIval(ss); |
---|
[442] | 603 | if(arg=="flagbaseline") this->flagBaseline = readFlag(ss); |
---|
[691] | 604 | if(arg=="searchtype") this->searchType = readSval(ss); |
---|
[71] | 605 | |
---|
[442] | 606 | if(arg=="flagnegative") this->flagNegative = readFlag(ss); |
---|
[378] | 607 | if(arg=="minpix") this->minPix = readIval(ss); |
---|
| 608 | if(arg=="flaggrowth") this->flagGrowth = readFlag(ss); |
---|
| 609 | if(arg=="growthcut") this->growthCut = readFval(ss); |
---|
[461] | 610 | if(arg=="growththreshold"){ |
---|
| 611 | this->growthThreshold = readFval(ss); |
---|
| 612 | this->flagUserGrowthThreshold = true; |
---|
| 613 | } |
---|
[71] | 614 | |
---|
[378] | 615 | if(arg=="flagfdr") this->flagFDR = readFlag(ss); |
---|
| 616 | if(arg=="alphafdr") this->alphaFDR = readFval(ss); |
---|
[543] | 617 | if(arg=="fdrnumcorchan") this->FDRnumCorChan = readIval(ss); |
---|
[378] | 618 | if(arg=="flagstatsec") this->flagStatSec = readFlag(ss); |
---|
| 619 | if(arg=="statsec") this->statSec.setSection(readSval(ss)); |
---|
[385] | 620 | if(arg=="flagrobuststats") this->flagRobustStats = readFlag(ss); |
---|
[378] | 621 | if(arg=="snrcut") this->snrCut = readFval(ss); |
---|
| 622 | if(arg=="threshold"){ |
---|
| 623 | this->threshold = readFval(ss); |
---|
| 624 | this->flagUserThreshold = true; |
---|
| 625 | } |
---|
[201] | 626 | |
---|
[378] | 627 | if(arg=="flagsmooth") this->flagSmooth = readFlag(ss); |
---|
| 628 | if(arg=="smoothtype") this->smoothType = readSval(ss); |
---|
| 629 | if(arg=="hanningwidth") this->hanningWidth = readIval(ss); |
---|
| 630 | if(arg=="kernmaj") this->kernMaj = readFval(ss); |
---|
| 631 | if(arg=="kernmin") this->kernMin = readFval(ss); |
---|
| 632 | if(arg=="kernpa") this->kernPA = readFval(ss); |
---|
[103] | 633 | |
---|
[378] | 634 | if(arg=="flagatrous") this->flagATrous = readFlag(ss); |
---|
| 635 | if(arg=="recondim") this->reconDim = readIval(ss); |
---|
| 636 | if(arg=="scalemin") this->scaleMin = readIval(ss); |
---|
| 637 | if(arg=="scalemax") this->scaleMax = readIval(ss); |
---|
| 638 | if(arg=="snrrecon") this->snrRecon = readFval(ss); |
---|
| 639 | if(arg=="filtercode"){ |
---|
| 640 | this->filterCode = readIval(ss); |
---|
| 641 | this->reconFilter.define(this->filterCode); |
---|
| 642 | } |
---|
[71] | 643 | |
---|
[378] | 644 | if(arg=="flagadjacent") this->flagAdjacent = readFlag(ss); |
---|
| 645 | if(arg=="threshspatial") this->threshSpatial = readFval(ss); |
---|
| 646 | if(arg=="threshvelocity") this->threshVelocity = readFval(ss); |
---|
| 647 | if(arg=="minchannels") this->minChannels = readIval(ss); |
---|
[720] | 648 | if(arg=="minvoxels") this->minVoxels = readIval(ss); |
---|
[691] | 649 | if(arg=="flagrejectbeforemerge") this->flagRejectBeforeMerge = readFlag(ss); |
---|
| 650 | if(arg=="flagtwostagemerging") this->flagTwoStageMerging = readFlag(ss); |
---|
[71] | 651 | |
---|
[378] | 652 | if(arg=="spectralmethod") this->spectralMethod=makelower(readSval(ss)); |
---|
| 653 | if(arg=="spectralunits") this->spectralUnits = makelower(readSval(ss)); |
---|
| 654 | if(arg=="pixelcentre") this->pixelCentre = makelower(readSval(ss)); |
---|
[571] | 655 | if(arg=="sortingparam") this->sortingParam = makelower(readSval(ss)); |
---|
[378] | 656 | if(arg=="drawborders") this->borders = readFlag(ss); |
---|
| 657 | if(arg=="drawblankedges") this->blankEdge = readFlag(ss); |
---|
| 658 | if(arg=="verbose") this->verbose = readFlag(ss); |
---|
[295] | 659 | |
---|
[378] | 660 | // Dealing with deprecated parameters. |
---|
| 661 | if(arg=="flagblankpix"){ |
---|
| 662 | this->flagTrim = readFlag(ss); |
---|
| 663 | std::stringstream errmsg; |
---|
| 664 | errmsg <<"The parameter flagBlankPix is deprecated. " |
---|
| 665 | <<"Please use the flagTrim parameter in future.\n" |
---|
| 666 | <<"Setting flagTrim = " << stringize(this->flagTrim) << ".\n"; |
---|
| 667 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 668 | } |
---|
| 669 | if(arg=="blankpixvalue"){ |
---|
| 670 | std::stringstream errmsg; |
---|
| 671 | errmsg <<"The parameter blankPixValue is deprecated.\n" |
---|
| 672 | <<"This value is only taken from the FITS header.\n"; |
---|
| 673 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 674 | } |
---|
[662] | 675 | if(arg=="beamsize"){ |
---|
[675] | 676 | this->areaBeam = readFval(ss); |
---|
[662] | 677 | std::stringstream errmsg; |
---|
| 678 | errmsg <<"The parameter beamSize is deprecated.\n" |
---|
| 679 | <<"You can specify the beam size by beamArea or beamFWHM.\n" |
---|
[675] | 680 | <<"Setting beamArea = " << this->areaBeam << ".\n"; |
---|
[662] | 681 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 682 | } |
---|
[378] | 683 | |
---|
[295] | 684 | } |
---|
[378] | 685 | } |
---|
[295] | 686 | |
---|
[506] | 687 | this->checkPars(); |
---|
| 688 | |
---|
| 689 | return SUCCESS; |
---|
| 690 | |
---|
| 691 | } |
---|
| 692 | |
---|
| 693 | void Param::checkPars() |
---|
| 694 | { |
---|
| 695 | |
---|
[475] | 696 | // If we have usePrevious=false, set the objectlist to blank so that we use all of them |
---|
| 697 | if(!this->usePrevious) this->objectList = ""; |
---|
| 698 | |
---|
[420] | 699 | // If pgplot was not included in the compilation, need to set flagXOutput to false |
---|
[831] | 700 | if(!USE_PGPLOT){ |
---|
| 701 | if(this->flagXOutput || this->flagMaps || this->flagPlotSpectra) |
---|
| 702 | duchampWarning("Reading parameters","PGPlot has not been enabled, so setting flagXOutput, flagMaps and flagPlotSpectra to false.\n"); |
---|
| 703 | this->flagXOutput = false; |
---|
| 704 | this->flagMaps = false; |
---|
| 705 | this->flagPlotSpectra = false; |
---|
| 706 | } |
---|
[420] | 707 | |
---|
[438] | 708 | // Correcting bad precision values -- if negative, set to 0 |
---|
| 709 | if(this->precFlux<0) this->precFlux = 0; |
---|
| 710 | if(this->precVel<0) this->precVel = 0; |
---|
| 711 | if(this->precSNR<0) this->precSNR = 0; |
---|
| 712 | |
---|
[686] | 713 | // Can only have "spatial" or "spectral" as search types |
---|
| 714 | if(this->searchType != "spatial" && this->searchType != "spectral"){ |
---|
| 715 | std::stringstream errmsg; |
---|
| 716 | errmsg << "You have requested a search type of \""<<this->searchType<<"\".\n" |
---|
| 717 | << "Only \"spectral\" and \"spatial\" are accepted. Setting to \"spatial\".\n"; |
---|
| 718 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 719 | this->searchType = "spatial"; |
---|
| 720 | } |
---|
| 721 | |
---|
[378] | 722 | // The wavelet reconstruction takes precendence over the smoothing. |
---|
| 723 | if(this->flagATrous) this->flagSmooth = false; |
---|
| 724 | |
---|
[461] | 725 | if(this->flagUserThreshold){ |
---|
| 726 | |
---|
| 727 | // If we specify a manual threshold, need to also specify a manual growth threshold |
---|
| 728 | // If we haven't done so, turn growing off |
---|
| 729 | if(this->flagGrowth && !this->flagUserGrowthThreshold){ |
---|
| 730 | std::stringstream errmsg; |
---|
| 731 | errmsg << "You have specified a manual search threshold, but not a manual growth threshold.\n" |
---|
| 732 | << "You need to do so using the \"growthThreshold\" parameter.\n" |
---|
| 733 | << "The growth function is being turned off.\n"; |
---|
| 734 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 735 | this->flagGrowth = false; |
---|
| 736 | } |
---|
| 737 | |
---|
| 738 | // If we specify a manual threshold, we don't need the FDR method, so turn it off if requested. |
---|
| 739 | if(this->flagFDR){ |
---|
| 740 | std::stringstream errmsg; |
---|
| 741 | errmsg << "You have specified a manual search threshold, so we don't need to use the FDR method.\n" |
---|
| 742 | << "Setting \"flagFDR=false\".\n"; |
---|
| 743 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 744 | this->flagFDR = false; |
---|
| 745 | } |
---|
| 746 | |
---|
| 747 | } |
---|
| 748 | |
---|
[537] | 749 | // Make sure the growth level is less than the detection level. Else turn off growing. |
---|
| 750 | if(this->flagGrowth){ |
---|
| 751 | std::stringstream errmsg; |
---|
| 752 | bool doWarn = false; |
---|
| 753 | if(this->flagUserThreshold && |
---|
| 754 | ( (this->threshold < this->growthThreshold) |
---|
| 755 | || (this->snrCut < this->growthCut) ) ){ |
---|
| 756 | errmsg << "Your \"growthThreshold\" parameter is larger than your \"threshold\".\n" |
---|
| 757 | << "The growth function is being turned off.\n"; |
---|
| 758 | doWarn = true; |
---|
| 759 | } |
---|
| 760 | |
---|
| 761 | if(!this->flagUserThreshold && |
---|
| 762 | (this->snrCut < this->growthCut)) { |
---|
| 763 | errmsg << "Your \"growthCut\" parameter is larger than your \"snrCut\".\n" |
---|
| 764 | << "The growth function is being turned off.\n"; |
---|
| 765 | doWarn = true; |
---|
| 766 | } |
---|
| 767 | |
---|
| 768 | if(doWarn) duchampWarning("Reading parameters",errmsg.str()); |
---|
| 769 | |
---|
| 770 | } |
---|
| 771 | |
---|
[446] | 772 | // Make sure the annnotationType is an acceptable option -- default is "borders" |
---|
| 773 | if((this->annotationType != "borders") && (this->annotationType!="circles")){ |
---|
| 774 | std::stringstream errmsg; |
---|
| 775 | errmsg << "The requested value of the parameter annotationType, \"" |
---|
[571] | 776 | << this->annotationType << "\", is invalid.\n" |
---|
[446] | 777 | << "Changing to \"borders\".\n"; |
---|
| 778 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 779 | this->annotationType = "borders"; |
---|
| 780 | } |
---|
| 781 | |
---|
[378] | 782 | // Make sure smoothType is an acceptable type -- default is "spectral" |
---|
| 783 | if((this->smoothType!="spectral")&& |
---|
| 784 | (this->smoothType!="spatial")){ |
---|
| 785 | std::stringstream errmsg; |
---|
| 786 | errmsg << "The requested value of the parameter smoothType, \"" |
---|
[571] | 787 | << this->smoothType << "\", is invalid.\n" |
---|
[378] | 788 | << "Changing to \"spectral\".\n"; |
---|
| 789 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 790 | this->smoothType = "spectral"; |
---|
[3] | 791 | } |
---|
[378] | 792 | // If kernMin has not been given, or is negative, make it equal to kernMaj |
---|
| 793 | if(this->kernMin < 0) this->kernMin = this->kernMaj; |
---|
[272] | 794 | |
---|
[378] | 795 | // Make sure spectralMethod is an acceptable type -- default is "peak" |
---|
| 796 | if((this->spectralMethod!="peak")&& |
---|
| 797 | (this->spectralMethod!="sum")){ |
---|
| 798 | std::stringstream errmsg; |
---|
| 799 | errmsg << "The requested value of the parameter spectralMethod, \"" |
---|
[571] | 800 | << this->spectralMethod << "\", is invalid.\n" |
---|
[378] | 801 | << "Changing to \"peak\".\n"; |
---|
| 802 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 803 | this->spectralMethod = "peak"; |
---|
| 804 | } |
---|
[232] | 805 | |
---|
[378] | 806 | // Make sure pixelCentre is an acceptable type -- default is "peak" |
---|
| 807 | if((this->pixelCentre!="centroid")&& |
---|
| 808 | (this->pixelCentre!="average") && |
---|
| 809 | (this->pixelCentre!="peak") ){ |
---|
| 810 | std::stringstream errmsg; |
---|
| 811 | errmsg << "The requested value of the parameter pixelCentre, \"" |
---|
[571] | 812 | << this->pixelCentre << "\", is invalid.\n" |
---|
[378] | 813 | << "Changing to \"centroid\".\n"; |
---|
| 814 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 815 | this->pixelCentre = "centroid"; |
---|
| 816 | } |
---|
[275] | 817 | |
---|
[571] | 818 | // Make sure sortingParam is an acceptable type -- default is "vel" |
---|
| 819 | bool OK = false; |
---|
| 820 | for(int i=0;i<numSortingParamOptions;i++) |
---|
| 821 | OK = OK || this->sortingParam==sortingParamOptions[i]; |
---|
| 822 | if(!OK){ |
---|
| 823 | std::stringstream errmsg; |
---|
| 824 | errmsg << "The requested value of the parameter sortingParam, \"" |
---|
| 825 | << this->sortingParam << "\", is invalid.\n" |
---|
| 826 | << "Changing to \"vel\".\n"; |
---|
| 827 | duchampWarning("Reading parameters",errmsg.str()); |
---|
| 828 | this->sortingParam = "vel"; |
---|
| 829 | } |
---|
| 830 | |
---|
[265] | 831 | } |
---|
| 832 | |
---|
[664] | 833 | void recordParameters(std::ostream& theStream, std::string paramName, std::string paramDesc, std::string paramValue) |
---|
| 834 | { |
---|
| 835 | |
---|
[716] | 836 | const int width = 56; |
---|
| 837 | int widthText = width - paramName.size(); |
---|
[265] | 838 | |
---|
[664] | 839 | theStream << std::setw(widthText) << paramDesc |
---|
[716] | 840 | << setiosflags(std::ios::right) << paramName |
---|
[664] | 841 | << " = " << resetiosflags(std::ios::right) << paramValue |
---|
| 842 | <<std::endl; |
---|
| 843 | } |
---|
| 844 | |
---|
| 845 | std::string fileOption(bool flag, std::string file) |
---|
| 846 | { |
---|
| 847 | std::ostringstream ss; |
---|
| 848 | ss << stringize(flag); |
---|
| 849 | if(flag) ss << " --> " << file; |
---|
| 850 | return ss.str(); |
---|
| 851 | |
---|
| 852 | } |
---|
| 853 | |
---|
[378] | 854 | std::ostream& operator<< ( std::ostream& theStream, Param& par) |
---|
| 855 | { |
---|
[528] | 856 | /// Print out the parameter set in a formatted, easy to read style. |
---|
| 857 | /// Lists the parameters, a description of them, and their value. |
---|
[3] | 858 | |
---|
[378] | 859 | // BUG -- can get error: `boolalpha' is not a member of type `ios' -- old compilers: gcc 2.95.3? |
---|
| 860 | // theStream.setf(std::ios::boolalpha); |
---|
| 861 | theStream.setf(std::ios::left); |
---|
| 862 | theStream <<"\n---- Parameters ----"<<std::endl; |
---|
| 863 | theStream << std::setfill('.'); |
---|
| 864 | if(par.getFlagSubsection()) |
---|
[664] | 865 | recordParam(theStream, "[imageFile]", "Image to be analysed", par.getImageFile()<<par.getSubsection()); |
---|
[378] | 866 | else |
---|
[664] | 867 | recordParam(theStream, "[imageFile]", "Image to be analysed", par.getImageFile()); |
---|
[378] | 868 | if(par.getFlagReconExists() && par.getFlagATrous()){ |
---|
[664] | 869 | recordParam(theStream, "[reconExists]", "Reconstructed array exists?", stringize(par.getFlagReconExists())); |
---|
| 870 | recordParam(theStream, "[reconFile]", "FITS file containing reconstruction", par.getReconFile()); |
---|
[378] | 871 | } |
---|
| 872 | if(par.getFlagSmoothExists() && par.getFlagSmooth()){ |
---|
[664] | 873 | recordParam(theStream, "[smoothExists]", "Smoothed array exists?", stringize(par.getFlagSmoothExists())); |
---|
| 874 | recordParam(theStream, "[smoothFile]", "FITS file containing smoothed array", par.getSmoothFile()); |
---|
[378] | 875 | } |
---|
[788] | 876 | recordParam(theStream, "[logFile]", "Intermediate Logfile", par.logFile); |
---|
[664] | 877 | recordParam(theStream, "[outFile]", "Final Results file", par.getOutFile()); |
---|
| 878 | if(par.getFlagSeparateHeader()){ |
---|
| 879 | recordParam(theStream, "[headerFile]", "Header for results file", par.getHeaderFile()); |
---|
| 880 | } |
---|
[831] | 881 | if(USE_PGPLOT && par.getFlagPlotSpectra()){ |
---|
| 882 | recordParam(theStream, "[spectraFile]", "Spectrum file", par.getSpectraFile()); |
---|
| 883 | } |
---|
[424] | 884 | if(par.getFlagTextSpectra()){ |
---|
[664] | 885 | recordParam(theStream, "[spectraTextFile]", "Text file with ascii spectral data", par.getSpectraTextFile()); |
---|
[424] | 886 | } |
---|
[378] | 887 | if(par.getFlagVOT()){ |
---|
[664] | 888 | recordParam(theStream, "[votFile]", "VOTable file", par.getVOTFile()); |
---|
[378] | 889 | } |
---|
| 890 | if(par.getFlagKarma()){ |
---|
[664] | 891 | recordParam(theStream, "[karmaFile]", "Karma annotation file" , par.getKarmaFile()); |
---|
[378] | 892 | } |
---|
[831] | 893 | if(USE_PGPLOT && par.getFlagMaps()){ |
---|
[664] | 894 | recordParam(theStream, "[momentMap]", "0th Moment Map", par.getMomentMap()); |
---|
| 895 | recordParam(theStream, "[detectionMap]", "Detection Map", par.getDetectionMap()); |
---|
[378] | 896 | } |
---|
[831] | 897 | if(USE_PGPLOT){ |
---|
| 898 | recordParam(theStream, "[flagXOutput]", "Display a map in a pgplot xwindow?", stringize(par.getFlagXOutput())); |
---|
| 899 | } |
---|
[664] | 900 | if(par.getFlagATrous()){ |
---|
| 901 | recordParam(theStream, "[flagOutputRecon]", "Saving reconstructed cube?", fileOption(par.getFlagOutputRecon(),par.outputReconFile())); |
---|
| 902 | recordParam(theStream, "[flagOutputResid]", "Saving residuals from reconstruction?", fileOption(par.getFlagOutputResid(),par.outputResidFile())); |
---|
[378] | 903 | } |
---|
[664] | 904 | if(par.getFlagSmooth()){ |
---|
| 905 | recordParam(theStream, "[flagOutputSmooth]", "Saving smoothed cube?", fileOption(par.getFlagOutputSmooth(),par.outputSmoothFile())); |
---|
[378] | 906 | } |
---|
[664] | 907 | recordParam(theStream, "[flagOutputMask]", "Saving mask cube?", fileOption(par.getFlagOutputMask(),par.outputMaskFile())); |
---|
[670] | 908 | recordParam(theStream, "[flagOutputMask]", "Saving 0th moment to FITS file?", fileOption(par.getFlagOutputMomentMap(),par.outputMomentMapFile())); |
---|
[664] | 909 | |
---|
[378] | 910 | theStream <<"------"<<std::endl; |
---|
[664] | 911 | |
---|
[686] | 912 | recordParam(theStream, "[searchType]", "Type of searching performed", par.getSearchType()); |
---|
[378] | 913 | if(par.getFlagBlankPix()){ |
---|
[664] | 914 | recordParam(theStream, "", "Blank Pixel Value", par.getBlankPixVal()); |
---|
[275] | 915 | } |
---|
[664] | 916 | recordParam(theStream, "[flagTrim]", "Trimming Blank Pixels?", stringize(par.getFlagTrim())); |
---|
| 917 | recordParam(theStream, "[flagNegative]", "Searching for Negative features?", stringize(par.getFlagNegative())); |
---|
| 918 | recordParam(theStream, "[flagMW]", "Removing Milky Way channels?", stringize(par.getFlagMW())); |
---|
[378] | 919 | if(par.getFlagMW()){ |
---|
[673] | 920 | // need to remove the offset correction, as we want to report the parameters actually entered |
---|
| 921 | recordParam(theStream, "[minMW - maxMW]", "Milky Way Channels", par.getMinMW()+par.getZOffset()<<"-"<<par.getMaxMW()+par.getZOffset()); |
---|
[348] | 922 | } |
---|
[791] | 923 | if(par.beamAsUsed.origin()==EMPTY){ // No beam in FITS file and no information provided |
---|
[788] | 924 | recordParam(theStream, "", "Area of Beam", "No beam"); |
---|
[675] | 925 | } |
---|
[791] | 926 | else if(par.beamAsUsed.origin()==HEADER){ // Report beam size from FITS file |
---|
[795] | 927 | recordParam(theStream, "", "Area of Beam (pixels)", par.beamAsUsed.area() << " (beam: " << par.beamAsUsed.maj() << " x " << par.beamAsUsed.min() <<" pixels)"); |
---|
[675] | 928 | } |
---|
[791] | 929 | else if(par.beamAsUsed.origin()==PARAM){ // Report beam size requested in parameter set input |
---|
[788] | 930 | if(par.fwhmBeam>0.) recordParam(theStream, "[beamFWHM]", "FWHM of Beam (pixels)", par.beamAsUsed.maj() << " (beam area = " << par.beamAsUsed.area() <<" pixels)"); |
---|
| 931 | else recordParam(theStream, "[beamArea]", "Area of Beam (pixels)", par.beamAsUsed.area()); |
---|
| 932 | } |
---|
| 933 | else{ |
---|
| 934 | duchampError("Parameter output","Unknown value for origin of beam"); |
---|
| 935 | } |
---|
[664] | 936 | recordParam(theStream, "[flagBaseline]", "Removing baselines before search?", stringize(par.getFlagBaseline())); |
---|
| 937 | recordParam(theStream, "[flagSmooth]", "Smoothing data prior to searching?", stringize(par.getFlagSmooth())); |
---|
[378] | 938 | if(par.getFlagSmooth()){ |
---|
[664] | 939 | recordParam(theStream, "[smoothType]", "Type of smoothing", par.getSmoothType()); |
---|
[378] | 940 | if(par.getSmoothType()=="spectral") |
---|
[664] | 941 | recordParam(theStream, "[hanningWidth]", "Width of hanning filter", par.getHanningWidth()); |
---|
[378] | 942 | else{ |
---|
[664] | 943 | recordParam(theStream, "[kernMaj]", "Gaussian kernel semi-major axis [pix]", par.getKernMaj()); |
---|
| 944 | recordParam(theStream, "[kernMin]", "Gaussian kernel semi-minor axis [pix]", par.getKernMin()); |
---|
| 945 | recordParam(theStream, "[kernPA]", "Gaussian kernel position angle [deg]", par.getKernPA()); |
---|
[378] | 946 | } |
---|
[348] | 947 | } |
---|
[664] | 948 | recordParam(theStream, "[flagATrous]", "Using A Trous reconstruction?", stringize(par.getFlagATrous())); |
---|
[378] | 949 | if(par.getFlagATrous()){ |
---|
[664] | 950 | recordParam(theStream, "[reconDim]", "Number of dimensions in reconstruction", par.getReconDim()); |
---|
[378] | 951 | if(par.getMaxScale()>0){ |
---|
[664] | 952 | recordParam(theStream, "[scaleMin-scaleMax]", "Scales used in reconstruction", par.getMinScale()<<"-"<<par.getMaxScale()); |
---|
[378] | 953 | } |
---|
| 954 | else{ |
---|
[664] | 955 | recordParam(theStream, "[scaleMin]", "Minimum scale in reconstruction", par.getMinScale()); |
---|
[378] | 956 | } |
---|
[664] | 957 | recordParam(theStream, "[snrRecon]", "SNR Threshold within reconstruction", par.getAtrousCut()); |
---|
| 958 | recordParam(theStream, "[filterCode]", "Filter being used for reconstruction", par.getFilterCode()<<" ("<<par.getFilterName()<<")"); |
---|
[378] | 959 | } |
---|
[664] | 960 | recordParam(theStream, "[flagRobustStats]", "Using Robust statistics?", stringize(par.getFlagRobustStats())); |
---|
[378] | 961 | if(par.getFlagStatSec()){ |
---|
[664] | 962 | recordParam(theStream, "[statSec]", "Section used by statistics calculation", par.statSec.getSection()); |
---|
[189] | 963 | } |
---|
[664] | 964 | recordParam(theStream, "[flagFDR]", "Using FDR analysis?", stringize(par.getFlagFDR())); |
---|
[378] | 965 | if(par.getFlagFDR()){ |
---|
[664] | 966 | recordParam(theStream, "[alphaFDR]", "Alpha value for FDR analysis", par.getAlpha()); |
---|
| 967 | recordParam(theStream, "[FDRnumCorChan]", "Number of correlated channels for FDR", par.getFDRnumCorChan()); |
---|
[378] | 968 | } |
---|
| 969 | else { |
---|
| 970 | if(par.getFlagUserThreshold()){ |
---|
[664] | 971 | recordParam(theStream, "[threshold]", "Detection Threshold", par.getThreshold()); |
---|
[378] | 972 | } |
---|
| 973 | else{ |
---|
[664] | 974 | recordParam(theStream, "[snrCut]", "SNR Threshold (in sigma)", par.getCut()); |
---|
[378] | 975 | } |
---|
[189] | 976 | } |
---|
[664] | 977 | recordParam(theStream, "[minPix]", "Minimum # Pixels in a detection", par.getMinPix()); |
---|
| 978 | recordParam(theStream, "[minChannels]", "Minimum # Channels in a detection", par.getMinChannels()); |
---|
[720] | 979 | recordParam(theStream, "[minVoxels]", "Minimum # Voxels in a detection", par.getMinVoxels()); |
---|
[664] | 980 | recordParam(theStream, "[flagGrowth]", "Growing objects after detection?", stringize(par.getFlagGrowth())); |
---|
[378] | 981 | if(par.getFlagGrowth()) { |
---|
[503] | 982 | if(par.getFlagUserGrowthThreshold()){ |
---|
[664] | 983 | recordParam(theStream, "[growthThreshold]", "Threshold for growth", par.getGrowthThreshold()); |
---|
[503] | 984 | } |
---|
| 985 | else{ |
---|
[664] | 986 | recordParam(theStream, "[growthCut]", "SNR Threshold for growth", par.getGrowthCut()); |
---|
[503] | 987 | } |
---|
[378] | 988 | } |
---|
[664] | 989 | recordParam(theStream, "[flagAdjacent]", "Using Adjacent-pixel criterion?", stringize(par.getFlagAdjacent())); |
---|
[378] | 990 | if(!par.getFlagAdjacent()){ |
---|
[664] | 991 | recordParam(theStream, "[threshSpatial]", "Max. spatial separation for merging", par.getThreshS()); |
---|
[378] | 992 | } |
---|
[664] | 993 | recordParam(theStream, "[threshVelocity]", "Max. velocity separation for merging", par.getThreshV()); |
---|
[672] | 994 | recordParam(theStream, "[flagRejectBeforeMerge]", "Reject objects before merging?", stringize(par.getFlagRejectBeforeMerge())); |
---|
[691] | 995 | recordParam(theStream, "[flagTwoStageMerging]", "Merge objects in two stages?", stringize(par.getFlagTwoStageMerging())); |
---|
[664] | 996 | recordParam(theStream, "[spectralMethod]", "Method of spectral plotting", par.getSpectralMethod()); |
---|
| 997 | recordParam(theStream, "[pixelCentre]", "Type of object centre used in results", par.getPixelCentre()); |
---|
| 998 | |
---|
[378] | 999 | theStream <<"--------------------\n\n"; |
---|
| 1000 | theStream << std::setfill(' '); |
---|
| 1001 | theStream.unsetf(std::ios::left); |
---|
| 1002 | // theStream.unsetf(std::ios::boolalpha); |
---|
| 1003 | return theStream; |
---|
[3] | 1004 | } |
---|
| 1005 | |
---|
[120] | 1006 | |
---|
[378] | 1007 | void Param::copyHeaderInfo(FitsHeader &head) |
---|
| 1008 | { |
---|
[528] | 1009 | /// A function to copy across relevant header keywords from the |
---|
| 1010 | /// FitsHeader class to the Param class, as they are needed by |
---|
| 1011 | /// functions in the Param class. |
---|
| 1012 | /// The parameters are the keywords BLANK, BSCALE, BZERO, and the beam size. |
---|
[112] | 1013 | |
---|
[378] | 1014 | this->blankKeyword = head.getBlankKeyword(); |
---|
| 1015 | this->bscaleKeyword = head.getBscaleKeyword(); |
---|
| 1016 | this->bzeroKeyword = head.getBzeroKeyword(); |
---|
| 1017 | this->blankPixValue = this->blankKeyword * this->bscaleKeyword + |
---|
| 1018 | this->bzeroKeyword; |
---|
| 1019 | } |
---|
[112] | 1020 | |
---|
[379] | 1021 | std::string Param::outputMaskFile() |
---|
| 1022 | { |
---|
[528] | 1023 | /// This function produces the required filename in which to save |
---|
| 1024 | /// the mask image, indicating which pixels have been detected as |
---|
| 1025 | /// part of an object. If the input image is image.fits, then the |
---|
| 1026 | /// output will be image.MASK.fits. |
---|
| 1027 | |
---|
[525] | 1028 | if(this->fileOutputMask==""){ |
---|
| 1029 | std::string inputName = this->imageFile; |
---|
| 1030 | std::stringstream ss; |
---|
| 1031 | ss << inputName.substr(0,inputName.size()-5); |
---|
| 1032 | // remove the ".fits" on the end. |
---|
| 1033 | ss << ".MASK.fits"; |
---|
| 1034 | return ss.str(); |
---|
| 1035 | } |
---|
| 1036 | else return this->fileOutputMask; |
---|
[379] | 1037 | } |
---|
| 1038 | |
---|
[670] | 1039 | std::string Param::outputMomentMapFile() |
---|
| 1040 | { |
---|
| 1041 | /// This function produces the required filename in which to save |
---|
| 1042 | /// the moment-0 FITS image. If the input image is image.fits, then the |
---|
| 1043 | /// output will be image.MOM0.fits. |
---|
| 1044 | |
---|
| 1045 | if(this->fileOutputMomentMap==""){ |
---|
| 1046 | std::string inputName = this->imageFile; |
---|
| 1047 | std::stringstream ss; |
---|
| 1048 | ss << inputName.substr(0,inputName.size()-5); |
---|
| 1049 | // remove the ".fits" on the end. |
---|
| 1050 | ss << ".MOM0.fits"; |
---|
| 1051 | return ss.str(); |
---|
| 1052 | } |
---|
| 1053 | else return this->fileOutputMomentMap; |
---|
| 1054 | } |
---|
| 1055 | |
---|
[378] | 1056 | std::string Param::outputSmoothFile() |
---|
| 1057 | { |
---|
[528] | 1058 | /// This function produces the required filename in which to save |
---|
| 1059 | /// the smoothed array. If the input image is image.fits, then |
---|
| 1060 | /// the output will be: |
---|
| 1061 | /// <ul><li> Spectral smoothing: image.SMOOTH-1D-3.fits, where the |
---|
| 1062 | /// width of the Hanning filter was 3 pixels. |
---|
| 1063 | /// <li> Spatial smoothing : image.SMOOTH-2D-3-2-20.fits, where |
---|
| 1064 | /// kernMaj=3, kernMin=2 and kernPA=20 degrees. |
---|
| 1065 | /// </ul> |
---|
| 1066 | |
---|
[525] | 1067 | if(this->fileOutputSmooth==""){ |
---|
| 1068 | std::string inputName = this->imageFile; |
---|
| 1069 | std::stringstream ss; |
---|
| 1070 | ss << inputName.substr(0,inputName.size()-5); |
---|
| 1071 | // remove the ".fits" on the end. |
---|
| 1072 | if(this->flagSubsection) ss<<".sub"; |
---|
| 1073 | if(this->smoothType=="spectral") |
---|
| 1074 | ss << ".SMOOTH-1D-" << this->hanningWidth << ".fits"; |
---|
| 1075 | else if(this->smoothType=="spatial") |
---|
| 1076 | ss << ".SMOOTH-2D-" |
---|
| 1077 | << this->kernMaj << "-" |
---|
| 1078 | << this->kernMin << "-" |
---|
| 1079 | << this->kernPA << ".fits"; |
---|
| 1080 | return ss.str(); |
---|
| 1081 | } |
---|
| 1082 | else return this->fileOutputSmooth; |
---|
[378] | 1083 | } |
---|
[208] | 1084 | |
---|
[378] | 1085 | std::string Param::outputReconFile() |
---|
| 1086 | { |
---|
[528] | 1087 | /// This function produces the required filename in which to save |
---|
| 1088 | /// the reconstructed array. If the input image is image.fits, then |
---|
| 1089 | /// the output will be eg. image.RECON-3-2-4-1.fits, where the numbers are |
---|
| 1090 | /// 3=reconDim, 2=filterCode, 4=snrRecon, 1=minScale |
---|
| 1091 | |
---|
[525] | 1092 | if(this->fileOutputRecon==""){ |
---|
| 1093 | std::string inputName = this->imageFile; |
---|
| 1094 | std::stringstream ss; |
---|
| 1095 | // First we remove the ".fits" from the end of the filename. |
---|
| 1096 | ss << inputName.substr(0,inputName.size()-5); |
---|
| 1097 | if(this->flagSubsection) ss<<".sub"; |
---|
| 1098 | ss << ".RECON-" << this->reconDim |
---|
| 1099 | << "-" << this->filterCode |
---|
| 1100 | << "-" << this->snrRecon |
---|
| 1101 | << "-" << this->scaleMin |
---|
| 1102 | << ".fits"; |
---|
| 1103 | return ss.str(); |
---|
| 1104 | } |
---|
| 1105 | else return this->fileOutputRecon; |
---|
[378] | 1106 | } |
---|
[103] | 1107 | |
---|
[378] | 1108 | std::string Param::outputResidFile() |
---|
| 1109 | { |
---|
[528] | 1110 | /// This function produces the required filename in which to save |
---|
| 1111 | /// the reconstructed array. If the input image is image.fits, then |
---|
| 1112 | /// the output will be eg. image.RESID-3-2-4-1.fits, where the numbers are |
---|
| 1113 | /// 3=reconDim, 2=filterCode, 4=snrRecon, 1=scaleMin |
---|
| 1114 | |
---|
[525] | 1115 | if(this->fileOutputResid==""){ |
---|
| 1116 | std::string inputName = this->imageFile; |
---|
| 1117 | std::stringstream ss; |
---|
| 1118 | // First we remove the ".fits" from the end of the filename. |
---|
| 1119 | ss << inputName.substr(0,inputName.size()-5); |
---|
| 1120 | if(this->flagSubsection) ss<<".sub"; |
---|
| 1121 | ss << ".RESID-" << this->reconDim |
---|
| 1122 | << "-" << this->filterCode |
---|
| 1123 | << "-" << this->snrRecon |
---|
| 1124 | << "-" << this->scaleMin |
---|
| 1125 | << ".fits"; |
---|
| 1126 | return ss.str(); |
---|
| 1127 | } |
---|
| 1128 | else return this->fileOutputResid; |
---|
[378] | 1129 | } |
---|
| 1130 | |
---|
[103] | 1131 | } |
---|