matchOptimisticB.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
#if !defined(LSST_MEAS_ASTROM_MATCHOPTIMISTICB_H)
#define LSST_MEAS_ASTROM_MATCHOPTIMISTICB_H

#include <cmath>
#include <string>
#include <vector>

#include "lsst/pex/config.h"
#include "lsst/geom/Point.h"
#include "lsst/afw/table/Source.h"
#include "lsst/afw/table/Match.h"

namespace lsst {
namespace meas {
namespace astrom {

struct RecordProxy {
    PTR(afw::table::SimpleRecord) record;
    geom::Point2D position;
    mutable bool used;  // set true if this star object has already been used for a match
                        // mutable to allow freezing the fundamental object data using const
                        // while keeping track of which objects have been used in each search

    double getX() const { return position.getX(); }
    double getY() const { return position.getY(); }

    operator PTR(afw::table::SimpleRecord)() const { return record; }

    bool operator==(RecordProxy const& other) const { return record == other.record; }
    bool operator!=(RecordProxy const& other) const { return record != other.record; }

    RecordProxy(PTR(afw::table::SimpleRecord) record, geom::Point2D const& position)
            : record(record), position(position) {}

    explicit RecordProxy() {}  // default constructor needed so we can call ProxyVector::resize()
};

typedef std::vector<RecordProxy> ProxyVector;

ProxyVector makeProxies(afw::table::SourceCatalog const& sourceCat, afw::geom::SkyWcs const& distortedWcs,
                        afw::geom::SkyWcs const& tanWcs);

ProxyVector makeProxies(afw::table::SimpleCatalog const& posRefCat, afw::geom::SkyWcs const& tanWcs);

struct ProxyPair {
    RecordProxy first;
    RecordProxy second;
    double distance;
    double pa;

    ProxyPair(RecordProxy const& s1, RecordProxy const& s2) : first(s1), second(s2) {
        double x1 = first.position.getX();
        double y1 = first.position.getY();
        double x2 = second.position.getX();
        double y2 = second.position.getY();
        distance = std::hypot(x2 - x1, y2 - y1);
        pa = std::atan2(y2 - y1, x2 - x1);
    }
};

struct MatchOptimisticBControl {
    LSST_CONTROL_FIELD(refFluxField, std::string, "name of flux field in reference catalog");
    LSST_CONTROL_FIELD(sourceFluxField, std::string, "name of flux field in source catalog");
    LSST_CONTROL_FIELD(numBrightStars, int, "maximum number of bright reference stars to use");
    LSST_CONTROL_FIELD(minMatchedPairs, int, "minimum number of matches");
    LSST_CONTROL_FIELD(matchingAllowancePix, double,
                       "maximum allowed distance between reference objects and sources (pixels)");
    LSST_CONTROL_FIELD(maxOffsetPix, double, "maximum allowed frame translation (pixels)");
    LSST_CONTROL_FIELD(maxRotationDeg, double, "maximum allowed frame rotation (deg)");
    LSST_CONTROL_FIELD(allowedNonperpDeg, double, "allowed non-perpendicularity of x and y axes (deg)");
    LSST_CONTROL_FIELD(numPointsForShape, int, "number of points in a matching shape");
    LSST_CONTROL_FIELD(maxDeterminant, double, "?");

    MatchOptimisticBControl()
            : refFluxField("r_flux"),
              sourceFluxField("slot_ApFlux_instFlux"),
              numBrightStars(100),
              minMatchedPairs(50),
              matchingAllowancePix(10.0),
              maxOffsetPix(300),
              maxRotationDeg(1.0),
              allowedNonperpDeg(3.0),
              numPointsForShape(6),
              maxDeterminant(0.02) {
        validate();
    }

    void validate() const;

    ~MatchOptimisticBControl(){};
};

afw::table::ReferenceMatchVector matchOptimisticB(afw::table::SimpleCatalog const& posRefCat,
                                                  afw::table::SourceCatalog const& sourceCat,
                                                  MatchOptimisticBControl const& control,
                                                  afw::geom::SkyWcs const& wcs, int posRefBegInd = 0,
                                                  bool verbose = false);

}  // namespace astrom
}  // namespace meas
}  // namespace lsst

#endif