[301] | 1 | // ----------------------------------------------------------------------- |
---|
[570] | 2 | // Object3D.hh: Definition of the Object3D class that holds |
---|
[301] | 3 | // pixel information for a three-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 OBJECT3D_H |
---|
| 30 | #define OBJECT3D_H |
---|
| 31 | |
---|
[393] | 32 | #include <duchamp/PixelMap/Voxel.hh> |
---|
| 33 | #include <duchamp/PixelMap/Scan.hh> |
---|
| 34 | #include <duchamp/PixelMap/Object2D.hh> |
---|
[658] | 35 | #include <duchamp/Utils/Section.hh> |
---|
[238] | 36 | #include <vector> |
---|
[244] | 37 | #include <algorithm> |
---|
[570] | 38 | #include <map> |
---|
[244] | 39 | #include <iostream> |
---|
[238] | 40 | |
---|
[252] | 41 | namespace PixelInfo |
---|
[238] | 42 | { |
---|
| 43 | |
---|
[528] | 44 | /// @brief A set of pixels in 3D. |
---|
| 45 | /// |
---|
[570] | 46 | /// @details This stores the pixels in a STL map, connecting a |
---|
| 47 | /// channel number (z-value) to a unique Object2D. Also recorded |
---|
| 48 | /// are the average x-, y- and z-values (via their sums), as well as |
---|
| 49 | /// their extrema. |
---|
[253] | 50 | |
---|
[252] | 51 | class Object3D |
---|
| 52 | { |
---|
| 53 | public: |
---|
[365] | 54 | Object3D(); |
---|
[252] | 55 | Object3D(const Object3D& o); |
---|
| 56 | Object3D& operator= (const Object3D& o); |
---|
| 57 | virtual ~Object3D(){}; |
---|
| 58 | |
---|
[528] | 59 | /// @brief Is a 3-D voxel in the Object? |
---|
[570] | 60 | bool isInObject(long x, long y, long z); |
---|
[528] | 61 | /// @brief Is a 3-D voxel in the Object? |
---|
[570] | 62 | bool isInObject(Voxel v){return isInObject(v.getX(),v.getY(),v.getZ());}; |
---|
[238] | 63 | |
---|
[528] | 64 | /// @brief Add a single 3-D voxel to the Object. |
---|
[570] | 65 | virtual void addPixel(long x, long y, long z); |
---|
[528] | 66 | /// @brief Add a single 3-D voxel to the Object. |
---|
[570] | 67 | virtual void addPixel(Voxel v){addPixel(v.getX(),v.getY(),v.getZ());}; |
---|
[528] | 68 | /// @brief Add a scan to the object |
---|
[570] | 69 | void addScan(Scan s, long z); |
---|
[528] | 70 | /// @brief Add a full channel map to the Object. |
---|
[570] | 71 | void addChannel(const long &z, Object2D &obj); |
---|
[770] | 72 | /// @brief Add a full channel map to the object. |
---|
| 73 | // void addChannel(const std::pair<long, Object2D> &chan){addChannel(chan.first,chan.second);}; |
---|
[238] | 74 | |
---|
[528] | 75 | /// @brief Calculate the averages and extrema of the three coordinates. |
---|
[570] | 76 | void calcParams(); |
---|
[528] | 77 | /// @brief Return the average x-value. |
---|
[570] | 78 | float getXaverage(); |
---|
[528] | 79 | /// @brief Return the average y-value. |
---|
[570] | 80 | float getYaverage(); |
---|
[528] | 81 | /// @brief Return the average z-value. |
---|
[570] | 82 | float getZaverage(); |
---|
[528] | 83 | /// @brief Return the minimum x-value. |
---|
[570] | 84 | long getXmin(){return xmin;}; |
---|
[528] | 85 | /// @brief Return the minimum y-value. |
---|
[570] | 86 | long getYmin(){return ymin;}; |
---|
[528] | 87 | /// @brief Return the minimum z-value. |
---|
[570] | 88 | long getZmin(){return zmin;}; |
---|
[528] | 89 | /// @brief Return the maximum x-value. |
---|
[570] | 90 | long getXmax(){return xmax;}; |
---|
[528] | 91 | /// @brief Return the maximum y-value. |
---|
[570] | 92 | long getYmax(){return ymax;}; |
---|
[528] | 93 | /// @brief Return the maximum z-value. |
---|
[570] | 94 | long getZmax(){return zmax;}; |
---|
[238] | 95 | |
---|
[528] | 96 | /// @brief Return the number of distinct voxels in the Object. |
---|
[570] | 97 | unsigned int getSize(){return numVox;}; |
---|
[253] | 98 | |
---|
[528] | 99 | /// @brief Return the number of distinct channels in the Object. |
---|
[570] | 100 | long getNumDistinctZ(){return chanlist.size();}; |
---|
[253] | 101 | |
---|
[528] | 102 | /// @brief Return the number of channels in the Object. |
---|
[570] | 103 | long getNumChanMap(){return chanlist.size();}; |
---|
[253] | 104 | |
---|
[528] | 105 | /// @brief Return the number of spatial pixels -- ie. the number of distinct (x,y) sets in the Object. |
---|
[577] | 106 | unsigned long getSpatialSize(); |
---|
[253] | 107 | |
---|
[528] | 108 | /// @brief Return a vector set of all voxels in the Object. |
---|
[252] | 109 | std::vector<Voxel> getPixelSet(); |
---|
[724] | 110 | /// @brief Return a vector set of all voxels in the Object, with flux values from the given array. |
---|
| 111 | std::vector<Voxel> getPixelSet(float *array, long *dim); |
---|
[241] | 112 | |
---|
[570] | 113 | /// @brief Return a vector list of the channel numbers in the Object |
---|
| 114 | std::vector<long> getChannelList(); |
---|
[253] | 115 | |
---|
[570] | 116 | /// @brief Return the largest number of adjacent channels in the Object. |
---|
| 117 | int getMaxAdjacentChannels(); |
---|
[238] | 118 | |
---|
[570] | 119 | /// @brief Get the channel map for channel z. |
---|
| 120 | Object2D getChanMap(long z); |
---|
| 121 | |
---|
[528] | 122 | /// @brief Return an Object2D showing the spatial (x,y) distribution of voxels in the Object |
---|
[252] | 123 | Object2D getSpatialMap(); |
---|
[238] | 124 | |
---|
[528] | 125 | /// @brief Add constant offsets to each of the dimensions, changing the parameters at the same time. |
---|
[570] | 126 | virtual void addOffsets(long xoff, long yoff, long zoff); |
---|
[240] | 127 | |
---|
[658] | 128 | /// @brief Return the bounding box for the object, as a duchamp::Section object |
---|
| 129 | duchamp::Section getBoundingSection(int boundary=1); |
---|
| 130 | |
---|
[773] | 131 | /// @brief Class function to print to a stream |
---|
| 132 | void print(std::ostream& theStream); |
---|
| 133 | |
---|
[528] | 134 | /// @brief Output operator for the Object3D. |
---|
[252] | 135 | friend std::ostream& operator<< ( std::ostream& theStream, Object3D& obj); |
---|
[238] | 136 | |
---|
[528] | 137 | /// @brief Add two Object3Ds. Overlapping channels are combined using addChannel(). |
---|
[570] | 138 | friend Object3D operator+ (Object3D lhs, Object3D rhs); |
---|
[240] | 139 | |
---|
[570] | 140 | protected: |
---|
| 141 | std::map<long,Object2D> chanlist; ///< The list of 2D channel maps |
---|
| 142 | unsigned long numVox; ///< How many voxels in the Object? |
---|
| 143 | float xSum; ///< Sum of the x-values |
---|
| 144 | float ySum; ///< Sum of the y-values |
---|
| 145 | float zSum; ///< Sum of the z-values |
---|
| 146 | long xmin,xmax; ///< min and max x-values of object |
---|
| 147 | long ymin,ymax; ///< min and max y-values of object |
---|
| 148 | long zmin,zmax; ///< min and max z-values of object |
---|
[252] | 149 | }; |
---|
[240] | 150 | |
---|
[252] | 151 | } |
---|
[238] | 152 | |
---|
| 153 | #endif //OBJECT3D_H |
---|