lsst.meas.base gdd7ff8183c+2e6d5f40bc
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
35}
36
38 FlagDefinitionList const& flagDefs, FlagDefinitionList const& exclDefs) {
40 r._vector.reserve(flagDefs.size());
41 for (std::size_t i = 0; i < flagDefs.size(); i++) {
42 FlagDefinition const& flagDef = flagDefs[i];
43 if (exclDefs.hasDefinition(flagDef.name)) {
45 r._vector.push_back(std::make_pair(flagDef.name, key));
46 } else {
48 schema.addField<afw::table::Flag>(schema.join(prefix, flagDef.name), flagDef.doc));
49 r._vector.push_back(std::make_pair(flagDef.name, key));
50 if (flagDef.name == FlagHandler::getFailureFlagName()) {
52 }
53 }
54 }
55 return r;
56}
57
59 FlagDefinitionList const& exclDefs)
60 : failureFlagNumber(FlagDefinition::number_undefined) {
61 _vector.reserve(flagDefs.size());
62 for (std::size_t i = 0; i < flagDefs.size(); i++) {
63 FlagDefinition const& flagDef = flagDefs[i];
64 if (exclDefs.hasDefinition(flagDef.name)) {
66 _vector.push_back(std::make_pair(flagDef.name, key));
67 } else {
68 _vector.push_back(std::make_pair(flagDef.name, s[flagDef.name]));
69 if (flagDef.name == FlagHandler::getFailureFlagName()) {
71 }
72 }
73 }
74}
75
77 std::size_t const numFlags = _vector.size();
79 record.set(_vector[failureFlagNumber].second, true);
80 }
81 if (error && error->getFlagBit() != FlagDefinition::number_undefined) {
82 assert(numFlags > error->getFlagBit()); // We need the particular flag
83 record.set(_vector[error->getFlagBit()].second, true);
84 }
85}
86
87} // namespace base
88} // namespace meas
89} // namespace lsst
std::string prefix
void set(Key< T > const &key, U const &value)
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
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:125
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
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
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
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
Definition: FlagHandler.h:181
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)
second
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
table::Schema schema