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
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)