LSSTApplications  11.0-13-gbb96280,12.1+18,12.1+7,12.1-1-g14f38d3+72,12.1-1-g16c0db7+5,12.1-1-g5961e7a+84,12.1-1-ge22e12b+23,12.1-11-g06625e2+4,12.1-11-g0d7f63b+4,12.1-19-gd507bfc,12.1-2-g7dda0ab+38,12.1-2-gc0bc6ab+81,12.1-21-g6ffe579+2,12.1-21-gbdb6c2a+4,12.1-24-g941c398+5,12.1-3-g57f6835+7,12.1-3-gf0736f3,12.1-37-g3ddd237,12.1-4-gf46015e+5,12.1-5-g06c326c+20,12.1-5-g648ee80+3,12.1-5-gc2189d7+4,12.1-6-ga608fc0+1,12.1-7-g3349e2a+5,12.1-7-gfd75620+9,12.1-9-g577b946+5,12.1-9-gc4df26a+10
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 { namespace meas { namespace base {
27 
30  std::string const & prefix,
31  FlagDefinition const * begin,
32  FlagDefinition const * end
33 ) {
34  FlagHandler r;
35  r._vector.reserve(end - begin);
36  for (FlagDefinition const * iter = begin; iter != end; ++iter) {
37  r._vector.push_back(
38  std::make_pair(
39  *iter,
40  schema.addField<afw::table::Flag>(schema.join(prefix, iter->name), iter->doc)
41  )
42  );
43  }
44  return r;
45 }
46 
49  std::string const & prefix,
50  std::vector<FlagDefinition> const * flagDefs
51 ) {
52  FlagHandler r;
53  r._vector.reserve(flagDefs->size());
54  for (unsigned int i = 0; i < flagDefs->size(); i++) {
55  r._vector.push_back(
56  std::make_pair(
57  flagDefs->at(i),
58  schema.addField<afw::table::Flag>(schema.join(prefix, flagDefs->at(i).name), flagDefs->at(i).doc)
59  )
60  );
61  }
62  return r;
63 }
64 
66  afw::table::SubSchema const & s,
67  FlagDefinition const * begin,
68  FlagDefinition const * end
69 ) {
70  _vector.reserve(end - begin);
71  for (FlagDefinition const * iter = begin; iter != end; ++iter) {
73  _vector.push_back(std::make_pair(*iter, key));
74  }
75 }
76 
78  std::size_t const numFlags = _vector.size();
79  assert(numFlags > 0); // We need a general failure flag
80  record.set(_vector[0].second, true);
81  if (error) {
82  assert(numFlags > error->getFlagBit()); // We need the particular flag
83  record.set(_vector[error->getFlagBit()].second, true);
84  }
85 }
86 
87 
88 }}} // lsst::meas::base
int iter
Defines the fields and offsets for a table.
Definition: Schema.h:44
A proxy type for name lookups in a Schema.
Definition: Schema.h:340
afw::table::Schema schema
Definition: GaussianPsf.cc:41
Simple POD struct used to define and document flags.
Definition: FlagHandler.h:41
std::string join(std::string const &a, std::string const &b) const
Join strings using the field delimiter appropriate for this Schema.
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:145
def error
Definition: log.py:103
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:73
FlagHandler()
Default constructor for delayed initialization.
Definition: FlagHandler.h:105
Base class for all records.
Definition: BaseRecord.h:27
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=NULL) const
Handle an expected or unexpected Exception thrown by a measurement algorithm.
Definition: FlagHandler.cc:77
Key< T > addField(Field< T > const &field, bool doReplace=false)
Add a new field to the Schema, and return the associated Key.
std::size_t getFlagBit() const
Return the flag bit associated with the error.
Definition: exceptions.h:64
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinition const *begin, FlagDefinition const *end)
Add Flag fields to a schema, creating a FlagHandler object to manage them.
Definition: FlagHandler.cc:28