LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
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 
28 #include "lsst/afw/table/Schema.h"
31 
32 namespace lsst {
33 namespace meas {
34 namespace base {
41  static constexpr std::size_t number_undefined = SIZE_MAX;
42 
43  FlagDefinition() : name(), doc(), number() {}
44 
46  : name(name), doc(doc), number(number) {}
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 
61 public:
66 
71  for (FlagDefinition const* iter = list.begin(); iter < list.end(); iter++) {
72  add(iter->name, iter->doc);
73  }
74  }
75 
76  static FlagDefinitionList const& getEmptyList() {
77  static FlagDefinitionList list;
78  return list;
79  }
83  FlagDefinition getDefinition(std::size_t index) const { return _vector[index]; }
88  for (std::size_t i = 0; i < size(); i++) {
89  if (_vector[i].name == name) return _vector[i];
90  }
91  throw FatalAlgorithmError("No Flag Definition for " + name);
92  }
96  FlagDefinition operator[](std::size_t index) const { return getDefinition(index); }
100  bool hasDefinition(std::string const& name) const {
101  for (std::size_t i = 0; i < size(); i++) {
102  if (_vector[i].name == name) return true;
103  }
104  return false;
105  }
110  FlagDefinition addFailureFlag(std::string const& doc = "General Failure Flag");
111 
117  FlagDefinition flagDef = FlagDefinition(name, doc, _vector.size());
118  _vector.push_back(flagDef);
119  return _vector.back();
120  }
125  std::size_t size() const { return _vector.size(); }
126 
127 private:
128  mutable std::vector<FlagDefinition> _vector;
129 };
130 
148 class FlagHandler {
149 public:
176  FlagHandler() : failureFlagNumber(FlagDefinition::number_undefined) {}
177 
181  static std::string const& getFailureFlagName() {
182  static std::string name = "flag";
183  return name;
184  }
202  FlagDefinitionList const& flagDefs,
217  FlagHandler(afw::table::SubSchema const& s, FlagDefinitionList const& flagDefs,
222  unsigned int getFlagNumber(std::string const& flagName) const {
223  for (unsigned int i = 0; i < _vector.size(); i++) {
224  if (_vector[i].first == flagName && _vector[i].second.isValid()) {
225  return i;
226  }
227  }
228  throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
229  }
234  if (i < _vector.size() && _vector[i].second.isValid()) {
235  return _vector[i].first;
236  }
237  throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
238  }
242  bool getValue(afw::table::BaseRecord const& record, std::size_t i) const {
243  if (i < _vector.size() && _vector[i].second.isValid()) {
244  return record.get(_vector[i].second);
245  }
246  throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
247  }
251  bool getValue(afw::table::BaseRecord const& record, std::string const& flagName) const {
252  for (std::size_t i = 0; i < _vector.size(); i++) {
253  if (_vector[i].first == flagName && _vector[i].second.isValid()) {
254  return record.get(_vector[i].second);
255  }
256  }
257  throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
258  }
262  void setValue(afw::table::BaseRecord& record, std::size_t i, bool value) const {
263  if (i < _vector.size() && _vector[i].second.isValid()) {
264  record.set(_vector[i].second, value);
265  return;
266  }
267  throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
268  }
272  void setValue(afw::table::BaseRecord& record, std::string const& flagName, bool value) const {
273  for (std::size_t i = 0; i < _vector.size(); i++) {
274  if (_vector[i].first == flagName && _vector[i].second.isValid()) {
275  record.set(_vector[i].second, value);
276  return;
277  }
278  }
279  throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
280  }
295  void handleFailure(afw::table::BaseRecord& record, MeasurementError const* error = nullptr) const;
296 
298 
299 private:
301  Vector _vector;
302 };
303 
304 } // namespace base
305 } // namespace meas
306 } // namespace lsst
307 
308 #endif // !LSST_MEAS_BASE_FlagHandler_h_INCLUDED
table::Key< std::string > name
Definition: Amplifier.cc:116
std::string prefix
Definition: SchemaMapper.cc:72
table::Schema schema
Definition: python.h:134
Base class for all records.
Definition: BaseRecord.h:31
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:164
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition: BaseRecord.h:151
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.
Definition: FlagHandler.h:116
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.
Definition: FlagHandler.h:83
FlagDefinition getDefinition(std::string const &name) const
get a reference to the FlagDefinition with specified name.
Definition: FlagHandler.h:87
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:125
static FlagDefinitionList const & getEmptyList()
Definition: FlagHandler.h:76
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 ...
Definition: FlagHandler.cc:33
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:96
bool hasDefinition(std::string const &name) const
See if there is a FlagDefinition with specified name.
Definition: FlagHandler.h:100
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
std::string getFlagName(std::size_t i) const
Return the value of the flag name corresponding to the given flag index.
Definition: FlagHandler.h:233
bool getValue(afw::table::BaseRecord const &record, std::string const &flagName) const
Return the value of the flag field with the given flag name.
Definition: FlagHandler.h:251
std::size_t getFailureFlagNumber() const
Get the index of the General Failure flag, if one is defined.
Definition: FlagHandler.h:286
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=nullptr) const
Handle an expected or unexpected Exception thrown by a measurement algorithm.
Definition: FlagHandler.cc:76
FlagHandler()
Each error should have a corresponding static FlagDefinition object.
Definition: FlagHandler.h:176
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.
Definition: FlagHandler.cc:37
void setValue(afw::table::BaseRecord &record, std::string const &flagName, bool value) const
Set the flag field corresponding to the given flag name.
Definition: FlagHandler.h:272
unsigned int getFlagNumber(std::string const &flagName) const
Return the index of a flag with the given flag name.
Definition: FlagHandler.h:222
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
Definition: FlagHandler.h:181
void setValue(afw::table::BaseRecord &record, std::size_t i, bool value) const
Set the flag field corresponding to the given flag index.
Definition: FlagHandler.h:262
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.
Definition: FlagHandler.h:242
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
daf::base::PropertyList * list
Definition: fits.cc:913
A base class for image defects.
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)