[300] | 1 | // ----------------------------------------------------------------------- |
---|
| 2 | // detection.hh: Definition of the Detection class. |
---|
| 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 | #ifndef DETECTION_H |
---|
| 29 | #define DETECTION_H |
---|
| 30 | |
---|
| 31 | #include <iostream> |
---|
| 32 | #include <string> |
---|
| 33 | #include <vector> |
---|
[393] | 34 | #include <duchamp/param.hh> |
---|
| 35 | #include <duchamp/PixelMap/Voxel.hh> |
---|
| 36 | #include <duchamp/PixelMap/Object3D.hh> |
---|
| 37 | #include <duchamp/Detection/columns.hh> |
---|
[3] | 38 | |
---|
[570] | 39 | using namespace PixelInfo; |
---|
| 40 | |
---|
[378] | 41 | namespace duchamp |
---|
[3] | 42 | { |
---|
[258] | 43 | |
---|
| 44 | |
---|
[528] | 45 | /// Class to represent a contiguous set of detected voxels. |
---|
| 46 | /// This is a detected object, which features: |
---|
| 47 | /// a vector of voxels, average and centroid positions, total & peak fluxes, |
---|
| 48 | /// the possibility of WCS-calculated parameters (RA, Dec, velocity, |
---|
| 49 | /// related widths). |
---|
| 50 | /// Also many functions with which to manipulate the Detections. |
---|
[258] | 51 | |
---|
[570] | 52 | class Detection : public Object3D |
---|
[378] | 53 | { |
---|
| 54 | public: |
---|
| 55 | Detection(); |
---|
[570] | 56 | Detection(const Object3D& o); |
---|
[378] | 57 | Detection(const Detection& d); |
---|
| 58 | Detection& operator= (const Detection& d); |
---|
| 59 | virtual ~Detection(){}; |
---|
[570] | 60 | void defaultDetection(); |
---|
[378] | 61 | //------------------------------ |
---|
| 62 | // These are functions in detection.cc. |
---|
| 63 | // |
---|
[258] | 64 | |
---|
[770] | 65 | friend Detection operator+ (Detection &lhs, Detection &rhs); |
---|
| 66 | void addDetection(Detection &other); |
---|
[624] | 67 | |
---|
[770] | 68 | bool canMerge(Detection &other, Param &par); |
---|
| 69 | bool isNear(Detection &other, Param &par); |
---|
| 70 | bool isClose(Detection &other, Param &par); |
---|
| 71 | |
---|
[528] | 72 | /// @brief Test whether voxel lists match |
---|
[417] | 73 | bool voxelListsMatch(std::vector<PixelInfo::Voxel> voxelList); |
---|
| 74 | |
---|
[528] | 75 | /// @brief Test whether a voxel list contains all detected voxels |
---|
[463] | 76 | bool voxelListCovered(std::vector<PixelInfo::Voxel> voxelList); |
---|
| 77 | |
---|
[528] | 78 | /// @brief Calculate flux-related parameters of the Detection. |
---|
[378] | 79 | void calcFluxes(float *fluxArray, long *dim); |
---|
[528] | 80 | /// @brief Calculate flux-related parameters of the Detection. |
---|
[417] | 81 | void calcFluxes(std::vector<PixelInfo::Voxel> voxelList); |
---|
[258] | 82 | |
---|
[528] | 83 | /// @brief Calculate parameters related to the World Coordinate System. |
---|
[417] | 84 | // void calcWCSparams(float *fluxArray, long *dim, FitsHeader &head); |
---|
| 85 | void calcWCSparams(FitsHeader &head); |
---|
[258] | 86 | |
---|
[528] | 87 | /// @brief Calculate the integrated flux over the entire Detection. |
---|
[378] | 88 | void calcIntegFlux(float *fluxArray, long *dim, FitsHeader &head); |
---|
[528] | 89 | /// @brief Calculate the integrated flux over the entire Detection. |
---|
[719] | 90 | void calcIntegFlux(long zdim, std::vector<PixelInfo::Voxel> voxelList, FitsHeader &head); |
---|
[3] | 91 | |
---|
[719] | 92 | /// @brief Calculate the 20%-/50%-peak-flux widths in a general fashion |
---|
| 93 | void calcVelWidths(long zdim, float *intSpec, FitsHeader &head); |
---|
[528] | 94 | /// @brief Calculate the 20%/50% peak flux widths |
---|
[464] | 95 | void calcVelWidths(float *fluxArray, long *dim, FitsHeader &head); |
---|
[528] | 96 | /// @brief Calculate the 20%/50% peak flux widths |
---|
[719] | 97 | void calcVelWidths(long zdim, std::vector<PixelInfo::Voxel> voxelList, FitsHeader &head); |
---|
[464] | 98 | |
---|
[528] | 99 | /// @brief Set the values of the axis offsets from the cube. |
---|
[378] | 100 | void setOffsets(Param &par); |
---|
[221] | 101 | |
---|
[528] | 102 | /// @brief Add the offset values to the pixel locations |
---|
[570] | 103 | void addOffsets(long xoff, long yoff, long zoff){Object3D::addOffsets(xoff,yoff,zoff);}; |
---|
[378] | 104 | void addOffsets(){ |
---|
[570] | 105 | Object3D::addOffsets(xSubOffset,ySubOffset,zSubOffset); |
---|
[498] | 106 | xpeak+=xSubOffset; ypeak+=ySubOffset; zpeak+=zSubOffset; |
---|
| 107 | xCentroid+=xSubOffset; yCentroid+=ySubOffset; zCentroid+=zSubOffset; |
---|
[378] | 108 | }; |
---|
[221] | 109 | |
---|
[378] | 110 | // |
---|
| 111 | //--------------------------------- |
---|
| 112 | // Text Output -- all in Detection/outputDetection.cc |
---|
| 113 | // |
---|
[528] | 114 | /// @brief The spectral output label that contains info on the WCS position & velocity. |
---|
[378] | 115 | std::string outputLabelWCS(); |
---|
[282] | 116 | |
---|
[528] | 117 | /// @brief The spectral output label that contains info on the pixel location. |
---|
[378] | 118 | std::string outputLabelPix(); |
---|
[221] | 119 | |
---|
[528] | 120 | /// @brief The spectral output label that contains info on fluxes of the Detection. |
---|
[378] | 121 | std::string outputLabelFluxes(); |
---|
[265] | 122 | |
---|
[528] | 123 | /// @brief The spectral output label that contains info on widths of the Detection. |
---|
[378] | 124 | std::string outputLabelWidths(); |
---|
[265] | 125 | |
---|
[528] | 126 | /// @brief Print all required values for the Detection to a table. |
---|
[440] | 127 | void printTableRow(std::ostream &stream, std::vector<Column::Col> columns, std::string tableType); |
---|
[441] | 128 | |
---|
[528] | 129 | /// @brief Print a particular value for the Detection to a table. |
---|
[440] | 130 | void printTableEntry(std::ostream &stream, Column::Col column); |
---|
| 131 | |
---|
[378] | 132 | //---------------------------------- |
---|
| 133 | // For plotting routines... in Cubes/drawMomentCutout.cc |
---|
| 134 | // |
---|
[528] | 135 | /// @brief Get the location of the spatial borders. |
---|
[431] | 136 | std::vector<int> getVertexSet(); |
---|
| 137 | // |
---|
[528] | 138 | /// @brief Draw spatial borders for a particular Detection. |
---|
[378] | 139 | void drawBorders(int xoffset, int yoffset); |
---|
| 140 | // |
---|
[570] | 141 | |
---|
[378] | 142 | // |
---|
| 143 | //---------------------------------- |
---|
| 144 | // Basic functions |
---|
| 145 | // |
---|
[221] | 146 | |
---|
[528] | 147 | /// @brief Add a single voxel to the pixel list. |
---|
[570] | 148 | void addPixel(long x, long y, long z){Object3D::addPixel(x,y,z);}; |
---|
| 149 | |
---|
[528] | 150 | /// @brief Add a single voxel to the pixel list. |
---|
[378] | 151 | void addPixel(PixelInfo::Voxel point){ |
---|
[528] | 152 | /// @brief This one adds the pixel to the pixelArray, and updates the fluxes according to the Voxel's flux information |
---|
[570] | 153 | Object3D::addPixel(point.getX(),point.getY(),point.getZ()); |
---|
[378] | 154 | totalFlux += point.getF(); |
---|
| 155 | if(point.getF()>peakFlux){ |
---|
| 156 | peakFlux = point.getF(); |
---|
| 157 | xpeak = point.getX(); ypeak = point.getY(); zpeak = point.getZ(); |
---|
| 158 | } |
---|
| 159 | }; |
---|
[258] | 160 | |
---|
[528] | 161 | /// @brief How many channels does the Detection have? |
---|
[570] | 162 | long getNumChannels(){return Object3D::getNumDistinctZ();}; |
---|
[378] | 163 | |
---|
[528] | 164 | /// @brief Is there at least the acceptable minimum number of channels in the Detection? |
---|
[378] | 165 | bool hasEnoughChannels(int minNumber); |
---|
[258] | 166 | |
---|
[378] | 167 | //----------------------------------- |
---|
| 168 | // Basic accessor functions for private members follow... |
---|
| 169 | // |
---|
| 170 | long getXOffset(){return xSubOffset;}; |
---|
| 171 | void setXOffset(long o){xSubOffset = o;}; |
---|
| 172 | long getYOffset(){return ySubOffset;}; |
---|
| 173 | void setYOffset(long o){ySubOffset = o;}; |
---|
| 174 | long getZOffset(){return zSubOffset;}; |
---|
| 175 | void setZOffset(long o){zSubOffset = o;}; |
---|
| 176 | // |
---|
[681] | 177 | bool hasParams(){return haveParams;}; |
---|
| 178 | // |
---|
[570] | 179 | float getXcentre(); |
---|
| 180 | float getYcentre(); |
---|
| 181 | float getZcentre(); |
---|
[378] | 182 | float getTotalFlux(){return totalFlux;}; |
---|
| 183 | void setTotalFlux(float f){totalFlux=f;}; |
---|
| 184 | double getIntegFlux(){return intFlux;}; |
---|
| 185 | void setIntegFlux(double f){intFlux=f;}; |
---|
| 186 | float getPeakFlux(){return peakFlux;}; |
---|
| 187 | void setPeakFlux(float f){peakFlux=f;}; |
---|
| 188 | long getXPeak(){return xpeak;}; |
---|
| 189 | long getYPeak(){return ypeak;}; |
---|
| 190 | long getZPeak(){return zpeak;}; |
---|
| 191 | float getPeakSNR(){return peakSNR;}; |
---|
| 192 | void setPeakSNR(float f){peakSNR = f;}; |
---|
| 193 | float getXCentroid(){return xCentroid;}; |
---|
| 194 | float getYCentroid(){return yCentroid;}; |
---|
| 195 | float getZCentroid(){return zCentroid;}; |
---|
| 196 | std::string getCentreType(){return centreType;}; |
---|
| 197 | void setCentreType(std::string s){centreType=s;}; |
---|
| 198 | bool isNegative(){return negSource;}; |
---|
| 199 | void setNegative(bool f){negSource = f;}; |
---|
| 200 | std::string getFlagText(){return flagText;}; |
---|
| 201 | void setFlagText(std::string s){flagText = s;}; |
---|
| 202 | void addToFlagText(std::string s){flagText += s;}; |
---|
| 203 | // |
---|
[528] | 204 | /// @brief Is the WCS good enough to be used? |
---|
| 205 | /// \return Detection::flagWCS = True/False |
---|
[378] | 206 | bool isWCS(){return flagWCS;}; |
---|
| 207 | bool isSpecOK(){return specOK;}; |
---|
| 208 | void setSpecOK(bool b){specOK=b;}; |
---|
| 209 | std::string getName(){return name;}; |
---|
| 210 | void setName(std::string s){name=s;}; |
---|
| 211 | std::string getRAs(){return raS;}; |
---|
| 212 | std::string getDecs(){return decS;}; |
---|
| 213 | float getRA(){return ra;}; |
---|
| 214 | float getDec(){return dec;}; |
---|
| 215 | float getRAWidth(){return raWidth;}; |
---|
| 216 | float getDecWidth(){return decWidth;}; |
---|
[473] | 217 | float getMajorAxis(){return majorAxis;}; |
---|
| 218 | float getMinorAxis(){return minorAxis;}; |
---|
| 219 | float getPositionAngle(){return posang;}; |
---|
[378] | 220 | float getVel(){return vel;}; |
---|
| 221 | float getVelWidth(){return velWidth;}; |
---|
| 222 | float getVelMin(){return velMin;}; |
---|
| 223 | float getVelMax(){return velMax;}; |
---|
[463] | 224 | float getW20(){return w20;}; |
---|
| 225 | float getV20Min(){return v20min;}; |
---|
| 226 | float getV20Max(){return v20max;}; |
---|
| 227 | float getW50(){return w50;}; |
---|
| 228 | float getV50Min(){return v50min;}; |
---|
| 229 | float getV50Max(){return v50max;}; |
---|
[378] | 230 | int getID(){return id;}; |
---|
| 231 | void setID(int i){id = i;}; |
---|
| 232 | // |
---|
| 233 | int getPosPrec(){return posPrec;}; |
---|
| 234 | void setPosPrec(int i){posPrec=i;}; |
---|
| 235 | int getXYZPrec(){return xyzPrec;}; |
---|
| 236 | void setXYZPrec(int i){xyzPrec=i;}; |
---|
| 237 | int getFintPrec(){return fintPrec;}; |
---|
| 238 | void setFintPrec(int i){fintPrec=i;}; |
---|
| 239 | int getFpeakPrec(){return fpeakPrec;}; |
---|
| 240 | void setFpeakPrec(int i){fpeakPrec=i;}; |
---|
| 241 | int getVelPrec(){return velPrec;}; |
---|
| 242 | void setVelPrec(int i){velPrec=i;}; |
---|
| 243 | int getSNRPrec(){return snrPrec;}; |
---|
| 244 | void setSNRPrec(int i){snrPrec=i;}; |
---|
| 245 | // |
---|
[456] | 246 | protected: |
---|
[378] | 247 | // Subsection offsets |
---|
| 248 | long xSubOffset; ///< The x-offset, from subsectioned cube |
---|
| 249 | long ySubOffset; ///< The y-offset, from subsectioned cube |
---|
| 250 | long zSubOffset; ///< The z-offset, from subsectioned cube |
---|
[681] | 251 | bool haveParams; ///< Have the parameters been calculated? |
---|
[378] | 252 | // Flux related |
---|
| 253 | float totalFlux; ///< sum of the fluxes of all the pixels |
---|
[473] | 254 | double intFlux; ///< integrated flux : involves integration over velocity. |
---|
[378] | 255 | float peakFlux; ///< maximum flux over all the pixels |
---|
| 256 | long xpeak; ///< x-pixel location of peak flux |
---|
| 257 | long ypeak; ///< y-pixel location of peak flux |
---|
| 258 | long zpeak; ///< z-pixel location of peak flux |
---|
| 259 | float peakSNR; ///< signal-to-noise ratio at peak |
---|
| 260 | float xCentroid; ///< x-pixel location of centroid |
---|
| 261 | float yCentroid; ///< y-pixel location of centroid |
---|
| 262 | float zCentroid; ///< z-pixel location of centroid |
---|
[473] | 263 | std::string centreType; ///< which type of pixel centre to report: "average", "centroid", or "peak" (flux) |
---|
[378] | 264 | bool negSource; ///< is the source a negative feature? |
---|
[473] | 265 | std::string flagText; ///< any warning flags about the quality of the detection. |
---|
[378] | 266 | // WCS related |
---|
| 267 | int id; ///< ID -- generally number in list |
---|
[473] | 268 | std::string name; ///< IAU-style name (based on position) |
---|
| 269 | bool flagWCS; ///< A flag indicating whether the WCS parameters have been set. |
---|
| 270 | std::string raS; ///< Right Ascension (or Longitude) of pixel centre in form 12:34:23 |
---|
| 271 | std::string decS; ///< Declination (or Latitude) of pixel centre, in form -12:23:34 |
---|
| 272 | float ra; ///< Central Right Ascension in degrees |
---|
| 273 | float dec; ///< Central Declination in degrees |
---|
| 274 | float raWidth; ///< Width of detection in RA direction in arcmin |
---|
| 275 | float decWidth; ///< Width of detection in Dec direction in arcmin |
---|
| 276 | float majorAxis; ///< Major axis length in arcmin |
---|
| 277 | float minorAxis; ///< Minor axis length in arcmin |
---|
| 278 | float posang; ///< Position angle of the major axis, in degrees |
---|
[378] | 279 | bool specOK; ///< Is the spectral dimension valid? |
---|
| 280 | std::string specUnits; ///< Units of the spectral dimension |
---|
| 281 | std::string fluxUnits; ///< Units of flux |
---|
| 282 | std::string intFluxUnits; ///< Units of integrated flux |
---|
| 283 | std::string lngtype; ///< Type of longitude axis (RA/GLON) |
---|
| 284 | std::string lattype; ///< Type of latitude axis (DEC/GLAT) |
---|
[473] | 285 | float vel; ///< Central velocity (from zCentre) |
---|
[378] | 286 | float velWidth; ///< Full velocity width |
---|
| 287 | float velMin; ///< Minimum velocity |
---|
| 288 | float velMax; ///< Maximum velocity |
---|
[473] | 289 | float v20min; ///< Minimum velocity at 20% of peak flux |
---|
| 290 | float v20max; ///< Maximum velocity at 20% of peak flux |
---|
| 291 | float w20; ///< Velocity width at 20% of peak flux |
---|
| 292 | float v50min; ///< Minimum velocity at 50% of peak flux |
---|
| 293 | float v50max; ///< Maximum velocity at 50% of peak flux |
---|
| 294 | float w50; ///< Velocity width at 50% of peak flux |
---|
[531] | 295 | /// @brief The next six are the precision of values printed in the headers of the spectral plots |
---|
| 296 | /// @name |
---|
| 297 | /// @{ |
---|
[378] | 298 | int posPrec; ///< Precision of WCS positional values |
---|
[473] | 299 | int xyzPrec; ///< Precision of pixel positional values |
---|
[378] | 300 | int fintPrec; ///< Precision of F_int/F_tot values |
---|
| 301 | int fpeakPrec; ///< Precision of F_peak values |
---|
| 302 | int velPrec; ///< Precision of velocity values. |
---|
| 303 | int snrPrec; ///< Precision of S/N_max values. |
---|
[528] | 304 | /// @} |
---|
[378] | 305 | }; |
---|
[3] | 306 | |
---|
[378] | 307 | //========================================================================== |
---|
[221] | 308 | |
---|
[378] | 309 | ////////////////////////////////////////////////////// |
---|
| 310 | // Prototypes for functions that use above classes |
---|
| 311 | ////////////////////////////////////////////////////// |
---|
[3] | 312 | |
---|
[378] | 313 | //---------------- |
---|
| 314 | // These are in sorting.cc |
---|
| 315 | // |
---|
[528] | 316 | /// @brief Sort a list of Detections by Z-pixel value. |
---|
[378] | 317 | void SortByZ(std::vector <Detection> &inputList); |
---|
[221] | 318 | |
---|
[528] | 319 | /// @brief Sort a list of Detections by Velocity. |
---|
[378] | 320 | void SortByVel(std::vector <Detection> &inputList); |
---|
[221] | 321 | |
---|
[571] | 322 | /// @brief Sort a list of Detections by a nominated parameter |
---|
| 323 | void SortDetections(std::vector <Detection> &inputList, std::string parameter); |
---|
| 324 | |
---|
[378] | 325 | //---------------- |
---|
| 326 | // This is in areClose.cc |
---|
| 327 | // |
---|
[770] | 328 | // /// @brief Determine whether two objects are close according to set parameters. |
---|
| 329 | // bool areClose(Detection &object1, Detection &object2, Param &par); |
---|
[221] | 330 | |
---|
[378] | 331 | //---------------- |
---|
| 332 | // This is in mergeIntoList.cc |
---|
| 333 | // |
---|
[528] | 334 | /// @brief Add an object into a list, combining with adjacent objects if need be. |
---|
[378] | 335 | void mergeIntoList(Detection &object, std::vector <Detection> &objList, |
---|
| 336 | Param &par); |
---|
[3] | 337 | |
---|
[378] | 338 | //---------------- |
---|
| 339 | // These are in Cubes/Merger.cc |
---|
| 340 | // |
---|
[528] | 341 | /// @brief Merge a list of Detections so that all adjacent voxels are in the same Detection. |
---|
[378] | 342 | void mergeList(std::vector<Detection> &objList, Param &par); |
---|
[528] | 343 | /// @brief Culls a list of Detections that do not meet minimum requirements. |
---|
[378] | 344 | void finaliseList(std::vector<Detection> &objList, Param &par); |
---|
[528] | 345 | /// @brief Manage both the merging and the cleaning up of the list. |
---|
[378] | 346 | void ObjectMerger(std::vector<Detection> &objList, Param &par); |
---|
[56] | 347 | |
---|
[528] | 348 | /// @brief Print the header information to a particular table |
---|
[439] | 349 | void outputTableHeader(std::ostream &stream, std::vector<Column::Col> columns, std::string tableType, bool flagWCS); |
---|
| 350 | |
---|
[378] | 351 | } |
---|
[221] | 352 | |
---|
[3] | 353 | #endif |
---|