LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
MaskDict.cc
Go to the documentation of this file.
1/*
2 * Developed for the LSST Data Management System.
3 * This product includes software developed by the LSST Project
4 * (https://www.lsst.org).
5 * See the COPYRIGHT file at the top-level directory of this distribution
6 * for details of code ownership.
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22#include <mutex>
23#include <set>
24
25#include "boost/functional/hash.hpp"
27
28namespace lsst { namespace afw { namespace image { namespace detail {
29
30// A thread-safe singleton that manages MaskDict's global state.
32public:
33
34 static GlobalState & get() {
35 static GlobalState instance;
36 return instance;
37 }
38
41 if (!mpd.empty()) {
43 _allMaskDicts.insert(dict);
44 return dict;
45 }
46 return _defaultMaskDict;
47 }
48
52 _allMaskDicts.insert(result);
53 return result;
54 }
55
57 return _defaultMaskDict;
58 }
59
61 _defaultMaskDict = std::move(dict);
62 }
63
66 _defaultMaskDict = copy(*_defaultMaskDict);
67 return _defaultMaskDict;
68 }
69
70 template <typename Functor>
71 void forEachMaskDict(Functor functor) {
73 _prune(); // guarantees dereference below is safe
74 for (auto const & ptr : _allMaskDicts) {
75 functor(*ptr.lock());
76 }
77 }
78
79private:
80
81 GlobalState() : _defaultMaskDict(new MaskDict()) {
82 _allMaskDicts.insert(_defaultMaskDict);
83 _defaultMaskDict->_addInitialMaskPlanes();
84 }
85
86 GlobalState(GlobalState const &) = delete;
87 GlobalState(GlobalState &&) = delete;
88
89 GlobalState & operator=(GlobalState const &) = delete;
90 GlobalState & operator=(GlobalState &&) = delete;
91
92 ~GlobalState() = default;
93
94 // Prune expired weak_ptrs from _allMaskDicts. Not thread safe; should
95 // only be called by routines that have already locked the mutex.
96 void _prune() {
97 for (auto iter = _allMaskDicts.begin(); iter != _allMaskDicts.end(); ) {
98 if (iter->expired()) {
99 iter = _allMaskDicts.erase(iter);
100 } else {
101 ++iter;
102 }
103 }
104 }
105
106 std::recursive_mutex _mutex; // guards _allMaskDicts and synchronizes updates to it and _defaultMaskDict
108 std::shared_ptr<MaskDict> _defaultMaskDict;
109};
110
114
118
122
126
127void MaskDict::addAllMasksPlane(std::string const & name, int bitId) {
129 [&name, bitId](MaskDict & dict) {
130 auto const found = std::find_if(
131 dict.begin(), dict.end(),
132 [bitId](auto const & item) { return item.second == bitId; }
133 );
134 if (found == dict.end()) {
135 // is name already in use?
136 if (dict.find(name) == dict.end()) {
137 dict.add(name, bitId);
138 }
139 }
140 }
141 );
142}
143
144MaskDict::~MaskDict() noexcept = default;
145
146std::shared_ptr<MaskDict> MaskDict::clone() const {
147 return GlobalState::get().copy(*this);
148}
149
151 if (empty()) {
152 return 0;
153 }
154
155 auto const maxIter = std::max_element(
156 begin(), end(),
157 [](auto const & a, auto const & b) { return a.second < b.second; }
158 );
159 assert(maxIter != end());
160 int id = maxIter->second + 1; // The maskPlane to use if there are no gaps
161
162 for (int i = 0; i < id; ++i) {
163 // is i already used in this Mask?
164 auto const sameIter = std::find_if(
165 begin(), end(),
166 [i](auto const & item) { return item.second == i; }
167 );
168 if (sameIter == end()) { // Not used; so we'll use it
169 return i;
170 }
171 }
172
173 return id;
174}
175
176int MaskDict::getMaskPlane(std::string const & name) const {
177 auto iter = find(name);
178 return (iter == end()) ? -1 : iter->second;
179}
180
181void MaskDict::print() const {
182 for (auto const & item : *this) {
183 std::cout << "Plane " << item.second << " -> " << item.first << std::endl;
184 }
185}
186
187bool MaskDict::operator==(MaskDict const& rhs) const {
188 return this == &rhs || (_hash == rhs._hash && _dict == rhs._dict);
189}
190
191void MaskDict::add(std::string const & name, int bitId) {
192 _dict[name] = bitId;
193 _hash = boost::hash<MaskPlaneDict>()(_dict);
194}
195
196void MaskDict::erase(std::string const & name) {
197 _dict.erase(name);
198 _hash = boost::hash<MaskPlaneDict>()(_dict);
199}
200
202 _dict.clear();
203 _hash = 0x0;
204}
205
206void MaskDict::_addInitialMaskPlanes() {
207 int i = -1;
208 _dict["BAD"] = ++i;
209 _dict["SAT"] = ++i;
210 _dict["INTRP"] = ++i;
211 _dict["CR"] = ++i;
212 _dict["EDGE"] = ++i;
213 _dict["DETECTED"] = ++i;
214 _dict["DETECTED_NEGATIVE"] = ++i;
215 _dict["SUSPECT"] = ++i;
216 _dict["NO_DATA"] = ++i;
217 _hash = boost::hash<MaskPlaneDict>()(_dict);
218}
219
220MaskDict::MaskDict() : _dict(), _hash(0x0) {}
221
222MaskDict::MaskDict(MaskPlaneDict const & dict) : _dict(dict), _hash(boost::hash<MaskPlaneDict>()(_dict)) {}
223
224}}}} // lsst::afw::image::detail
py::object result
Definition _schema.cc:429
table::Key< std::string > name
Definition Amplifier.cc:116
table::Key< int > id
Definition Detector.cc:162
uint64_t * ptr
Definition RangeSet.cc:95
table::Key< int > b
std::shared_ptr< MaskDict > getDefault() const noexcept
Definition MaskDict.cc:56
std::shared_ptr< MaskDict > copyOrGetDefault(MaskPlaneDict const &mpd)
Definition MaskDict.cc:39
std::shared_ptr< MaskDict > copy(MaskDict const &dict)
Definition MaskDict.cc:49
void setDefault(std::shared_ptr< MaskDict > dict)
Definition MaskDict.cc:60
std::shared_ptr< MaskDict > detachDefault()
Definition MaskDict.cc:64
int getMaskPlane(std::string const &name) const
Definition MaskDict.cc:176
const_iterator begin() const noexcept
Definition MaskDict.h:131
static void addAllMasksPlane(std::string const &name, int bitId)
Definition MaskDict.cc:127
static std::shared_ptr< MaskDict > detachDefault()
Definition MaskDict.cc:123
const_iterator end() const noexcept
Definition MaskDict.h:132
static std::shared_ptr< MaskDict > getDefault()
Definition MaskDict.cc:115
static void setDefault(std::shared_ptr< MaskDict > dict)
Definition MaskDict.cc:119
bool operator==(MaskDict const &rhs) const
Definition MaskDict.cc:187
const_iterator find(std::string const &name) const
Definition MaskDict.h:135
void add(std::string const &name, int bitId)
Definition MaskDict.cc:191
static std::shared_ptr< MaskDict > copyOrGetDefault(MaskPlaneDict const &dict)
Definition MaskDict.cc:111
bool empty() const noexcept
Definition MaskDict.h:141
void erase(std::string const &name)
Definition MaskDict.cc:196
T clear(T... args)
T empty(T... args)
T endl(T... args)
T erase(T... args)
T find_if(T... args)
T max_element(T... args)
T move(T... args)
std::map< std::string, int > MaskPlaneDict
Definition Mask.h:58
STL namespace.