SpanSetMoments.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_ALGORITHMS_SpanSetMoments_h_INCLUDED
#define LSST_MEAS_ALGORITHMS_SpanSetMoments_h_INCLUDED
 
#include "ndarray.h"
#include "lsst/geom/Point.h"
#include "lsst/afw/image/MaskedImage.h"
#include "lsst/afw/geom/ellipses/Quadrupole.h"
#include "lsst/afw/geom/SpanSet.h"
#include "lsst/shapelet/ShapeletFunction.h"
 
namespace lsst {
namespace meas {
namespace algorithms {

struct SpanSetMoments {

    double flux;

    double variance;

    geom::Point2D center;

    afw::geom::ellipses::Quadrupole shape;

    std::shared_ptr<afw::geom::SpanSet> spans;

    bool too_many_bad_pixels = false;

    bool center_out_of_bounds = false;

    bool bad_pixel_in_center = false;

    bool singular_second_moments = false;

    bool any_flags_set() const {
        return too_many_bad_pixels || center_out_of_bounds || bad_pixel_in_center || singular_second_moments;
    }

    ndarray::Array<float, 1, 1> get_x_array() const;

    ndarray::Array<float, 1, 1> get_y_array() const;

    static std::shared_ptr<SpanSetMoments> compute(afw::geom::SpanSet const& spans,
                                                   afw::image::MaskedImage<float> const& masked_image,
                                                   afw::image::MaskPixel bad_bitmask,
                                                   double bad_pixel_max_fraction,
                                                   double bad_pixel_exclusion_radius);

    static shapelet::ShapeletFunction fit_shapelets(
            afw::image::MaskedImage<float> const& masked_image,
            std::vector<std::shared_ptr<SpanSetMoments>> const& moments,
            int order, double scale, bool circular);
};
 
}  // namespace algorithms
}  // namespace meas
}  // namespace lsst
 
#endif  // !LSST_MEAS_ALGORITHMS_SpanSetMoments_h_INCLUDED