lsst.meas.base gfc624380f7+a13aefd6d2
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
37namespace lsst {
38namespace meas {
39namespace base {
40
45public:
46 LSST_CONTROL_FIELD(masksFpCenter, std::vector<std::string>,
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.");
49 LSST_CONTROL_FIELD(masksFpAnywhere, std::vector<std::string>,
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
65public:
69
70 PixelFlagsAlgorithm(Control const& ctrl, std::string const& name, afw::table::Schema& schema);
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
79private:
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
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