DoubleShapeletPsfApprox.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2016 LSST/AURA.
 *
 * 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_MODELFIT_DoubleShapeletPsfApprox_h_INCLUDED
#define LSST_MEAS_MODELFIT_DoubleShapeletPsfApprox_h_INCLUDED
 
#include "lsst/afw/geom.h"
#include "lsst/shapelet/FunctorKeys.h"
#include "lsst/meas/base/Algorithm.h"
#include "lsst/meas/base/InputUtilities.h"
#include "lsst/meas/modelfit/optimizer.h"
 
namespace lsst { namespace meas { namespace modelfit {
 
class DoubleShapeletPsfApproxControl {
public:
 
    DoubleShapeletPsfApproxControl() :
        innerOrder(2), outerOrder(1),
        radiusRatio(2.0), peakRatio(0.1),
        minRadius(0.25), minRadiusDiff(0.5), maxRadiusBoxFraction(0.4)
    {}
 
    LSST_CONTROL_FIELD(innerOrder, int, "Shapelet order of inner expansion (0 == Gaussian)");
 
    LSST_CONTROL_FIELD(outerOrder, int, "Shapelet order of outer expansion (0 == Gaussian)");
 
    LSST_CONTROL_FIELD(radiusRatio, double, "Initial outer radius divided by inner radius");
 
    LSST_CONTROL_FIELD(
        peakRatio, double,
        "Initial outer Gaussian peak height divided by inner Gaussian peak height"
    );
 
    LSST_CONTROL_FIELD(
        minRadius, double,
        "Don't allow the semi-minor radius of any component to drop below this value (pixels)"
    );
 
    LSST_CONTROL_FIELD(
        minRadiusDiff, double,
        "Don't allow the determinant radii of the two components to differ by less than this (pixels)"
    );
 
    LSST_CONTROL_FIELD(
        maxRadiusBoxFraction, double,
        "Don't allow the semi-major radius of any component to go above this fraction of the PSF image width"
    );
 
    LSST_NESTED_CONTROL_FIELD(
        optimizer, lsst.meas.modelfit.optimizer, OptimizerControl,
        "Configuration of the optimizer used by DoubleShapeletPsfsApproxAlgorithm::fitProfile()."
    );
 
};
 
 
class DoubleShapeletPsfApproxAlgorithm : public meas::base::SimpleAlgorithm {
public:
 
    // Structures and routines to manage flaghandler
    static base::FlagDefinitionList const & getFlagDefinitions();
    static base::FlagDefinition const FAILURE;
    static base::FlagDefinition const INVALID_POINT_FOR_PSF;
    static base::FlagDefinition const INVALID_MOMENTS;
    static base::FlagDefinition const MAX_ITERATIONS;
 
    typedef DoubleShapeletPsfApproxControl Control;
 
 
    DoubleShapeletPsfApproxAlgorithm(
        Control const & ctrl,
        std::string const & name,
        afw::table::Schema & schema
    );
 
    static shapelet::MultiShapeletFunction initializeResult(Control const & ctrl);
 
    static void fitMoments(
        shapelet::MultiShapeletFunction & result,
        Control const & ctrl,
        afw::image::Image<Scalar> const & psfImage
    );
 
    static std::shared_ptr<OptimizerObjective> makeObjective(
        afw::geom::ellipses::Ellipse const & moments,
        Control const & ctrl,
        afw::image::Image<Scalar> const & psfImage
    );
 
 
    static void fitProfile(
        shapelet::MultiShapeletFunction & result,
        Control const & ctrl,
        afw::image::Image<Scalar> const & psfImage
    );
 
    static void fitShapelets(
        shapelet::MultiShapeletFunction & result,
        Control const & ctrl,
        afw::image::Image<Scalar> const & psfImage
    );
 
    void measure(
        afw::table::SourceRecord & measRecord,
        afw::image::Exposure<float> const & exposure
    ) const;
 
    void fail(
        afw::table::SourceRecord & measRecord,
        lsst::meas::base::MeasurementError * error=nullptr
    ) const;
 
private:
    Control _ctrl;
    meas::base::SafeCentroidExtractor _centroidExtractor;
    shapelet::MultiShapeletFunctionKey _key;
    lsst::meas::base::FlagHandler _flagHandler;
};
 
}}} // namespace lsst::meas::modelfit
 
#endif // !LSST_MEAS_MODELFIT_DoubleShapeletPsfApprox_h_INCLUDED