clustering.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2012 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_AP_CLUSTER_CLUSTERING_H
#define LSST_AP_CLUSTER_CLUSTERING_H

#include <utility>
#include <vector>

#include "../match/ExposureInfo.h"
#include "../utils/PT1SkyTile.h"
#include "ClusteringControl.h"
#include "SourceProcessingControl.h"
#include "SourceCluster.h"


namespace lsst { namespace ap { namespace cluster {

std::pair<boost::shared_ptr<lsst::afw::table::SourceTable>,
          lsst::afw::table::SchemaMapper> const
makeOutputSourceTable(
    lsst::afw::table::SourceTable const & prototype,
    SourceProcessingControl const & control
);

boost::shared_ptr<SourceClusterTable> const makeSourceClusterTable(
    lsst::afw::table::SourceTable const & prototype,
    boost::shared_ptr<lsst::afw::table::IdFactory> const & idFactory,
    SourceProcessingControl const & control
);

void processSources(
    lsst::afw::table::SourceCatalog const & expSources,
    lsst::ap::match::ExposureInfo const & expInfo,
    lsst::ap::utils::PT1SkyTile const * skyTile,
    SourceProcessingControl const & control,
    lsst::afw::table::SchemaMapper const & mapper,
    lsst::afw::table::SourceCatalog & sources,
    lsst::afw::table::SourceCatalog & badSources,
    lsst::afw::table::SourceCatalog & invalidSources
);

std::vector<lsst::afw::table::SourceCatalog> const cluster(
    lsst::afw::table::SourceCatalog const & sources,
    ClusteringControl const & control
);

void setClusterFields(
    lsst::afw::table::SourceCatalog & sources,
    SourceClusterRecord const & record,
    SourceProcessingControl const & control
);

}}} // namespace lsst::ap::cluster

#endif // LSST_AP_CLUSTER_CLUSTERING_H