Associations.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of jointcal.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_JOINTCAL_ASSOCIATIONS_H
#define LSST_JOINTCAL_ASSOCIATIONS_H
 
#include <iostream>
#include <list>
#include <string>
#include <utility>
 
#include "lsst/afw/table/Source.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/image/Calib.h"
#include "lsst/afw/image/VisitInfo.h"
#include "lsst/daf/base/PropertySet.h"
#include "lsst/geom/Box.h"
#include "lsst/sphgeom/Circle.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 {
 
using RefFluxMapType = std::map<std::string, std::vector<double>>;
 
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())),
              _maxMeasuredStars(0) {}
 
    Associations(CcdImageList imageList, double epoch = 0)
            : ccdImageList(std::move(imageList)),
              _commonTangentPoint(Point(std::numeric_limits<double>::quiet_NaN(),
                                        std::numeric_limits<double>::quiet_NaN())),
              _maxMeasuredStars(0),
              _epoch(epoch) {}
 
    Associations(Associations const &) = delete;
    Associations(Associations &&) = delete;
    Associations &operator=(Associations const &) = delete;
    Associations &operator=(Associations &&) = delete;
 
    void computeCommonTangentPoint();
 
    void setCommonTangentPoint(lsst::geom::Point2D const &commonTangentPoint);
    Point getCommonTangentPoint() const { return _commonTangentPoint; }
 
    size_t getMaxMeasuredStars() const { return _maxMeasuredStars; }
 
    double getEpoch() const { return _epoch; }
    void setEpoch(double epoch) { _epoch = epoch; }
 
    void createCcdImage(afw::table::SourceCatalog &catalog, const std::shared_ptr<lsst::afw::geom::SkyWcs>& wcs,
                        const std::shared_ptr<lsst::afw::image::VisitInfo>& visitInfo, const lsst::geom::Box2I &bbox,
                        const std::string &filter, const std::shared_ptr<afw::image::PhotoCalib>& photoCalib,
                        const std::shared_ptr<afw::cameraGeom::Detector>& detector, int visit, int ccd,
                        const lsst::jointcal::JointcalControl &control);
 
    void addCcdImage(std::shared_ptr<CcdImage> const& ccdImage) { ccdImageList.push_back(ccdImage); }
 
    void associateCatalogs(double matchCutInArcsec = 0, bool useFittedList = false,
                           bool enlargeFittedList = true);
 
    void collectRefStars(afw::table::SimpleCatalog &refCat, geom::Angle matchCut,
                         std::string const &fluxField, float refCoordinateErr, bool rejectBadFluxes = false);
 
    void deprojectFittedStars();
 
    void prepareFittedStars(int minMeasurements);
 
    void cleanFittedStars();
 
    CcdImageList const &getCcdImageList() const { return ccdImageList; }
 
    unsigned getNFilters() const { return 1; }
 
    lsst::sphgeom::Circle computeBoundingCircle() const;
 
    int nCcdImagesValidForFit() const;
 
    size_t nFittedStarsWithAssociatedRefStar() const;
 
private:
    void associateRefStars(double matchCutInArcsec, const AstrometryTransform *transform);
 
    void assignMags();
 
    void selectFittedStars(int minMeasurements);
 
    void normalizeFittedStars();
 
    // Common tangent point on-sky of all of the ccdImages, typically determined by computeCommonTangentPoint.
    // (decimal degrees)
    Point _commonTangentPoint;
 
    // The number of MeasuredStars at the start of fitting, before any outliers are removed.
    // This is used to reserve space in vectors for e.g. outlier removal, but is not updated during outlier
    // removal or cleanup, so should only be used as an upper bound on the number of MeasuredStars.
    size_t _maxMeasuredStars;
 
    // Julian Epoch Year (e.g. 2000.0 for J2000)
    // Common epoch of all of the ccdImages, typically computed externally via astropy and then set.
    double _epoch{};
};
 
}  // namespace jointcal
}  // namespace lsst
#endif  // LSST_JOINTCAL_ASSOCIATIONS_H