LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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 
26 namespace lsst {
27 namespace meas {
28 namespace base {
29 
30 // so pybind11 can get the address of number_undefined
32 
34  return add(FlagHandler::getFailureFlagName(), doc);
35 }
36 
38  FlagDefinitionList const& flagDefs, FlagDefinitionList const& exclDefs) {
39  FlagHandler r;
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()) {
51  r.failureFlagNumber = i;
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
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::FlagDefinitionList::addFailureFlag
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
std::string
STL class.
lsst::afw::table._match.second
second
Definition: _match.py:78
lsst::log.log.logContinued.error
def error(fmt, *args)
Definition: logContinued.py:210
lsst::meas::base::FlagHandler::handleFailure
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
lsst::meas::base::FlagHandler::FlagHandler
FlagHandler()
Each error should have a corresponding static FlagDefinition object.
Definition: FlagHandler.h:176
base
Definition: __init__.py:1
std::vector::reserve
T reserve(T... args)
std::vector::size
T size(T... args)
lsst::meas::base::FlagDefinition::doc
std::string doc
Definition: FlagHandler.h:53
lsst::meas::base::MeasurementError
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
lsst::meas::base::FlagDefinitionList::hasDefinition
bool hasDefinition(std::string const &name) const
See if there is a FlagDefinition with specified name.
Definition: FlagHandler.h:100
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::meas::base::FlagDefinitionList::add
FlagDefinition add(std::string const &name, std::string const &doc)
Add a new FlagDefinition to this list.
Definition: FlagHandler.h:116
lsst::meas::base::FlagDefinition::name
std::string name
Definition: FlagHandler.h:52
lsst::meas::base::FlagDefinitionList
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
std::vector::push_back
T push_back(T... args)
lsst::meas::base::FlagHandler::getFailureFlagName
static std::string const & getFailureFlagName()
Define the universal name of the general failure flag.
Definition: FlagHandler.h:181
lsst::meas::base::FlagDefinition::number_undefined
static constexpr std::size_t number_undefined
Definition: FlagHandler.h:41
lsst::meas::base::FlagHandler
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
lsst::afw::table::BaseRecord
Base class for all records.
Definition: BaseRecord.h:31
lsst::afw::table::Key< afw::table::Flag >
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::FlagDefinitionList::size
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:125
lsst::meas::base::FlagDefinition
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40
FlagHandler.h
lsst::afw::table::SubSchema
A proxy type for name lookups in a Schema.
Definition: Schema.h:357
key
Key< U > key
Definition: Schema.cc:281
std::size_t
std::make_pair
T make_pair(T... args)
lsst::afw::table::BaseRecord::set
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:164
prefix
std::string prefix
Definition: SchemaMapper.cc:79
lsst::meas::base::FlagHandler::addFields
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
lsst::meas::base::FlagHandler::failureFlagNumber
std::size_t failureFlagNumber
Definition: FlagHandler.h:297