Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04dff08e69+fafbcb10e2,g0d33ba9806+e09a96fa4e,g0fba68d861+cc01b48236,g1e78f5e6d3+fb95f9dda6,g1ec0fe41b4+f536777771,g1fd858c14a+ae46bc2a71,g35bb328faa+fcb1d3bbc8,g4af146b050+dd94f3aad7,g4d2262a081+7ee6f976aa,g53246c7159+fcb1d3bbc8,g5a012ec0e7+b20b785ecb,g60b5630c4e+e09a96fa4e,g6273192d42+bf8cfc5e62,g67b6fd64d1+4086c0989b,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g87b7deb4dc+831c06c8fc,g8852436030+54b48a5987,g89139ef638+4086c0989b,g9125e01d80+fcb1d3bbc8,g94187f82dc+e09a96fa4e,g989de1cb63+4086c0989b,g9f33ca652e+64be6d9d51,g9f7030ddb1+d11454dffd,ga2b97cdc51+e09a96fa4e,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+23605820ec,gb58c049af0+f03b321e39,gb89ab40317+4086c0989b,gcf25f946ba+54b48a5987,gd6cbbdb0b4+af3c3595f5,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+15f2daff9d,ge278dab8ac+d65b3c2b70,ge410e46f29+4086c0989b,gf67bdafdda+4086c0989b,v29.0.0.rc5
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
FlagHandler.h
Go to the documentation of this file.
1/*// -*- lsst-c++ -*-
2 * LSST Data Management System
3 * Copyright 2008-2014 LSST Corporation.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <http://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#ifndef LSST_MEAS_BASE_FlagHandler_h_INCLUDED
24#define LSST_MEAS_BASE_FlagHandler_h_INCLUDED
25
26#include <vector>
27
31
32namespace lsst {
33namespace meas {
34namespace base {
41 static constexpr std::size_t number_undefined = SIZE_MAX;
42
44
47
48 // equality of this type is based solely on the name attribute
49 bool operator==(FlagDefinition const& other) const { return (other.name == name); }
50 bool operator!=(FlagDefinition const& other) const { return (other.name != name); }
51
55};
56
61public:
66
71 for (FlagDefinition const* iter = list.begin(); iter < list.end(); iter++) {
72 add(iter->name, iter->doc);
73 }
74 }
75
77 static FlagDefinitionList list;
78 return list;
79 }
80
89 for (std::size_t i = 0; i < size(); i++) {
90 if (_vector[i].name == name) return _vector[i];
91 }
92 throw FatalAlgorithmError("No Flag Definition for " + name);
93 }
94
97 FlagDefinition operator[](std::size_t index) const { return getDefinition(index); }
101 bool hasDefinition(std::string const& name) const {
102 for (std::size_t i = 0; i < size(); i++) {
103 if (_vector[i].name == name) return true;
104 }
105 return false;
106 }
107
111 FlagDefinition addFailureFlag(std::string const& doc = "General Failure Flag");
112
117 FlagDefinition add(std::string const& name, std::string const& doc) {
118 FlagDefinition flagDef = FlagDefinition(name, doc, _vector.size());
119 _vector.push_back(flagDef);
120 return _vector.back();
121 }
122
125
126 std::size_t size() const { return _vector.size(); }
127
128private:
129 mutable std::vector<FlagDefinition> _vector;
130};
131
150public:
166
178
183 static std::string name = "flag";
184 return name;
185 }
186
202 static FlagHandler addFields(afw::table::Schema& schema, std::string const& prefix,
203 FlagDefinitionList const& flagDefs,
218 FlagHandler(afw::table::SubSchema const& s, FlagDefinitionList const& flagDefs,
223 unsigned int getFlagNumber(std::string const& flagName) const {
224 for (unsigned int i = 0; i < _vector.size(); i++) {
225 if (_vector[i].first == flagName && _vector[i].second.isValid()) {
226 return i;
227 }
228 }
229 throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
230 }
231
235 if (i < _vector.size() && _vector[i].second.isValid()) {
236 return _vector[i].first;
237 }
238 throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
239 }
240
243 bool getValue(afw::table::BaseRecord const& record, std::size_t i) const {
244 if (i < _vector.size() && _vector[i].second.isValid()) {
245 return record.get(_vector[i].second);
246 }
247 throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
248 }
249
252 bool getValue(afw::table::BaseRecord const& record, std::string const& flagName) const {
253 for (std::size_t i = 0; i < _vector.size(); i++) {
254 if (_vector[i].first == flagName && _vector[i].second.isValid()) {
255 return record.get(_vector[i].second);
256 }
257 }
258 throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
259 }
260
263 void setValue(afw::table::BaseRecord& record, std::size_t i, bool value) const {
264 if (i < _vector.size() && _vector[i].second.isValid()) {
265 record.set(_vector[i].second, value);
266 return;
267 }
268 throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
269 }
270
273 void setValue(afw::table::BaseRecord& record, std::string const& flagName, bool value) const {
274 for (std::size_t i = 0; i < _vector.size(); i++) {
275 if (_vector[i].first == flagName && _vector[i].second.isValid()) {
276 record.set(_vector[i].second, value);
277 return;
278 }
279 }
280 throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
281 }
282
296 void handleFailure(afw::table::BaseRecord& record, MeasurementError const* error = nullptr) const;
297
299
300private:
302 Vector _vector;
303};
304
305} // namespace base
306} // namespace meas
307} // namespace lsst
308
309#endif // !LSST_MEAS_BASE_FlagHandler_h_INCLUDED
Base class for all records.
Definition BaseRecord.h:31
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition BaseRecord.h:151
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition BaseRecord.h:164
Defines the fields and offsets for a table.
Definition Schema.h:51
A proxy type for name lookups in a Schema.
Definition Schema.h:367
Exception to be thrown when a measurement algorithm experiences a fatal error.
Definition exceptions.h:76
vector-type utility class to build a collection of FlagDefinitions
Definition FlagHandler.h:60
FlagDefinition add(std::string const &name, std::string const &doc)
Add a new FlagDefinition to this list.
FlagDefinitionList()
initialize a FlagDefinition list with no entries.
Definition FlagHandler.h:65
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
FlagDefinition getDefinition(std::string const &name) const
get a reference to the FlagDefinition with specified name.
Definition FlagHandler.h:88
static FlagDefinitionList const & getEmptyList()
Definition FlagHandler.h:76
std::size_t size() const
return the current size (number of defined elements) of the collection
FlagDefinition addFailureFlag(std::string const &doc="General Failure Flag")
Add a Flag Defintion to act as a "General" failure flag This flag will be set if a Measurement error ...
FlagDefinitionList(std::initializer_list< FlagDefinition > const &list)
initialize a FlagDefinition list from initializer_list.
Definition FlagHandler.h:70
FlagDefinition operator[](std::size_t index) const
get a reference to the FlagDefinition with specified array index
Definition FlagHandler.h:97
bool hasDefinition(std::string const &name) const
See if there is a FlagDefinition with specified name.
Utility class for handling flag fields that indicate the failure modes of an algorithm.
std::string getFlagName(std::size_t i) const
Return the value of the flag name corresponding to the given flag index.
bool getValue(afw::table::BaseRecord const &record, std::string const &flagName) const
Return the value of the flag field with the given flag name.
std::size_t getFailureFlagNumber() const
Get the index of the General Failure flag, if one is defined.
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=nullptr) const
Handle an expected or unexpected Exception thrown by a measurement algorithm.
FlagHandler()
Each error should have a corresponding static FlagDefinition object.
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
Add Flag fields to a schema, creating a FlagHandler object to manage them.
void setValue(afw::table::BaseRecord &record, std::string const &flagName, bool value) const
Set the flag field corresponding to the given flag name.
unsigned int getFlagNumber(std::string const &flagName) const
Return the index of a flag with the given flag name.
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
void setValue(afw::table::BaseRecord &record, std::size_t i, bool value) const
Set the flag field corresponding to the given flag index.
bool getValue(afw::table::BaseRecord const &record, std::size_t i) const
Return the value of the flag field corresponding to the given flag index.
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition exceptions.h:48
T size(T... args)
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition FlagHandler.h:40
bool operator!=(FlagDefinition const &other) const
Definition FlagHandler.h:50
static constexpr std::size_t number_undefined
Definition FlagHandler.h:41
FlagDefinition(std::string const &name, std::string const &doc, std::size_t number=number_undefined)
Definition FlagHandler.h:45
bool operator==(FlagDefinition const &other) const
Definition FlagHandler.h:49
T to_string(T... args)