[301] | 1 | // ----------------------------------------------------------------------- |
---|
| 2 | // Object2D.hh: Definition of Object2D, a class to hold pixel |
---|
| 3 | // information for a 2-dimensional object. |
---|
| 4 | // ----------------------------------------------------------------------- |
---|
| 5 | // Copyright (C) 2006, Matthew Whiting, ATNF |
---|
| 6 | // |
---|
| 7 | // This program is free software; you can redistribute it and/or modify it |
---|
| 8 | // under the terms of the GNU General Public License as published by the |
---|
| 9 | // Free Software Foundation; either version 2 of the License, or (at your |
---|
| 10 | // option) any later version. |
---|
| 11 | // |
---|
| 12 | // Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
| 13 | // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
| 14 | // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
| 15 | // for more details. |
---|
| 16 | // |
---|
| 17 | // You should have received a copy of the GNU General Public License |
---|
| 18 | // along with Duchamp; if not, write to the Free Software Foundation, |
---|
| 19 | // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
| 20 | // |
---|
| 21 | // Correspondence concerning Duchamp may be directed to: |
---|
| 22 | // Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
| 23 | // Postal address: Dr. Matthew Whiting |
---|
| 24 | // Australia Telescope National Facility, CSIRO |
---|
| 25 | // PO Box 76 |
---|
| 26 | // Epping NSW 1710 |
---|
| 27 | // AUSTRALIA |
---|
| 28 | // ----------------------------------------------------------------------- |
---|
[238] | 29 | #ifndef OBJECT2D_H |
---|
| 30 | #define OBJECT2D_H |
---|
| 31 | |
---|
| 32 | #include <iostream> |
---|
| 33 | #include <algorithm> |
---|
| 34 | #include <vector> |
---|
[393] | 35 | #include <duchamp/PixelMap/Scan.hh> |
---|
| 36 | #include <duchamp/PixelMap/Voxel.hh> |
---|
[238] | 37 | |
---|
[252] | 38 | namespace PixelInfo |
---|
[238] | 39 | { |
---|
[252] | 40 | |
---|
[528] | 41 | /// @brief A class to store the pixel information for an object |
---|
| 42 | /// defined in a 2-dimensional plane. |
---|
| 43 | /// |
---|
| 44 | /// @details The object consists of a set of Scans (stored as a |
---|
| 45 | /// std::vector), together with basic information on the maximum, |
---|
| 46 | /// minimum, and average values (actually stored as xSum, ySum) for |
---|
| 47 | /// the x and y pixel values. |
---|
[252] | 48 | |
---|
| 49 | class Object2D |
---|
| 50 | { |
---|
| 51 | public: |
---|
[365] | 52 | Object2D(); |
---|
[252] | 53 | Object2D(const Object2D& o); |
---|
| 54 | Object2D& operator= (const Object2D& o); |
---|
| 55 | virtual ~Object2D(){}; |
---|
[238] | 56 | |
---|
[528] | 57 | /// @brief Clear the Object and set the number of pixels to zero. |
---|
[252] | 58 | void clear(){scanlist.clear(); numPix=0;}; |
---|
[238] | 59 | |
---|
[528] | 60 | /// @brief Make sure there are no overlapping or adjacent scans in the Scan list. |
---|
[252] | 61 | void cleanup(); |
---|
[240] | 62 | |
---|
[528] | 63 | /// @brief Add a pixel to the Object, making sure no scans overlap afterwards. |
---|
[252] | 64 | void addPixel(long x, long y); |
---|
[528] | 65 | /// @brief Add the (x,y) part of a Voxel to the Object, using addPixel(long,long) |
---|
[252] | 66 | void addPixel(Voxel v){this->addPixel(v.getX(),v.getY());}; |
---|
[528] | 67 | /// @brief Add a Pixel to the Object, using addPixel(long,long) |
---|
[252] | 68 | void addPixel(Pixel p){this->addPixel(p.getX(),p.getY());}; |
---|
[238] | 69 | |
---|
[528] | 70 | /// @brief Add a full Scan to the Object, making sure there are no overlapping scans afterwards. |
---|
[252] | 71 | void addScan(Scan scan); |
---|
| 72 | |
---|
[528] | 73 | /// @brief Test whether a pixel (x,y) is in the Object. |
---|
[252] | 74 | bool isInObject(long x, long y); |
---|
[528] | 75 | /// @brief Test whether the (x,y) part of a Voxel is in the Object. |
---|
[252] | 76 | bool isInObject(Voxel v){return this->isInObject(v.getX(),v.getY());}; |
---|
[528] | 77 | /// @brief Test whether a Pixel is in the Object. |
---|
[252] | 78 | bool isInObject(Pixel p){return this->isInObject(p.getX(),p.getY());}; |
---|
| 79 | |
---|
[528] | 80 | /// @brief Test whether a given Scan overlaps with any pixels in the Object. |
---|
[252] | 81 | bool scanOverlaps(Scan scan); |
---|
| 82 | |
---|
[528] | 83 | /// @brief Return the number of pixels in the Object. |
---|
[577] | 84 | unsigned long getSize(){return numPix;}; |
---|
[252] | 85 | |
---|
[528] | 86 | /// @brief Return the number of Scans in the Object. |
---|
[252] | 87 | long getNumScan(){return scanlist.size();}; |
---|
| 88 | |
---|
[528] | 89 | /// @brief Get the i-th Scan in the Scan list. |
---|
[252] | 90 | Scan getScan(int i){return scanlist[i];}; |
---|
| 91 | |
---|
[528] | 92 | /// @brief Order the Scans in the list, using the < operator for Scans. |
---|
[252] | 93 | void order(){std::stable_sort(scanlist.begin(),scanlist.end());}; |
---|
| 94 | |
---|
[528] | 95 | /// @brief Add values to the x- and y-axes, making sure to add the offsets to the sums and min/max values. |
---|
[399] | 96 | void addOffsets(long xoff, long yoff); |
---|
[252] | 97 | |
---|
[528] | 98 | /// @brief Calculate the sums, mins, maxs for x&y -- should not be necessary as these are done when pixels & Scans are added. |
---|
[252] | 99 | void calcParams(); |
---|
| 100 | |
---|
[528] | 101 | /// @brief Return the average x-value. |
---|
[570] | 102 | float getXaverage(){return xSum/float(numPix);}; |
---|
[252] | 103 | |
---|
[528] | 104 | /// @brief Return the average y-value. |
---|
[570] | 105 | float getYaverage(){return ySum/float(numPix);}; |
---|
[252] | 106 | |
---|
| 107 | long getXmin(){return xmin;}; |
---|
| 108 | long getYmin(){return ymin;}; |
---|
| 109 | long getXmax(){return xmax;}; |
---|
| 110 | long getYmax(){return ymax;}; |
---|
| 111 | |
---|
[528] | 112 | /// @brief Return the number of distinct y-values. |
---|
[252] | 113 | long getNumDistinctY(); |
---|
[528] | 114 | /// @brief Return the number of distinct x-values. |
---|
[252] | 115 | long getNumDistinctX(); |
---|
[238] | 116 | |
---|
[528] | 117 | /// @brief Return a measurement of the primary position angle |
---|
[469] | 118 | double getPositionAngle(); |
---|
[528] | 119 | /// @brief Return the lengths of the principal axes. |
---|
[469] | 120 | std::pair<double,double> getPrincipleAxes(); |
---|
| 121 | |
---|
[528] | 122 | /// @brief A stream output operator. |
---|
[252] | 123 | friend std::ostream& operator<< ( std::ostream& theStream, Object2D& obj); |
---|
[238] | 124 | |
---|
[528] | 125 | /// @brief Adding two Objects together. |
---|
[577] | 126 | friend Object2D operator+ (Object2D lhs, Object2D rhs); |
---|
[240] | 127 | |
---|
[252] | 128 | friend class Object3D; |
---|
[246] | 129 | |
---|
[252] | 130 | private: |
---|
| 131 | std::vector<Scan> scanlist; ///< The list of Scans |
---|
[577] | 132 | unsigned long numPix; ///< Number of pixels in the Object |
---|
[252] | 133 | float xSum; ///< Sum of x values |
---|
| 134 | float ySum; ///< Sum of y values |
---|
| 135 | long xmin,xmax; ///< min and max x-values of object |
---|
| 136 | long ymin,ymax; ///< min and max y-values of object |
---|
| 137 | }; |
---|
[238] | 138 | |
---|
[252] | 139 | } |
---|
| 140 | |
---|
[238] | 141 | #endif //OBJECT2D_H |
---|