1 | // ----------------------------------------------------------------------- |
---|
2 | // Section.hh: Definition of the Section class, used to store |
---|
3 | // definitions of subsections of a FITS file. |
---|
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 | // ----------------------------------------------------------------------- |
---|
29 | #ifndef SECTION_H |
---|
30 | #define SECTION_H |
---|
31 | |
---|
32 | #include <string> |
---|
33 | #include <vector> |
---|
34 | #include <duchamp/duchamp.hh> |
---|
35 | |
---|
36 | namespace duchamp |
---|
37 | { |
---|
38 | |
---|
39 | /// @brief A class to store information on subsections of a cube. |
---|
40 | /// |
---|
41 | /// @details This keeps the subsection itself as a string, plus the |
---|
42 | /// parsed information in the format of vectors of starting |
---|
43 | /// positions and lengths of each dimension. |
---|
44 | |
---|
45 | class Section |
---|
46 | { |
---|
47 | public: |
---|
48 | Section(); |
---|
49 | Section(std::string &s){subsection=s; numSections=0; flagParsed=false;}; |
---|
50 | Section(const Section& s); |
---|
51 | Section& operator= (const Section& s); |
---|
52 | virtual ~Section(){}; |
---|
53 | |
---|
54 | /// @brief Has the section been defined by a parse() call? |
---|
55 | bool isDefined(){return numSections>0;}; |
---|
56 | |
---|
57 | /// @brief Are all axis sections of length >0? |
---|
58 | bool isValid(); |
---|
59 | |
---|
60 | /// @brief Convert the subsection string into the lists of numerical values. |
---|
61 | OUTCOME parse(std::vector<size_t> dimAxes); |
---|
62 | OUTCOME parse(std::vector<long> dimAxes); |
---|
63 | OUTCOME parse(std::vector<int> dimAxes); |
---|
64 | OUTCOME parse(size_t *dim, int size); |
---|
65 | OUTCOME parse(long *dim, int size); |
---|
66 | |
---|
67 | bool isParsed(){return flagParsed;}; |
---|
68 | |
---|
69 | /// @brief Test whether a given voxel (x,y,z) lies within the subsection |
---|
70 | bool isInside(int x, int y, int z){ |
---|
71 | return ( ( (x>=starts[0])&&(x<starts[0]+dims[0]) ) && |
---|
72 | ( (y>=starts[1])&&(y<starts[1]+dims[1]) ) && |
---|
73 | ( (z>=starts[2])&&(z<starts[2]+dims[2]) ) ); |
---|
74 | } |
---|
75 | |
---|
76 | /// @brief Save the subsection string |
---|
77 | void setSection(std::string s){subsection=s;}; |
---|
78 | /// @brief Return the subsection string |
---|
79 | std::string getSection(){return subsection;}; |
---|
80 | |
---|
81 | /// @brief Save a single dimension's subsection string |
---|
82 | void setSection(unsigned int i, std::string s){sections[i] = s;}; |
---|
83 | /// @brief Return a particular dimension's subsection string |
---|
84 | std::string getSection(unsigned int i){if(i>=numSections) return "*"; else return sections[i];}; |
---|
85 | |
---|
86 | /// @brief Return a particular starting value |
---|
87 | int getStart(unsigned int i){if(i>=numSections) return 0; else return starts[i];}; |
---|
88 | /// @brief Set a particular starting value |
---|
89 | void setStart(unsigned int i, unsigned int val){starts[i]=val;}; |
---|
90 | |
---|
91 | /// @brief Return a particular dimension length |
---|
92 | int getDim(unsigned int i){if(i>=numSections) return 1; else return dims[i];}; |
---|
93 | /// @brief Set a particular dimension length |
---|
94 | void setDim(unsigned int i, unsigned int val){dims[i]=val;}; |
---|
95 | |
---|
96 | /// @brief Return a particular ending value |
---|
97 | int getEnd(unsigned int i){if(i>=numSections) return 0; else return starts[i]+dims[i]-1;}; |
---|
98 | /// @brief Set a particular ending value, using the current starting value |
---|
99 | void setEnd(unsigned int i, unsigned int val){dims[i]=val-starts[i]+1;}; |
---|
100 | |
---|
101 | /// @brief Return the full list of start values |
---|
102 | std::vector<int> getStartList(){return starts;}; |
---|
103 | /// @brief Return the full list of dimension lengths |
---|
104 | std::vector<int> getDimList(){return dims;}; |
---|
105 | |
---|
106 | /// @brief Return a section that is the intersection of this with another |
---|
107 | Section intersect(Section &other); |
---|
108 | |
---|
109 | /// @brief Return a section that is the intersection of this with the full section given by a set of axis dimensions |
---|
110 | Section intersect(std::vector<long> dimAxes); |
---|
111 | Section intersect(std::vector<int> dimAxes); |
---|
112 | Section intersect(long *dim, int size); |
---|
113 | |
---|
114 | /// @brief Return a section that is the result of applying some subseection of the current one, where the "other" subsection acts in the coordinates of this. |
---|
115 | friend Section operator* (Section &lhs, Section &rhs); |
---|
116 | |
---|
117 | private: |
---|
118 | bool flagParsed; ///< Has the Section been parsed yet? |
---|
119 | std::string subsection; ///< The string indicating the subsection, of the format [a:b,c:d,e:f] etc. |
---|
120 | std::vector<std::string> sections; // The individual section strings for each dimension |
---|
121 | size_t numSections; ///< The number of sections in the string. |
---|
122 | std::vector<int> starts; ///< The list of starting values (a,c,e) |
---|
123 | std::vector<int> dims; ///< The list of lengths of each dimension (b-a+1,d-c+1,f-e+1) |
---|
124 | }; |
---|
125 | |
---|
126 | std::string nullSection(int ndim); |
---|
127 | |
---|
128 | } |
---|
129 | |
---|
130 | #endif //SECTION_H |
---|