[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> |
---|
[125] | 32 | #include <string> |
---|
[393] | 33 | #include <duchamp/Utils/mycpgplot.hh> |
---|
[125] | 34 | |
---|
[141] | 35 | #undef PACKAGE_BUGREPORT |
---|
| 36 | #undef PACKAGE_NAME |
---|
| 37 | #undef PACKAGE_STRING |
---|
| 38 | #undef PACKAGE_TARNAME |
---|
| 39 | #undef PACKAGE_VERSION |
---|
[321] | 40 | #undef HAVE_PGPLOT |
---|
[110] | 41 | #include "config.h" |
---|
| 42 | |
---|
[378] | 43 | namespace duchamp |
---|
| 44 | { |
---|
[71] | 45 | |
---|
[378] | 46 | /** how to convey whether a function has worked */ |
---|
| 47 | enum OUTCOME {SUCCESS=0, FAILURE}; |
---|
| 48 | |
---|
| 49 | /** Usage message for command line help. */ |
---|
| 50 | const std::string ERR_USAGE_MSG = |
---|
| 51 | "Usage: Duchamp [OPTION] [FILE]\n\ |
---|
[266] | 52 | Duchamp is an object finder for spectral-line FITS cubes.\n\ |
---|
| 53 | \n\ |
---|
| 54 | -p FILE Read in parameters from FILE, including FITS image location.\n\ |
---|
| 55 | -f FILE Use default parameters with imageFile=FILE\n\ |
---|
[294] | 56 | -x Do not use X-windows PGPLOT output\n\ |
---|
| 57 | (equivalent to setting flagXOutput=false -- overrides the parameter file)\n\n\ |
---|
[266] | 58 | -v Return version number and exit\n\ |
---|
| 59 | -h Display this help information and exit\n"; |
---|
[57] | 60 | |
---|
[378] | 61 | /** Shorter Usage message for command line help. */ |
---|
| 62 | const std::string ERR_USAGE_MSG_SHORT="Usage: Duchamp -p [parameter file]\n"; |
---|
[57] | 63 | |
---|
[378] | 64 | /** The program name. (Duchamp) */ |
---|
| 65 | const std::string PROGNAME = PACKAGE_NAME; |
---|
[57] | 66 | |
---|
[378] | 67 | /** The program version */ |
---|
| 68 | const std::string VERSION = PACKAGE_VERSION; |
---|
[71] | 69 | |
---|
[378] | 70 | // Specialised functions to report warnings and errors -- in duchamp.cc |
---|
| 71 | /** Print a warning message to the stderr */ |
---|
| 72 | void duchampWarning(std::string subroutine, std::string warning); |
---|
| 73 | /** Print an error message to the stderr and sound the bell */ |
---|
| 74 | void duchampError(std::string subroutine, std::string error); |
---|
[120] | 75 | |
---|
[201] | 76 | |
---|
[378] | 77 | /** The spectral type that we want the wcsprm structs to be in. */ |
---|
| 78 | const char duchampVelocityType[9] = "VOPT-F2W"; |
---|
| 79 | /** The spectral type that we want the wcsprm structs to be in when no |
---|
| 80 | velocity info is present. */ |
---|
| 81 | const char duchampFrequencyType[9] = "FREQ "; |
---|
[103] | 82 | |
---|
[378] | 83 | /** Descriptions of the various spectral axis types */ |
---|
| 84 | enum TYPEDESC {FREQUENCY=0,VELOCITY,WAVELENGTH}; |
---|
| 85 | /** Human-readable descriptions of the various spectral axis types */ |
---|
| 86 | const std::string duchampSpectralDescription[3]= |
---|
| 87 | {"Frequency", "Velocity", "Wavelength"}; |
---|
[186] | 88 | |
---|
[378] | 89 | // Colours used in graphical output |
---|
| 90 | /** The colour for the Blank edges */ |
---|
| 91 | const int DUCHAMP_BLANK_EDGE_COLOUR = mycpgplot::MAGENTA; |
---|
| 92 | /** The colour for the edge of the cube */ |
---|
| 93 | const int DUCHAMP_CUBE_EDGE_COLOUR = mycpgplot::YELLOW; |
---|
| 94 | /** The colour for the reconstructed spectra */ |
---|
| 95 | const int DUCHAMP_RECON_SPECTRA_COLOUR = mycpgplot::RED; |
---|
| 96 | /** The colour for the baseline spectra */ |
---|
| 97 | const int DUCHAMP_BASELINE_SPECTRA_COLOUR = mycpgplot::YELLOW; |
---|
| 98 | /** The colour for the object outline */ |
---|
| 99 | const int DUCHAMP_OBJECT_OUTLINE_COLOUR = mycpgplot::BLUE; |
---|
| 100 | /** The colour for the Milky-way region spectral boundaries */ |
---|
| 101 | const int DUCHAMP_MILKY_WAY_COLOUR = mycpgplot::DARKGREEN; |
---|
| 102 | /** The colour for the tick marks in the image cutouts */ |
---|
| 103 | const int DUCHAMP_TICKMARK_COLOUR = mycpgplot::RED; |
---|
| 104 | /** The colour for the text identifying objects on the maps */ |
---|
| 105 | const int DUCHAMP_ID_TEXT_COLOUR = mycpgplot::RED; |
---|
| 106 | /** The colour for the WCS axes on the maps */ |
---|
| 107 | const int DUCHAMP_WCS_AXIS_COLOUR = mycpgplot::WCSGREEN; |
---|
[316] | 108 | |
---|
[378] | 109 | // The following are the FITS Header Keywords corresponding to the |
---|
| 110 | // parameters related to the atrous reconstruction. |
---|
| 111 | /** FITS header keyword for min atrous scale*/ |
---|
| 112 | const std::string keyword_scaleMin = "DU_MINSC"; |
---|
| 113 | /** FITS header keyword for S/N used in atrous reconstruction*/ |
---|
| 114 | const std::string keyword_snrRecon = "DU_ATCUT"; |
---|
| 115 | /** FITS header keyword for number of dimensions used in atrous |
---|
| 116 | reconstruction*/ |
---|
| 117 | const std::string keyword_reconDim = "DU_ATDIM"; |
---|
| 118 | /** FITS header keyword for the code number of the filter used in |
---|
| 119 | atrous reconstruction*/ |
---|
| 120 | const std::string keyword_filterCode = "DU_FILTR"; |
---|
| 121 | /** FITS header keyword: does this file hold the reconstructed array |
---|
| 122 | or the residual?*/ |
---|
| 123 | const std::string keyword_ReconResid = "DU_RECON"; |
---|
| 124 | /** FITS header keyword: type of smoothing done. */ |
---|
| 125 | const std::string keyword_smoothtype = "DU_SMTYP"; |
---|
| 126 | /** FITS header keyword for the gaussian kernel major axis FWHM*/ |
---|
| 127 | const std::string keyword_kernmaj = "DU_KMAJ"; |
---|
| 128 | /** FITS header keyword for the gaussian kernel minor axis FWHM*/ |
---|
| 129 | const std::string keyword_kernmin = "DU_KMIN"; |
---|
| 130 | /** FITS header keyword for the gaussian kernel position angle*/ |
---|
| 131 | const std::string keyword_kernpa = "DU_KPA"; |
---|
| 132 | /** FITS header keyword for the Hanning filter width*/ |
---|
| 133 | const std::string keyword_hanningwidth = "DU_WHANN"; |
---|
| 134 | /** FITS header keyword for the image subsection used*/ |
---|
| 135 | const std::string keyword_subsection = "DU_IMSUB"; |
---|
[142] | 136 | |
---|
[378] | 137 | // And these are the comments corresponding to the relevant keywords |
---|
| 138 | /** FITS header comment for DU_MINSC keyword*/ |
---|
| 139 | const std::string comment_scaleMin = "Duchamp parameter scaleMin"; |
---|
| 140 | /** FITS header comment for DU_ATCUT keyword*/ |
---|
| 141 | const std::string comment_snrRecon = "Duchamp parameter snrRecon"; |
---|
| 142 | /** FITS header comment for DU_ATDIM keyword*/ |
---|
| 143 | const std::string comment_reconDim = "Duchamp parameter reconDim"; |
---|
| 144 | /** FITS header comment for DU_FILTR keyword*/ |
---|
| 145 | const std::string comment_filterCode = "Duchamp parameter filterCode"; |
---|
| 146 | /** FITS header comment for DU_RECON keyword*/ |
---|
| 147 | const std::string comment_ReconResid = "Is this the reconstruction or residual?"; |
---|
| 148 | /** FITS header comment for DU_SMTYP keyword*/ |
---|
| 149 | const std::string comment_smoothtype = "Type of smoothing done"; |
---|
| 150 | /** FITS header comment for DU_KMAJ keyword*/ |
---|
| 151 | const std::string comment_kernmaj = "Duchamp parameter kernMaj"; |
---|
| 152 | /** FITS header comment for DU_KMIN keyword*/ |
---|
| 153 | const std::string comment_kernmin = "Duchamp parameter kernMin"; |
---|
| 154 | /** FITS header comment for DU_KPA keyword*/ |
---|
| 155 | const std::string comment_kernpa = "Duchamp parameter kernPA"; |
---|
| 156 | /** FITS header comment for DU_WHANN keyword*/ |
---|
| 157 | const std::string comment_hanningwidth = "Duchamp parameter hanningWidth"; |
---|
| 158 | /** FITS header comment for DU_IMSUB keyword*/ |
---|
| 159 | const std::string comment_subsection = "Subsection of the original image"; |
---|
[105] | 160 | |
---|
[378] | 161 | // Descriptive Headers: for the reconstruction case |
---|
| 162 | const std::string header_reconHistory1 = |
---|
| 163 | "Reconstructed with a trous wavelet technique"; |
---|
| 164 | const std::string header_reconHistory2 = |
---|
| 165 | "Reconstruction by Duchamp v." + VERSION; |
---|
| 166 | const std::string header_reconHistory_input = |
---|
| 167 | "Original (input) image used by Duchamp follows"; |
---|
| 168 | const std::string header_reconSubsection_comment = |
---|
| 169 | "A subsection of the original was reconstructed by Duchamp"; |
---|
| 170 | const std::string header_atrous_comment = |
---|
| 171 | "The following are the Duchamp parameters used in reconstruction"; |
---|
[208] | 172 | |
---|
[378] | 173 | // Descriptive Headers: for the Smoothing case |
---|
| 174 | const std::string header_smoothHistory = |
---|
| 175 | "Smoothed by Duchamp v." + VERSION; |
---|
| 176 | const std::string header_smoothHistory_input = |
---|
| 177 | "Original (input) image used by Duchamp follows"; |
---|
| 178 | const std::string header_smoothSubsection_comment = |
---|
| 179 | "A subsection of the original was smoothed by Duchamp"; |
---|
| 180 | const std::string header_smoothSpatial = "Spatial, gaussian kernel"; |
---|
| 181 | const std::string header_smoothSpectral= "Spectral, hanning filter"; |
---|
| 182 | |
---|
[379] | 183 | // Descriptive Headers: for the output Mask image |
---|
| 184 | const std::string header_maskHistory = |
---|
| 185 | "Results of searching by Duchamp v." + VERSION; |
---|
| 186 | const std::string header_maskHistory_input = |
---|
| 187 | "Input image used by Duchamp follows"; |
---|
| 188 | const std::string header_maskSubsection_comment = |
---|
| 189 | "A subsection of the original was searched by Duchamp"; |
---|
| 190 | |
---|
[378] | 191 | } |
---|
| 192 | |
---|
[105] | 193 | #endif |
---|
| 194 | |
---|