GaussianCentroid.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2013 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_GaussianCentroid_h_INCLUDED
#define LSST_MEAS_BASE_GaussianCentroid_h_INCLUDED

#include "lsst/afw/geom/Point.h"
#include "lsst/pex/config.h"
#include "lsst/meas/base/Algorithm.h"
#include "lsst/meas/base/CentroidUtilities.h"
#include "lsst/meas/base/FlagHandler.h"
#include "lsst/meas/base/InputUtilities.h"

namespace lsst { namespace meas { namespace base {

struct FittedModel {
    enum { PEAK = 0, SKY, X0, Y0, SIGMA, NPARAM };

    enum {
        BAD_GUESS = -11,
        TOO_FEW = -12,
        CHI_SQUARED = -13,
        RANGE = -14,
        BAD_WIDTH = -15,
        LOST = -16,
        DIAGONAL = -17,
        BAD_A = -18,
        CONVERGE = 1,
        ITERATE = 2,
        ALMOST = 3,
        POOR = 4
    };

    FittedModel(int status_, std::vector<double> params_, int iter_=0, double flamd_=0, double chnew_=0) :
        status(status_), params(params_), iter(iter_), flamd(flamd_), chnew(chnew_) { }
    int status;
    std::vector<double> params;
    int iter;
    double flamd;
    double chnew;
};

class GaussianCentroidControl {
public:
    LSST_CONTROL_FIELD(doFootprintCheck, bool,
                       "Do check that the centroid is contained in footprint.");
    LSST_CONTROL_FIELD(maxDistToPeak, double,
                       "If set > 0, Centroid Check also checks distance from footprint peak.");
    GaussianCentroidControl() : doFootprintCheck(true), maxDistToPeak(-1.0) {}
};

class GaussianCentroidAlgorithm : public SimpleAlgorithm {
public:

    // Structures and routines to manage flaghandler
    static FlagDefinitionList const & getFlagDefinitions();
    static FlagDefinition const FAILURE;
    static FlagDefinition const NO_PEAK;

    typedef GaussianCentroidControl Control;

    GaussianCentroidAlgorithm(Control const & ctrl, std::string const & name, afw::table::Schema & schema);

    template<typename PixelT>
    static afw::geom::Point2D fitCentroid(afw::image::Image<PixelT> const& im,
                  double x0,
                  double y0
    );

    virtual void measure(
        afw::table::SourceRecord & measRecord,
        afw::image::Exposure<float> const & exposure
    ) const;

    virtual void fail(
        afw::table::SourceRecord & measRecord,
        MeasurementError * error=nullptr
    ) const;

private:

    Control _ctrl;
    CentroidResultKey _centroidKey;
    FlagHandler _flagHandler;
    SafeCentroidExtractor _centroidExtractor;
    CentroidChecker _centroidChecker;
};

class GaussianCentroidTransform : public CentroidTransform {
public:
    typedef GaussianCentroidControl Control;

    GaussianCentroidTransform(Control const & ctrl, std::string const & name, afw::table::SchemaMapper & mapper);
};

}}} // namespace lsst::meas::base

#endif // !LSST_MEAS_BASE_GaussianCentroid_h_INCLUDED