[299] | 1 | // ----------------------------------------------------------------------- |
---|
| 2 | // duchamp.hh: Definitions for use with 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 | // ----------------------------------------------------------------------- |
---|
[105] | 28 | #ifndef DUCHAMP_HH |
---|
| 29 | #define DUCHAMP_HH |
---|
| 30 | |
---|
[175] | 31 | #include <iostream> |
---|
[872] | 32 | #include <stdexcept> |
---|
[125] | 33 | #include <string> |
---|
| 34 | |
---|
[523] | 35 | // need to undef these in case other packages have them defined. |
---|
[141] | 36 | #undef PACKAGE_BUGREPORT |
---|
| 37 | #undef PACKAGE_NAME |
---|
| 38 | #undef PACKAGE_STRING |
---|
| 39 | #undef PACKAGE_TARNAME |
---|
| 40 | #undef PACKAGE_VERSION |
---|
[321] | 41 | #undef HAVE_PGPLOT |
---|
[489] | 42 | #include <duchamp/config.h> |
---|
[110] | 43 | |
---|
[488] | 44 | #ifdef HAVE_PGPLOT |
---|
| 45 | #include <duchamp/Utils/mycpgplot.hh> |
---|
| 46 | #endif |
---|
| 47 | |
---|
[759] | 48 | /// The primary namespace for all functionality directly related to Duchamp |
---|
[378] | 49 | namespace duchamp |
---|
| 50 | { |
---|
[71] | 51 | |
---|
[759] | 52 | /// @brief How to convey whether a function has worked |
---|
[378] | 53 | enum OUTCOME {SUCCESS=0, FAILURE}; |
---|
| 54 | |
---|
[759] | 55 | /// Usage message for command line help. |
---|
[378] | 56 | const std::string ERR_USAGE_MSG = |
---|
| 57 | "Usage: Duchamp [OPTION] [FILE]\n\ |
---|
[266] | 58 | Duchamp is an object finder for spectral-line FITS cubes.\n\ |
---|
| 59 | \n\ |
---|
| 60 | -p FILE Read in parameters from FILE, including FITS image location.\n\ |
---|
| 61 | -f FILE Use default parameters with imageFile=FILE\n\ |
---|
[294] | 62 | -x Do not use X-windows PGPLOT output\n\ |
---|
| 63 | (equivalent to setting flagXOutput=false -- overrides the parameter file)\n\n\ |
---|
[266] | 64 | -v Return version number and exit\n\ |
---|
| 65 | -h Display this help information and exit\n"; |
---|
[57] | 66 | |
---|
[759] | 67 | /// Usage message for command line help for Selavy. |
---|
[474] | 68 | const std::string SELAVY_ERR_USAGE_MSG = |
---|
| 69 | "Usage: Selavy [OPTION] [FILE]\n\ |
---|
| 70 | Selavy re-analyses and re-plots objects found by Duchamp.\n\ |
---|
| 71 | \n\ |
---|
| 72 | -p FILE Read in parameters from FILE, including FITS image location.\n\ |
---|
| 73 | -f FILE Use default parameters with imageFile=FILE\n\ |
---|
| 74 | -x Do not use X-windows PGPLOT output\n\ |
---|
| 75 | (equivalent to setting flagXOutput=false -- overrides the parameter file)\n\n\ |
---|
| 76 | -v Return version number and exit\n\ |
---|
| 77 | -h Display this help information and exit\n"; |
---|
| 78 | |
---|
[759] | 79 | /// Shorter Usage message for command line help. |
---|
[378] | 80 | const std::string ERR_USAGE_MSG_SHORT="Usage: Duchamp -p [parameter file]\n"; |
---|
[57] | 81 | |
---|
[759] | 82 | /// The program name. (Duchamp) |
---|
[378] | 83 | const std::string PROGNAME = PACKAGE_NAME; |
---|
[57] | 84 | |
---|
[759] | 85 | /// The program version |
---|
[378] | 86 | const std::string VERSION = PACKAGE_VERSION; |
---|
[71] | 87 | |
---|
[378] | 88 | // Specialised functions to report warnings and errors -- in duchamp.cc |
---|
[759] | 89 | /// Print a warning message to the stderr |
---|
[378] | 90 | void duchampWarning(std::string subroutine, std::string warning); |
---|
[759] | 91 | /// Print an error message to the stderr and sound the bell |
---|
[378] | 92 | void duchampError(std::string subroutine, std::string error); |
---|
[120] | 93 | |
---|
[872] | 94 | /// Define the duchamp exception class. |
---|
| 95 | class DuchampError: public std::runtime_error |
---|
| 96 | { |
---|
| 97 | public: |
---|
| 98 | /// Constructor taking a message |
---|
| 99 | explicit DuchampError(const std::string& message); |
---|
| 100 | /// empty destructor |
---|
| 101 | virtual ~DuchampError() throw(); |
---|
| 102 | }; |
---|
[201] | 103 | |
---|
[909] | 104 | // Macro to handle warnings, specifying the origin of the warning and taking a streamed input |
---|
| 105 | #define DUCHAMPWARN(origin,stream) \ |
---|
| 106 | { \ |
---|
| 107 | std::ostringstream oss; \ |
---|
| 108 | oss << stream; \ |
---|
| 109 | std::cerr << "WARNING <" << origin << ">: " << oss.str()<<"\n"; \ |
---|
| 110 | } |
---|
| 111 | |
---|
| 112 | // Macro to handle errors, with origin and streamed input. No exception is thrown (use DUCHAMPTHROW instead) |
---|
| 113 | #define DUCHAMPERROR(origin,stream) \ |
---|
| 114 | { \ |
---|
| 115 | std::ostringstream oss; \ |
---|
| 116 | oss << stream; \ |
---|
| 117 | std::cerr << "ERROR <" << origin << ">: " << oss.str() << "\n"; \ |
---|
| 118 | } |
---|
[872] | 119 | |
---|
[909] | 120 | #define DUCHAMPTHROW(origin,stream) \ |
---|
| 121 | { \ |
---|
| 122 | DUCHAMPERROR(origin,"\a"<<stream);\ |
---|
| 123 | std::ostringstream error; \ |
---|
| 124 | error << stream; \ |
---|
| 125 | throw DuchampError(error.str()); \ |
---|
| 126 | } |
---|
[872] | 127 | |
---|
[759] | 128 | /// The spectral type that we want the wcsprm structs to be in. |
---|
[772] | 129 | const char duchampVelocityType[9] = "VOPT-F2W"; |
---|
| 130 | //const char duchampVelocityType[9] = "VELO-F2V"; |
---|
[759] | 131 | /// The spectral type that we want the wcsprm structs to be in when no velocity info is present. |
---|
[378] | 132 | const char duchampFrequencyType[9] = "FREQ "; |
---|
[103] | 133 | |
---|
[759] | 134 | /// Descriptions of the various spectral axis types |
---|
[378] | 135 | enum TYPEDESC {FREQUENCY=0,VELOCITY,WAVELENGTH}; |
---|
[759] | 136 | /// Human-readable descriptions of the various spectral axis types |
---|
[378] | 137 | const std::string duchampSpectralDescription[3]= |
---|
| 138 | {"Frequency", "Velocity", "Wavelength"}; |
---|
[186] | 139 | |
---|
[378] | 140 | // The following are the FITS Header Keywords corresponding to the |
---|
| 141 | // parameters related to the atrous reconstruction. |
---|
[759] | 142 | |
---|
| 143 | /// FITS header keyword for min atrous scale |
---|
[378] | 144 | const std::string keyword_scaleMin = "DU_MINSC"; |
---|
[759] | 145 | /// FITS header keyword for S/N used in atrous reconstruction |
---|
[378] | 146 | const std::string keyword_snrRecon = "DU_ATCUT"; |
---|
[759] | 147 | /// FITS header keyword for number of dimensions used in atrous reconstruction |
---|
[378] | 148 | const std::string keyword_reconDim = "DU_ATDIM"; |
---|
[759] | 149 | /// FITS header keyword for the code number of the filter used in atrous reconstruction |
---|
[378] | 150 | const std::string keyword_filterCode = "DU_FILTR"; |
---|
[759] | 151 | /// FITS header keyword: does this file hold the reconstructed array or the residual? |
---|
[378] | 152 | const std::string keyword_ReconResid = "DU_RECON"; |
---|
[759] | 153 | /// FITS header keyword: type of smoothing done. |
---|
[378] | 154 | const std::string keyword_smoothtype = "DU_SMTYP"; |
---|
[759] | 155 | /// FITS header keyword for the gaussian kernel major axis FWHM |
---|
[378] | 156 | const std::string keyword_kernmaj = "DU_KMAJ"; |
---|
[759] | 157 | /// FITS header keyword for the gaussian kernel minor axis FWHM |
---|
[378] | 158 | const std::string keyword_kernmin = "DU_KMIN"; |
---|
[759] | 159 | /// FITS header keyword for the gaussian kernel position angle |
---|
[378] | 160 | const std::string keyword_kernpa = "DU_KPA"; |
---|
[759] | 161 | /// FITS header keyword for the Hanning filter width |
---|
[378] | 162 | const std::string keyword_hanningwidth = "DU_WHANN"; |
---|
[759] | 163 | /// FITS header keyword for the image subsection used |
---|
[378] | 164 | const std::string keyword_subsection = "DU_IMSUB"; |
---|
[142] | 165 | |
---|
[378] | 166 | // And these are the comments corresponding to the relevant keywords |
---|
[759] | 167 | /// FITS header comment for DU_MINSC keyword |
---|
[378] | 168 | const std::string comment_scaleMin = "Duchamp parameter scaleMin"; |
---|
[759] | 169 | /// FITS header comment for DU_ATCUT keyword |
---|
[378] | 170 | const std::string comment_snrRecon = "Duchamp parameter snrRecon"; |
---|
[759] | 171 | /// FITS header comment for DU_ATDIM keyword |
---|
[378] | 172 | const std::string comment_reconDim = "Duchamp parameter reconDim"; |
---|
[759] | 173 | /// FITS header comment for DU_FILTR keyword |
---|
[378] | 174 | const std::string comment_filterCode = "Duchamp parameter filterCode"; |
---|
[759] | 175 | /// FITS header comment for DU_RECON keyword |
---|
[378] | 176 | const std::string comment_ReconResid = "Is this the reconstruction or residual?"; |
---|
[759] | 177 | /// FITS header comment for DU_SMTYP keyword |
---|
[378] | 178 | const std::string comment_smoothtype = "Type of smoothing done"; |
---|
[759] | 179 | /// FITS header comment for DU_KMAJ keyword |
---|
[378] | 180 | const std::string comment_kernmaj = "Duchamp parameter kernMaj"; |
---|
[759] | 181 | /// FITS header comment for DU_KMIN keyword |
---|
[378] | 182 | const std::string comment_kernmin = "Duchamp parameter kernMin"; |
---|
[759] | 183 | /// FITS header comment for DU_KPA keyword |
---|
[378] | 184 | const std::string comment_kernpa = "Duchamp parameter kernPA"; |
---|
[759] | 185 | /// FITS header comment for DU_WHANN keyword |
---|
[378] | 186 | const std::string comment_hanningwidth = "Duchamp parameter hanningWidth"; |
---|
[759] | 187 | /// FITS header comment for DU_IMSUB keyword |
---|
[378] | 188 | const std::string comment_subsection = "Subsection of the original image"; |
---|
[105] | 189 | |
---|
[378] | 190 | // Descriptive Headers: for the reconstruction case |
---|
| 191 | const std::string header_reconHistory1 = |
---|
| 192 | "Reconstructed with a trous wavelet technique"; |
---|
| 193 | const std::string header_reconHistory2 = |
---|
[523] | 194 | "Reconstruction by " + PROGNAME + " v." + VERSION; |
---|
[378] | 195 | const std::string header_reconHistory_input = |
---|
[523] | 196 | "Original (input) image used by " + PROGNAME + " follows"; |
---|
[378] | 197 | const std::string header_reconSubsection_comment = |
---|
[523] | 198 | "A subsection of the original was reconstructed by " + PROGNAME; |
---|
[378] | 199 | const std::string header_atrous_comment = |
---|
| 200 | "The following are the Duchamp parameters used in reconstruction"; |
---|
[208] | 201 | |
---|
[378] | 202 | // Descriptive Headers: for the Smoothing case |
---|
| 203 | const std::string header_smoothHistory = |
---|
[523] | 204 | "Smoothed by " + PROGNAME + " v." + VERSION; |
---|
[378] | 205 | const std::string header_smoothHistory_input = |
---|
[523] | 206 | "Original (input) image used by " + PROGNAME + " follows"; |
---|
[378] | 207 | const std::string header_smoothSubsection_comment = |
---|
[523] | 208 | "A subsection of the original was smoothed by " + PROGNAME; |
---|
[378] | 209 | const std::string header_smoothSpatial = "Spatial, gaussian kernel"; |
---|
| 210 | const std::string header_smoothSpectral= "Spectral, hanning filter"; |
---|
| 211 | |
---|
[379] | 212 | // Descriptive Headers: for the output Mask image |
---|
| 213 | const std::string header_maskHistory = |
---|
[523] | 214 | "Results of searching by " + PROGNAME + " v." + VERSION; |
---|
[379] | 215 | const std::string header_maskHistory_input = |
---|
[523] | 216 | "Input image used by " + PROGNAME + " follows"; |
---|
[379] | 217 | const std::string header_maskSubsection_comment = |
---|
[523] | 218 | "A subsection of the original was searched by " + PROGNAME; |
---|
[379] | 219 | |
---|
[670] | 220 | // Descriptive Headers: for the output Moment-0 image |
---|
| 221 | const std::string header_moment0History = |
---|
| 222 | "Moment-0 map from searching by " + PROGNAME + " v." + VERSION; |
---|
| 223 | const std::string header_moment0History_input = |
---|
| 224 | "Input image used by " + PROGNAME + " follows"; |
---|
| 225 | const std::string header_moment0Subsection_comment = |
---|
| 226 | "A subsection of the original was searched by " + PROGNAME; |
---|
| 227 | |
---|
[378] | 228 | } |
---|
| 229 | |
---|
[489] | 230 | #ifdef HAVE_PGPLOT |
---|
| 231 | namespace duchamp |
---|
| 232 | { |
---|
| 233 | |
---|
| 234 | // Colours used in graphical output |
---|
[759] | 235 | /// The colour for the Blank edges |
---|
[489] | 236 | const int DUCHAMP_BLANK_EDGE_COLOUR = mycpgplot::MAGENTA; |
---|
[759] | 237 | /// The colour for the edge of the cube |
---|
[489] | 238 | const int DUCHAMP_CUBE_EDGE_COLOUR = mycpgplot::YELLOW; |
---|
[759] | 239 | /// The colour for the reconstructed spectra |
---|
[489] | 240 | const int DUCHAMP_RECON_SPECTRA_COLOUR = mycpgplot::RED; |
---|
[759] | 241 | /// The colour for the baseline spectra |
---|
[489] | 242 | const int DUCHAMP_BASELINE_SPECTRA_COLOUR = mycpgplot::YELLOW; |
---|
[759] | 243 | /// The colour for the object outline |
---|
[489] | 244 | const int DUCHAMP_OBJECT_OUTLINE_COLOUR = mycpgplot::BLUE; |
---|
[759] | 245 | /// The colour for the Milky-way region spectral boundaries |
---|
[489] | 246 | const int DUCHAMP_MILKY_WAY_COLOUR = mycpgplot::DARKGREEN; |
---|
[759] | 247 | /// The colour for the tick marks in the image cutouts |
---|
[489] | 248 | const int DUCHAMP_TICKMARK_COLOUR = mycpgplot::RED; |
---|
[759] | 249 | /// The colour for the text identifying objects on the maps |
---|
[489] | 250 | const int DUCHAMP_ID_TEXT_COLOUR = mycpgplot::RED; |
---|
[759] | 251 | /// The colour for the WCS axes on the maps |
---|
[489] | 252 | const int DUCHAMP_WCS_AXIS_COLOUR = mycpgplot::WCSGREEN; |
---|
| 253 | |
---|
| 254 | } |
---|
| 255 | |
---|
| 256 | #else |
---|
| 257 | namespace duchamp |
---|
| 258 | { |
---|
[759] | 259 | /// The colour for the text identifying objects on the maps |
---|
[489] | 260 | const int DUCHAMP_ID_TEXT_COLOUR = 2; |
---|
[759] | 261 | /// The colour for the WCS axes on the maps |
---|
[489] | 262 | const int DUCHAMP_WCS_AXIS_COLOUR = 3; |
---|
| 263 | |
---|
| 264 | } |
---|
| 265 | |
---|
[105] | 266 | #endif |
---|
| 267 | |
---|
[489] | 268 | |
---|
| 269 | #endif |
---|