LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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 {
38 namespace meas {
39 namespace base {
40 
45 public:
47  "List of mask planes to be searched for which occur in the center of a footprint. "
48  "If any of the planes are found they will have a corresponding pixel flag set.");
50  "List of mask planes to be searched for which occur anywhere within a footprint. "
51  "If any of the planes are found they will have a corresponding pixel flag set.");
58 };
59 
65 public:
69 
71 
72  virtual void measure(afw::table::SourceRecord& measRecord,
73  afw::image::Exposure<float> const& exposure) const;
74 
75  virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const;
76 
78 
79 private:
80  Control _ctrl;
81  KeyMap _centerKeys;
82  KeyMap _anyKeys;
83  afw::table::Key<afw::table::Flag> _generalFailureKey;
85 };
86 
87 } // namespace base
88 } // namespace meas
89 } // namespace lsst
90 
91 #endif // !LSST_MEAS_BASE_PixelFlags_h_INCLUDED
table::Key< std::string > name
Definition: Amplifier.cc:116
table::Schema schema
Definition: python.h:134
Defines the fields and offsets for a table.
Definition: Schema.h:51
Record class that contains measurements made on a single exposure.
Definition: Source.h:78
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
A measurement algorithm that gets mask bits from the exposure and sets flag bits to summarize which b...
Definition: PixelFlags.h:64
std::map< std::string, afw::table::Key< afw::table::Flag > > KeyMap
Definition: PixelFlags.h:77
virtual void fail(afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
Definition: PixelFlags.cc:199
PixelFlagsControl Control
A typedef to the Control object for this algorithm, defined above.
Definition: PixelFlags.h:68
PixelFlagsAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
Definition: PixelFlags.cc:76
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
Definition: PixelFlags.cc:123
A C++ control class to handle PixelFlagsAlgorithm's configuration.
Definition: PixelFlags.h:44
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:51
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:48
PixelFlagsControl()
Default constructor.
Definition: PixelFlags.h:57
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
A base class for image defects.