Associations.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
#ifndef LSST_JOINTCAL_ASSOCIATIONS_H
#define LSST_JOINTCAL_ASSOCIATIONS_H

#include <string>
#include <iostream>
#include <list>

#include "lsst/afw/table/Source.h"
#include "lsst/afw/image/TanWcs.h"
#include "lsst/afw/image/Calib.h"
#include "lsst/afw/image/VisitInfo.h"
#include "lsst/daf/base/PropertySet.h"
#include "lsst/afw/geom/Box.h"

#include "lsst/jointcal/RefStar.h"
#include "lsst/jointcal/FittedStar.h"
#include "lsst/jointcal/CcdImage.h"
#include "lsst/jointcal/Point.h"
#include "lsst/jointcal/JointcalControl.h"

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

namespace lsst {
namespace jointcal {

class Associations {
public:
    CcdImageList ccdImageList;      // the catalog handlers
    RefStarList refStarList;        // e.g. GAIA or SDSS reference stars
    FittedStarList fittedStarList;  // stars that are going to be fitted

    // These are strictly speaking not needed anymore (after DM-4043),
    // but keeping them seems cleaner then exposing the lists themselves.
    size_t refStarListSize() { return refStarList.size(); }
    size_t fittedStarListSize() { return fittedStarList.size(); }

    Associations()
            : _commonTangentPoint(Point(std::numeric_limits<double>::quiet_NaN(),
                                        std::numeric_limits<double>::quiet_NaN())) {}

    Associations(Associations const &) = delete;
    Associations(Associations &&) = delete;
    Associations &operator=(Associations const &) = delete;
    Associations &operator=(Associations &&) = delete;

    void setCommonTangentPoint(lsst::afw::geom::Point2D const &commonTangentPoint);

    Point getCommonTangentPoint() const { return _commonTangentPoint; }

    void addImage(lsst::afw::table::SortedCatalogT<lsst::afw::table::SourceRecord> &catalog,
                  std::shared_ptr<lsst::afw::image::TanWcs> wcs,
                  std::shared_ptr<lsst::afw::image::VisitInfo> visitInfo, lsst::afw::geom::Box2I const &bbox,
                  std::string const &filter, std::shared_ptr<afw::image::PhotoCalib> photoCalib,
                  std::shared_ptr<afw::cameraGeom::Detector> detector, int visit, int ccd,
                  lsst::jointcal::JointcalControl const &control);

    void associateCatalogs(const double matchCutInArcsec = 0, const bool useFittedList = false,
                           const bool enlargeFittedList = true);

    void collectRefStars(lsst::afw::table::SortedCatalogT<lsst::afw::table::SimpleRecord> &refCat,
                         afw::geom::Angle matchCut, std::string const &fluxField,
                         std::map<std::string, std::vector<double>> const &refFluxMap,
                         std::map<std::string, std::vector<double>> const &refFluxErrMap,
                         bool rejectBadFluxes = false);

    void deprojectFittedStars();

/* If Color is "g-i", then the color is assigned from columns "g" and "i" of the colored catalog. */
#ifdef TODO
    void setFittedStarColors(std::string const &dicStarListName, std::string const &color,
                             double matchCutArcSec);
#endif

    void prepareFittedStars(int minMeasurements);

    CcdImageList const &getCcdImageList() const { return ccdImageList; }

    unsigned getNFilters() const { return _filterMap.size(); }

    // Return the bounding box in (ra, dec) coordinates containing the whole catalog
    const lsst::afw::geom::Box2D getRaDecBBox();

    int nCcdImagesValidForFit() const;

    size_t nFittedStarsWithAssociatedRefStar() const;

private:
    void associateRefStars(double matchCutInArcsec, const Gtransfo *gtransfo);

    void assignMags();

    void selectFittedStars(int minMeasurements);

    void normalizeFittedStars() const;

    // Map from filter name to index in each refStar's _refFlux/_refFluxErr vector.
    std::unordered_map<std::string, std::size_t> _filterMap;

    Point _commonTangentPoint;
};

}  // namespace jointcal
}  // namespace lsst
#endif  // LSST_JOINTCAL_ASSOCIATIONS_H