CentroidUtilities.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014 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_MEAS_BASE_CentroidUtilities_h_INCLUDED
#define LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED

#include "lsst/meas/base/constants.h"
#include "lsst/geom/Point.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/image/PhotoCalib.h"
#include "lsst/afw/table/aggregates.h"
#include "lsst/meas/base/Transform.h"

namespace lsst {
namespace meas {
namespace base {

struct CentroidResult {
    CentroidElement x;   
    CentroidElement y;   
    ErrElement xErr;     
    ErrElement yErr;     
    ErrElement x_y_Cov;  

    CentroidResult();

    explicit CentroidResult(CentroidElement x_, CentroidElement y_, CentroidCov const& matrix)
            : x(x_),
              y(y_),
              xErr(std::sqrt(matrix(0, 0))),
              yErr(std::sqrt(matrix(1, 1))),
              x_y_Cov(matrix(0, 1)) {}

    explicit CentroidResult(CentroidElement x_, CentroidElement y_, ErrElement xErr_, ErrElement yErr_)
            : x(x_), y(y_), xErr(xErr_), yErr(yErr_), x_y_Cov(0.0) {}

    Centroid const getCentroid() const;

    void setCentroid(Centroid const& centroid);

    geom::Point<CentroidElement> getPoint() { return geom::Point<CentroidElement>(x, y); }

    CentroidCov const getCentroidErr() const;

    void setCentroidErr(CentroidCov const& matrix);

    void setCentroidErr(ErrElement _xErr, ErrElement _yErr);
};

class CentroidResultKey : public afw::table::FunctorKey<CentroidResult> {
public:
    static CentroidResultKey addFields(afw::table::Schema& schema, std::string const& name,
                                       std::string const& doc, UncertaintyEnum uncertainty);

    CentroidResultKey() : _centroid(), _centroidErr() {}

    CentroidResultKey(afw::table::PointKey<CentroidElement> const& centroid,
                      afw::table::CovarianceMatrixKey<ErrElement, 2> const& centroidErr)
            : _centroid(centroid), _centroidErr(centroidErr) {}

    CentroidResultKey(afw::table::SubSchema const& s);

    virtual CentroidResult get(afw::table::BaseRecord const& record) const;

    virtual void set(afw::table::BaseRecord& record, CentroidResult const& value) const;

    bool operator==(CentroidResultKey const& other) const {
        return _centroid == other._centroid && _centroidErr == other._centroidErr;
    }
    bool operator!=(CentroidResultKey const& other) const { return !(*this == other); }

    bool isValid() const { return _centroid.isValid() && _centroidErr.isValid(); }

    afw::table::PointKey<CentroidElement> getCentroid() const { return _centroid; }

    afw::table::CovarianceMatrixKey<ErrElement, 2> getCentroidErr() const { return _centroidErr; }

    afw::table::Key<CentroidElement> getX() const { return _centroid.getX(); }

    afw::table::Key<CentroidElement> getY() const { return _centroid.getY(); }

private:
    afw::table::PointKey<CentroidElement> _centroid;
    afw::table::CovarianceMatrixKey<ErrElement, 2> _centroidErr;
};

class CentroidTransform : public BaseTransform {
public:
    CentroidTransform(std::string const& name, afw::table::SchemaMapper& mapper);

    /*
     * @brief Perform transformation from inputCatalog to outputCatalog.
     *
     * @param[in]     inputCatalog   Source of data to be transformed
     * @param[in,out] outputCatalog  Container for transformed results
     * @param[in]     wcs            World coordinate system under which transformation will take place
     * @param[in]     photoCalib     Photometric calibration under which transformation will take place
     * @throws        LengthError    Catalog sizes do not match
     */
    virtual void operator()(afw::table::SourceCatalog const& inputCatalog,
                            afw::table::BaseCatalog& outputCatalog, afw::geom::SkyWcs const& wcs,
                            afw::image::PhotoCalib const& photoCalib) const;

private:
    afw::table::CoordKey _coordKey;
    afw::table::CovarianceMatrixKey<ErrElement, 2> _coordErrKey;
};

class CentroidChecker {
public:
    CentroidChecker(afw::table::Schema& schema, std::string const& name, bool inside = true,
                    double maxDistFromPeak = -1.0);

    bool operator()(afw::table::SourceRecord& record) const;

private:
    bool _doFootprintCheck;
    double _maxDistFromPeak;
    afw::table::Key<afw::table::Flag> _resetKey;
    afw::table::Key<afw::table::Flag> _failureKey;
    afw::table::Key<CentroidElement> _xKey;
    afw::table::Key<CentroidElement> _yKey;
};
}  // namespace base
}  // namespace meas
}  // namespace lsst

#endif  // !LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED