FluxControl.h

Go to the documentation of this file.

// -*- LSST-C++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 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_FLUXCONTROL_H
#define LSST_MEAS_ALGORITHMS_FLUXCONTROL_H
// Control/algorithm hierarchy for flux measurement.
//

#include "lsst/base.h"
#include "lsst/pex/config.h"
#include "lsst/meas/algorithms/Algorithm.h"

namespace lsst {
namespace meas {
namespace algorithms {

class FluxControl;

class FluxAlgorithm : public Algorithm {
public:

    typedef afw::table::KeyTuple<afw::table::Flux> KeyTuple;

    FluxControl const & getControl() const;

    KeyTuple const & getKeys() const { return _keys; }

protected:

    FluxAlgorithm(FluxControl const & ctrl, KeyTuple const & keys);

    FluxAlgorithm(FluxControl const & ctrl, afw::table::Schema & schema, char const * doc);

private:
    KeyTuple _keys;
};

class FluxControl : public AlgorithmControl {
public:

    PTR(FluxControl) clone() const { return boost::static_pointer_cast<FluxControl>(_clone()); }

    PTR(FluxAlgorithm) makeAlgorithm(
        afw::table::Schema & schema,
        PTR(daf::base::PropertyList) const & metadata = PTR(daf::base::PropertyList)(),
        AlgorithmMap const & others = AlgorithmMap()
    ) const {
        return boost::static_pointer_cast<FluxAlgorithm>(_makeAlgorithm(schema, metadata, others));
    }

protected:
    explicit FluxControl(std::string const & name_, double priority=2.0) :
        AlgorithmControl(name_, priority) {}
};

inline FluxAlgorithm::FluxAlgorithm(FluxControl const & ctrl, KeyTuple const & keys) :
    Algorithm(ctrl), _keys(keys)
{}

inline FluxAlgorithm::FluxAlgorithm(
    FluxControl const & ctrl, afw::table::Schema & schema, char const * doc
) :
    Algorithm(ctrl), _keys(afw::table::addFluxFields(schema, ctrl.name, doc))
{}

inline FluxControl const & FluxAlgorithm::getControl() const {
    return static_cast<FluxControl const &>(Algorithm::getControl());
}

class ApertureFluxControl : public AlgorithmControl {
public:

    LSST_CONTROL_FIELD(radii, std::vector<double>, "vector of radii for apertures (in pixels)");

    ApertureFluxControl(std::string const& name="flux.aperture", 
                        float const priority=2.0                 
                       );

private:
    virtual PTR(AlgorithmControl) _clone() const;
    virtual PTR(Algorithm) _makeAlgorithm(
        afw::table::Schema & schema, PTR(daf::base::PropertyList) const & metadata
    ) const;
};


class EllipticalApertureFluxControl : public ApertureFluxControl {
public:
    EllipticalApertureFluxControl() : ApertureFluxControl("flux.aperture.elliptical",
                                                          1.9 
                                                         )
        { }

private:
    virtual PTR(AlgorithmControl) _clone() const;
    virtual PTR(Algorithm) _makeAlgorithm(
        afw::table::Schema & schema, PTR(daf::base::PropertyList) const & metadata
    ) const;
};

class PeakLikelihoodFluxControl : public FluxControl {
public:

    LSST_CONTROL_FIELD(warpingKernelName, std::string,
        "Name of warping kernel (e.g. \"lanczos4\") used to compute the peak");

    PeakLikelihoodFluxControl() : FluxControl("flux.peakLikelihood"), warpingKernelName("lanczos4") {}

private:
    virtual PTR(AlgorithmControl) _clone() const;
    virtual PTR(Algorithm) _makeAlgorithm(
        afw::table::Schema & schema, PTR(daf::base::PropertyList) const & metadata
    ) const;
};

class NaiveFluxControl : public FluxControl {
public:

    LSST_CONTROL_FIELD(radius, double, "FIXME! NEVER DOCUMENTED!");

    NaiveFluxControl() : FluxControl("flux.naive"), radius(7.0) {}

private:
    virtual PTR(AlgorithmControl) _clone() const;
    virtual PTR(Algorithm) _makeAlgorithm(
        afw::table::Schema & schema, PTR(daf::base::PropertyList) const & metadata
    ) const;
};

class PsfFluxControl : public FluxControl {
public:

    PsfFluxControl() : FluxControl("flux.psf") {}

private:
    virtual PTR(AlgorithmControl) _clone() const;
    virtual PTR(Algorithm) _makeAlgorithm(
        afw::table::Schema & schema, PTR(daf::base::PropertyList) const & metadata
    ) const;
};

class SincFluxControl : public FluxControl {
public:

    LSST_CONTROL_FIELD(radius1, double, "major axis of inner boundary (pixels)");
    LSST_CONTROL_FIELD(radius2, double, "major axis of outer boundary (pixels)");
    LSST_CONTROL_FIELD(angle, double, "measured from x anti-clockwise; radians");
    LSST_CONTROL_FIELD(ellipticity, double, "1 - b/a");

    SincFluxControl() : 
        FluxControl("flux.sinc"), radius1(0.0), radius2(7.0), angle(0.0), ellipticity(0.0) {}

private:
    virtual PTR(AlgorithmControl) _clone() const;
    virtual PTR(Algorithm) _makeAlgorithm(
        afw::table::Schema & schema, PTR(daf::base::PropertyList) const & metadata
    ) const;
};

}}}// namespace lsst::meas::algorithms

#endif // !LSST_MEAS_ALGORITHMS_FLUXCONTROL_H