Blendedness.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of meas_base.
 *
 * 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_MEAS_BASE_Blendedness_h_INCLUDED
#define LSST_MEAS_BASE_Blendedness_h_INCLUDED

#include "lsst/pex/config.h"
#include "lsst/meas/base/Algorithm.h"
#include "lsst/meas/base/ShapeUtilities.h"
#include "lsst/afw/table/Source.h"
#include "lsst/afw/image/Image.h"
#include "lsst/meas/base/Transform.h"
#include "lsst/meas/base/FlagHandler.h"

namespace lsst {
namespace meas {
namespace base {

class BlendednessControl {
public:
    LSST_CONTROL_FIELD(
            doOld, bool,
            "Whether to compute HeavyFootprint dot products (the old deblend.blendedness parameter)");

    LSST_CONTROL_FIELD(doFlux, bool, "Whether to compute quantities related to the Gaussian-weighted flux");

    LSST_CONTROL_FIELD(doShape, bool, "Whether to compute quantities related to the Gaussian-weighted shape");

    LSST_CONTROL_FIELD(nSigmaWeightMax, double,
                       "Radius factor that sets the maximum extent of the weight function (and hence the "
                       "flux measurements)");

    BlendednessControl() : doOld(true), doFlux(true), doShape(true), nSigmaWeightMax(3.0) {}
};

class BlendednessAlgorithm : public SimpleAlgorithm {
public:
    // Structures and routines to manage flaghandler
    static FlagDefinitionList const& getFlagDefinitions();
    static FlagDefinition const FAILURE;
    static FlagDefinition const NO_CENTROID;
    static FlagDefinition const NO_SHAPE;

    typedef BlendednessControl Control;

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

    static float computeAbsExpectation(float data, float variance);

    static float computeAbsBias(float mu, float variance);

    void measureChildPixels(afw::image::MaskedImage<float> const& image,
                            afw::table::SourceRecord& child) const;

    void measureParentPixels(afw::image::MaskedImage<float> const& image,
                             afw::table::SourceRecord& child) const;

    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:
    void _measureMoments(afw::image::MaskedImage<float> const& image, afw::table::SourceRecord& child,
                         afw::table::Key<double> const& instFluxRawKey,
                         afw::table::Key<double> const& instFluxAbsKey, ShapeResultKey const& _shapeRawKey,
                         ShapeResultKey const& _shapeAbsKey) const;

    Control const _ctrl;
    afw::table::Key<double> _old;
    afw::table::Key<double> _raw;
    afw::table::Key<double> _instFluxChildRaw;
    afw::table::Key<double> _instFluxParentRaw;
    afw::table::Key<double> _abs;
    afw::table::Key<double> _instFluxChildAbs;
    afw::table::Key<double> _instFluxParentAbs;
    ShapeResultKey _shapeChildRaw;
    ShapeResultKey _shapeParentRaw;
    ShapeResultKey _shapeChildAbs;
    ShapeResultKey _shapeParentAbs;
    FlagHandler _flagHandler;
};

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

#endif  // LSST_MEAS_BASE_Blendedness_h_INCLUDED