lsst.meas.base g876c692160+64504fc8ff
Loading...
Searching...
No Matches
FlagHandler.cc
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2014 LSST Corporation.
5 *
6 * This product includes software developed by the
7 * LSST Project (http://www.lsst.org/).
8 *
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the LSST License Statement and
20 * the GNU General Public License along with this program. If not,
21 * see <http://www.lsstcorp.org/LegalNotices/>.
22 */
23
25
26namespace lsst {
27namespace meas {
28namespace base {
29
30// so pybind11 can get the address of number_undefined
32
34 if (index >= _vector.size()) {
35 throw std::out_of_range((boost::format("Cannot access index %d of length=%d flag definition list.") %
36 index % _vector.size())
37 .str());
38 } else {
39 return _vector[index];
40 }
41}
42
46
50 r._vector.reserve(flagDefs.size());
51 for (std::size_t i = 0; i < flagDefs.size(); i++) {
53 if (exclDefs.hasDefinition(flagDef.name)) {
55 r._vector.push_back(std::make_pair(flagDef.name, key));
56 } else {
58 schema.addField<afw::table::Flag>(schema.join(prefix, flagDef.name), flagDef.doc));
59 r._vector.push_back(std::make_pair(flagDef.name, key));
61 r.failureFlagNumber = i;
62 }
63 }
64 }
65 return r;
66}
67
70 : failureFlagNumber(FlagDefinition::number_undefined) {
71 _vector.reserve(flagDefs.size());
72 for (std::size_t i = 0; i < flagDefs.size(); i++) {
74 if (exclDefs.hasDefinition(flagDef.name)) {
76 _vector.push_back(std::make_pair(flagDef.name, key));
77 } else {
78 _vector.push_back(std::make_pair(flagDef.name, s[flagDef.name]));
81 }
82 }
83 }
84}
85
87 std::size_t const numFlags = _vector.size();
89 record.set(_vector[failureFlagNumber].second, true);
90 }
91 if (error && error->getFlagBit() != FlagDefinition::number_undefined) {
92 assert(numFlags > error->getFlagBit()); // We need the particular flag
93 record.set(_vector[error->getFlagBit()].second, true);
94 }
95}
96
97} // namespace base
98} // namespace meas
99} // namespace lsst
std::string prefix
void set(Key< T > const &key, U const &value)
EigenVector _vector
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.
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
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 ...
Utility class for handling flag fields that indicate the failure modes of an algorithm.
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.
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition exceptions.h:48
std::size_t getFlagBit() const
Return the flag bit associated with the error.
Definition exceptions.h:59
T make_pair(T... args)
T push_back(T... args)
T reserve(T... args)
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
static constexpr std::size_t number_undefined
Definition FlagHandler.h:41