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.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
48 FlagDefinitionList const& flagDefs, FlagDefinitionList const& exclDefs) {
50 r._vector.reserve(flagDefs.size());
51 for (std::size_t i = 0; i < flagDefs.size(); i++) {
52 FlagDefinition const& flagDef = flagDefs[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));
60 if (flagDef.name == FlagHandler::getFailureFlagName()) {
61 r.failureFlagNumber = i;
62 }
63 }
64 }
65 return r;
66}
67
69 FlagDefinitionList const& exclDefs)
70 : failureFlagNumber(FlagDefinition::number_undefined) {
71 _vector.reserve(flagDefs.size());
72 for (std::size_t i = 0; i < flagDefs.size(); i++) {
73 FlagDefinition const& flagDef = flagDefs[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]));
79 if (flagDef.name == FlagHandler::getFailureFlagName()) {
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
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
A class used as a handle to a particular field in a table.
Definition Key.h:53
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
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.
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 ...
bool hasDefinition(std::string const &name) const
See if there is a FlagDefinition with specified name.
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
T make_pair(T... args)
decltype(sizeof(void *)) size_t
Definition doctest.h:524
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