lsst.meas.base  14.0-12-g233aa8e+9
PixelFlags.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2013 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 
24 #ifndef LSST_MEAS_BASE_PixelFlags_h_INCLUDED
25 #define LSST_MEAS_BASE_PixelFlags_h_INCLUDED
26 
31 #include <vector>
32 
33 #include "lsst/pex/config.h"
36 
37 namespace lsst { namespace meas { namespace base {
38 
43 public:
45  "List of mask planes to be searched for which occur in the center of a footprint. "
46  "If any of the planes are found they will have a corresponding pixel flag set.");
48  "List of mask planes to be searched for which occur anywhere within a footprint. "
49  "If any of the planes are found they will have a corresponding pixel flag set.");
56 };
57 
58 
64 public:
68 
69  PixelFlagsAlgorithm(Control const & ctrl, std::string const & name, afw::table::Schema & schema);
70 
71  virtual void measure(
72  afw::table::SourceRecord & measRecord,
73  afw::image::Exposure<float> const & exposure
74  ) const;
75 
76  virtual void fail(
77  afw::table::SourceRecord & measRecord,
78  MeasurementError * error = nullptr
79  ) const;
80 
82 
83 private:
84  Control _ctrl;
85  KeyMap _centerKeys;
86  KeyMap _anyKeys;
87  afw::table::Key<afw::table::Flag> _generalFailureKey;
89 };
90 
91 }}} // namespace lsst::meas::base
92 
93 #endif // !LSST_MEAS_BASE_PixelFlags_h_INCLUDED
std::map< std::string, afw::table::Key< afw::table::Flag > > KeyMap
Definition: PixelFlags.h:81
PixelFlagsControl()
Default constructor.
Definition: PixelFlags.h:55
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
STL class.
STL class.
A measurement algorithm that gets mask bits from the exposure and sets flag bits to summarize which b...
Definition: PixelFlags.h:63
A C++ control class to handle PixelFlagsAlgorithm&#39;s configuration.
Definition: PixelFlags.h:42
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:184
std::vector< std::string > masksFpCenter
"List of mask planes to be searched for which occur in the center of a footprint. " "If any of the pl...
Definition: PixelFlags.h:46
std::vector< std::string > masksFpAnywhere
"List of mask planes to be searched for which occur anywhere within a footprint. " "If any of the pla...
Definition: PixelFlags.h:49
PixelFlagsControl Control
A typedef to the Control object for this algorithm, defined above.
Definition: PixelFlags.h:67