LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
MaskDict.h
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#ifndef LSST_AFW_IMAGE_DETAIL_MASKDICT_H
23#define LSST_AFW_IMAGE_DETAIL_MASKDICT_H
24
25#include <memory>
26#include <map>
27#include "lsst/afw/image/Mask.h"
28
29namespace lsst { namespace afw { namespace image { namespace detail {
30
31/*
32 * MaskDict is the internal object that relates Mask's string plane names
33 * to bit IDs.
34 *
35 * The Mask public API only uses MaskPlaneDict, which is just a typedef
36 * to std::map. A MaskDict holds this MaskPlaneDict, limiting non-const
37 * access to just the add() and erase() methods in order to maintain
38 * a hash of the full dictionary for fast comparison between MaskDicts.
39 *
40 * In order to maximize consistency of mask plane definitions across different
41 * Mask instances, MaskDict also maintains a global list of all active
42 * MaskDict instances. When a plane is added to Mask, it is typically
43 * automatically added to *all* active Mask instances that do not already use
44 * that bit (via MaskDict::addMaskPlane) as well as a default MaskDict that is
45 * used when constructing future Mask instances. In contrast, when a plane is
46 * removed, it typically only affects that Mask, and if that Mask is currently
47 * using the default MaskDict, the default is redefined to a copy prior to
48 * the plane's removal (via detachDefault).
49 *
50 * To maintain that global state, all MaskDicts must be held by shared_ptr,
51 * and hence MaskDict's constructors are private, and static or instance
52 * methods that return shared_ptr are provided to replace them.
53 *
54 * MaskDict is an implementation detail (albeit and important one) and hence
55 * its "documentation" is intentionally in the form of regular comments
56 * rather than Doxygen-parsed blocks. It is also not available from Python.
57 *
58 * With the exception of addMaskPlane, all MaskDict methods provide strong
59 * exception safety.
60 */
61class MaskDict final {
62public:
63
64 using value_type = MaskPlaneDict::value_type;
65 using const_iterator = MaskPlaneDict::const_iterator;
66
67 // Return a new MaskDict with the same plane definitions as the given
68 // MaskPlaneDict, or return the default mask dict if it is empty.
70
71 // Return the default MaskDict to be used for new Mask instances.
73
74 // Set the default MaskDict.
75 static void setDefault(std::shared_ptr<MaskDict> dict);
76
77 /*
78 * Set the default MaskDict to a copy of the current one, returning the
79 * new default.
80 */
82
83 /*
84 * Add the given mask plane to all active MaskDicts for which there is
85 * no conflict, including the default MaskDict.
86 *
87 * MaskDicts that already have a plane with the same name or bit ID
88 * are not affected.
89 *
90 * Provides basic exception safety: mask planes may be added to some
91 * MaskDict instances even if an exception is raised while adding
92 * the mask plane to later ones (though the only exception that could
93 * be thrown in practice is std::bad_alloc).
94 */
95 static void addAllMasksPlane(std::string const & name, int bitId);
96
97 // Assignment is disabled; we don't need it.
98 MaskDict & operator=(MaskDict const &) = delete;
99 MaskDict & operator=(MaskDict &&) = delete;
100
101 ~MaskDict() noexcept;
102
103 // Return a deep copy of the MaskDict.
104 std::shared_ptr<MaskDict> clone() const;
105
106 /*
107 * Return an integer bit ID that is not currently used in this MaskDict.
108 *
109 * Always succeeds in returning a new plane (except in the extraordinarily
110 * unlikely case that int overflows), but is is the responsibility of the
111 * caller to check that the Mask pixel size has enough bits for it.
112 */
113 int getUnusedPlane() const;
114
115 /*
116 * Return the bit ID associated with the given mask plane name.
117 *
118 * Returns -1 if no such plane is found.
119 */
120 int getMaskPlane(std::string const & name) const;
121
122 // Write a description of the MaskDict to stdout.
123 void print() const;
124
125 // Fast comparison of MaskDicts, using the hash (and assuming there are
126 // no unlucky collisions).
127 bool operator==(MaskDict const& rhs) const;
128 bool operator!=(MaskDict const& rhs) const { return !(*this == rhs); }
129
130 // Iterators over MaskDict items (yields std::pair<std::string, int>).
131 const_iterator begin() const noexcept { return _dict.begin(); }
132 const_iterator end() const noexcept { return _dict.end(); }
133
134 // Return an iterator to the item with the given name, or end().
135 const_iterator find(std::string const & name) const { return _dict.find(name); }
136
137 // Return the number of planes in this MaskDict.
138 std::size_t size() const noexcept { return _dict.size(); }
139
140 // Return true if the MaskDict contains no mask planes.
141 bool empty() const noexcept { return _dict.empty(); }
142
143 // Return the internal MaskPlaneDict.
144 MaskPlaneDict const & getMaskPlaneDict() const noexcept { return _dict; }
145
146 // Add a mask plane to just this MaskDict.
147 // If a plane with the given name already exists, it is overridden.
148 // Caller is responsible for ensuring that the bit is not in use; if it is,
149 // the MaskDict will be in a corrupted state.
150 void add(std::string const & name, int bitId);
151
152 // Remove the plane with the given name from just this MaskDict.
153 // Does nothing if no such plane exists.
154 void erase(std::string const & name);
155
156 // Remove all planes from this MaskDict.
157 void clear();
158
159private:
160
161 class GlobalState;
162
163 // Add mask planes that should be present on all Masks that don't
164 // explicitly remove them. Called exactly once, when initalizing
165 // GlobalState.
166 void _addInitialMaskPlanes();
167
168 // ALL MaskDict constructors should only be from GlobalState,
169 // in order to ensure the global set of active dictionaries
170 // is kept up-to-date.
171
172 MaskDict();
173
174 explicit MaskDict(MaskPlaneDict const & dict);
175
176 MaskDict(MaskDict const &) = default;
177 MaskDict(MaskDict &&) = default;
178
179 MaskPlaneDict _dict;
180 std::size_t _hash;
181};
182
183}}}} // namespace lsst::afw::image::detail
184
185#endif // !LSST_AFW_IMAGE_DETAIL_MASKDICT_H
int getMaskPlane(std::string const &name) const
Definition MaskDict.cc:157
const_iterator begin() const noexcept
Definition MaskDict.h:131
MaskPlaneDict::const_iterator const_iterator
Definition MaskDict.h:65
static void addAllMasksPlane(std::string const &name, int bitId)
Definition MaskDict.cc:118
static std::shared_ptr< MaskDict > detachDefault()
Definition MaskDict.cc:116
const_iterator end() const noexcept
Definition MaskDict.h:132
std::size_t size() const noexcept
Definition MaskDict.h:138
MaskDict & operator=(MaskDict &&)=delete
static std::shared_ptr< MaskDict > getDefault()
Definition MaskDict.cc:112
std::shared_ptr< MaskDict > clone() const
Definition MaskDict.cc:133
static void setDefault(std::shared_ptr< MaskDict > dict)
Definition MaskDict.cc:114
const_iterator find(std::string const &name) const
Definition MaskDict.h:135
MaskPlaneDict const & getMaskPlaneDict() const noexcept
Definition MaskDict.h:144
void add(std::string const &name, int bitId)
Definition MaskDict.cc:172
MaskDict & operator=(MaskDict const &)=delete
static std::shared_ptr< MaskDict > copyOrGetDefault(MaskPlaneDict const &dict)
Definition MaskDict.cc:108
bool empty() const noexcept
Definition MaskDict.h:141
void erase(std::string const &name)
Definition MaskDict.cc:177
MaskPlaneDict::value_type value_type
Definition MaskDict.h:64
std::map< std::string, int > MaskPlaneDict
Definition Mask.h:58
STL namespace.