FootprintMerge.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014 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_AFW_DETECTION_FOOTPRINTMERGE_H
#define LSST_AFW_DETECTION_FOOTPRINTMERGE_H

#include <vector>
#include <map>

#include "lsst/afw/table/Source.h"

namespace lsst {
namespace afw {
namespace detection {

class FootprintMerge;

class FootprintMergeList final {
public:
    FootprintMergeList(afw::table::Schema &sourceSchema, std::vector<std::string> const &filterList,
                       afw::table::Schema const &initialPeakSchema);

    FootprintMergeList(afw::table::Schema &sourceSchema, std::vector<std::string> const &filterList);

    ~FootprintMergeList();
    FootprintMergeList(FootprintMergeList const &);
    FootprintMergeList(FootprintMergeList &&);
    FootprintMergeList &operator=(FootprintMergeList const &);
    FootprintMergeList &operator=(FootprintMergeList &&);

    afw::table::Schema getPeakSchema() const { return _peakTable->getSchema(); }

    void addCatalog(std::shared_ptr<afw::table::SourceTable> sourceTable,
                    afw::table::SourceCatalog const &inputCat, std::string const &filter,
                    float minNewPeakDist = -1., bool doMerge = true, float maxSamePeakDist = -1.);

    void clearCatalog() { _mergeList.clear(); }

    void getFinalSources(afw::table::SourceCatalog &outputCat);

private:
    typedef afw::table::Key<afw::table::Flag> FlagKey;

    struct KeyTuple {
        FlagKey footprint;
        FlagKey peak;
    };

    typedef std::vector<std::shared_ptr<FootprintMerge>> FootprintMergeVec;
    typedef std::map<std::string, KeyTuple> FilterMap;

    friend class FootprintMerge;

    void _initialize(afw::table::Schema &sourceSchema, std::vector<std::string> const &filterList);

    FootprintMergeVec _mergeList;
    FilterMap _filterMap;
    afw::table::SchemaMapper _peakSchemaMapper;
    std::shared_ptr<PeakTable> _peakTable;
};
}  // namespace detection
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_DETECTION_FOOTPRINTMERGE_H