PixelFlags.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2013 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_MEAS_BASE_PixelFlags_h_INCLUDED
#define LSST_MEAS_BASE_PixelFlags_h_INCLUDED

#include <vector>
 
#include "lsst/pex/config.h"
#include "lsst/afw/image/Exposure.h"
#include "lsst/meas/base/Algorithm.h"
 
namespace lsst {
namespace meas {
namespace base {

class PixelFlagsControl {
public:
    LSST_CONTROL_FIELD(masksFpCenter, std::vector<std::string>,
                       "List of mask planes to be searched for which occur in the center of a footprint. "
                       "If any of the planes are found they will have a corresponding pixel flag set.");
    LSST_CONTROL_FIELD(masksFpAnywhere, std::vector<std::string>,
                       "List of mask planes to be searched for which occur anywhere within a footprint. "
                       "If any of the planes are found they will have a corresponding pixel flag set.");
    PixelFlagsControl() : masksFpCenter(), masksFpAnywhere() {}
};

class PixelFlagsAlgorithm : public SimpleAlgorithm {
public:
    typedef PixelFlagsControl Control;
 
    PixelFlagsAlgorithm(Control const& ctrl, std::string const& name, afw::table::Schema& schema);
 
    virtual void measure(afw::table::SourceRecord& measRecord,
                         afw::image::Exposure<float> const& exposure) const;
 
    virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const;
 
    typedef std::map<std::string, afw::table::Key<afw::table::Flag>> KeyMap;
 
private:
    Control _ctrl;
    // Maps of mask plane name->afw table Key for the various fields we add to the schema on construction.
    KeyMap _centerKeys;     // Keys for bits set anywhere within the 3x3 region around the centroid.
    KeyMap _centerAllKeys;  // Keys for bits set on the entire 3x3 region around the centroid.
    KeyMap _anyKeys;        // Keys for bits set anywhere in the footprint.
    afw::table::Key<afw::table::Flag> _generalFailureKey;
    afw::table::Key<afw::table::Flag> _offImageKey;
};
 
}  // namespace base
}  // namespace meas
}  // namespace lsst
 
#endif  // !LSST_MEAS_BASE_PixelFlags_h_INCLUDED