simpleShape.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_EXTENSIONS_simpleShape_h_INCLUDED
#define LSST_MEAS_EXTENSIONS_simpleShape_h_INCLUDED

#include <bitset>

#include "lsst/pex/config.h"
#include "lsst/afw/geom/ellipses.h"
#include "lsst/afw/table.h"
#include "lsst/afw/image.h"
#include "lsst/meas/base/Algorithm.h"
#include "lsst/meas/base.h"

namespace lsst { namespace meas { namespace extensions { namespace simpleShape {

class SimpleShapeResult;

class SimpleShapeControl {
 public:
    LSST_CONTROL_FIELD(sigma, double, "Sigma of circular Gaussian used as weight function, in pixels");
    LSST_CONTROL_FIELD(nSigmaRegion, double, "Maximum radius for pixels to include, in units of sigma");

    SimpleShapeControl() : sigma(1.5), nSigmaRegion(3) {}
};

class SimpleShapeResultKey : public afw::table::FunctorKey<SimpleShapeResult> {
 public:
    static SimpleShapeResultKey addFields(
            afw::table::Schema & schema,
            std::string const & name
    );

    // Default constructor
    SimpleShapeResultKey() {}

    SimpleShapeResultKey(lsst::afw::table::SubSchema const & s);

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

    bool operator==(SimpleShapeResultKey const & other) const;
    bool operator!=(SimpleShapeResultKey const & other) const { return !(*this == other); }

    bool isValid() const;

    lsst::meas::base::FlagHandler const & getFlagHandler() const { return _flagHandler; }

 private:
    lsst::afw::table::QuadrupoleKey _shapeResult;
    lsst::afw::table::Point2DKey _centroidResult;
    lsst::afw::table::CovarianceMatrixKey<double, 5 > _uncertantyResult;
    lsst::meas::base::FlagHandler _flagHandler;
};


class SimpleShape : public lsst::meas::base::SimpleAlgorithm {
public:

    // Structures and routines to manage flaghandler
    static base::FlagDefinitionList const & getFlagDefinitions();
    static unsigned int const N_FLAGS = 1;
    static base::FlagDefinition const FAILURE;

    typedef SimpleShapeControl Control;

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

    template <typename T>
    static SimpleShapeResult computeMoments(
        afw::geom::ellipses::Ellipse const & weight,
        afw::image::MaskedImage<T> const & image,
        double nSigmaRegion=3.0
    );

    static Eigen::Matrix<double,5,6> convertRawMoments(
        Eigen::Matrix<double,6,1> const & q,
        afw::geom::ellipses::Quadrupole & quadrupole,
        afw::geom::Point2D & center
    );

    static Eigen::Matrix<double, 5, 5> correctWeightedMoments(
        afw::geom::ellipses::Quadrupole const & weight,
        afw::geom::ellipses::Quadrupole & ellipse,
        afw::geom::Point2D & center
    );

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

    virtual void fail(
        afw::table::SourceRecord & measRecord,
        lsst::meas::base::MeasurementError * error=NULL
    ) const;

 private:
    Control _ctrl;
    SimpleShapeResultKey _resultKey;
    lsst::meas::base::SafeCentroidExtractor _centroidExtractor;
};

class SimpleShapeResult {
 public:
    afw::geom::ellipses::Quadrupole ellipse; 
    afw::geom::Point2D center; 
    Eigen::Matrix<double,5,5> covariance; 

#ifndef SWIG
    std::bitset<SimpleShape::N_FLAGS> flags;
#endif

    // Flag getter for Swig which doesn't understand std::bitset
    bool getFlag(int index) const { return flags[index]; }

    SimpleShapeResult(); 
};


}}}} // namespace lsst::meas::extensions::simpleShape

#endif // !LSST_MEAS_EXTENSIONS_simpleShape_h_INCLUDED