Match.h

Go to the documentation of this file.

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

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 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_TABLE_MATCH_H
#define LSST_AFW_TABLE_MATCH_H

#include <vector>

#include "lsst/afw/table/fwd.h"
#include "lsst/afw/table/BaseRecord.h"
#include "lsst/afw/table/Simple.h"
#include "lsst/afw/table/Source.h"
#include "lsst/afw/table/Catalog.h"
#include "lsst/afw/geom/Angle.h"

namespace lsst { namespace afw { namespace table {

template <typename Record1, typename Record2>
struct Match {
    PTR(Record1) first;
    PTR(Record2) second;
    double distance; // may be pixels or radians

    Match() : first(), second(), distance(0.0) {}
    
    Match(PTR(Record1) const & r1, PTR(Record2) const & r2, double dist)
        : first(r1), second(r2), distance(dist) {}

    template <typename R1, typename R2>
    Match(Match<R1,R2> const & other) : first(other.first), second(other.second), distance(other.distance) {}

};

typedef Match<SimpleRecord,SimpleRecord> SimpleMatch;
typedef Match<SimpleRecord,SourceRecord> ReferenceMatch;
typedef Match<SourceRecord,SourceRecord> SourceMatch;

typedef std::vector<SimpleMatch> SimpleMatchVector;
typedef std::vector<ReferenceMatch> ReferenceMatchVector;
typedef std::vector<SourceMatch> SourceMatchVector;

SourceMatchVector matchXy(
    SourceCatalog const &cat1, SourceCatalog const &cat2,
    double radius, bool closest=true
);

SourceMatchVector matchXy(SourceCatalog const &cat, double radius, bool symmetric = true);

#ifndef SWIG // swig will be confused by the nested names below; repeated with typedefs in match.i

template <typename Cat1, typename Cat2>
std::vector< Match< typename Cat1::Record, typename Cat2::Record> > matchRaDec(
    Cat1 const & cat1,
    Cat2 const & cat2,
    Angle radius, bool closest = true
);

/*
 * Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to @a cat,
 * and d, the distance between s1 and s2, is at most @a radius. The
 * match is performed in ra, dec space.
 *
 * @param[in] cat          the catalog to self-match
 * @param[in] radius       match radius
 * @param[in] symmetric    if cat to @c true symmetric matches are produced: i.e.
 *                         if (s1, s2, d) is reported, then so is (s2, s1, d).
 * @param[in] key          key used to extract the center
 *
 * This is instantiated for Simple and Source catalogs.
 */
template <typename Cat>
std::vector< Match< typename Cat::Record, typename Cat::Record> > matchRaDec(
    Cat const & cat,
    Angle radius,
    bool symmetric = true
);

template <typename Record1, typename Record2>
BaseCatalog packMatches(std::vector< Match<Record1,Record2> > const & matches);

template <typename Cat1, typename Cat2>
std::vector< Match< typename Cat1::Record, typename Cat2::Record> >
unpackMatches(BaseCatalog const & matches, Cat1 const & cat1, Cat2 const & cat2);

#endif // !SWIG

}}} // namespace lsst::afw::table

#endif // #ifndef LSST_AFW_TABLE_MATCH_H