ScaledFlux.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_ScaledFlux_H
#define LSST_MEAS_ALGORITHMS_ScaledFlux_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 ScaledFlux {
public:

    struct KeyTuple {
        typedef afw::table::Key<afw::table::Flag> FlagKey;
        typedef afw::table::Key<float> PsfFactorKey;
        
        explicit KeyTuple(
            PsfFactorKey const & psfFactor_=PsfFactorKey(),
            FlagKey const & psfFactorFlag_=FlagKey()
        ) : psfFactor(psfFactor_), psfFactorFlag(psfFactorFlag_) {}
        
        KeyTuple(std::string const & name, afw::table::Schema & schema) :
            psfFactor(
                schema.addField<float>(
                    name + ".psffactor", "'flux' from applying the algorithm to the PSF model")
            ),
            psfFactorFlag(
                schema.addField<afw::table::Flag>(
                    name + ".flags.psffactor", "set if the algorithm could not be applied to the PSF model"
                )
            )
            {}

        PsfFactorKey psfFactor;
        FlagKey psfFactorFlag;
    };

    virtual int getFluxCount() const { return 1; }

    virtual afw::table::KeyTuple<afw::table::Flux> getFluxKeys(int n=0) const = 0;

    virtual KeyTuple getFluxCorrectionKeys(int n=0) const = 0;

    virtual ~ScaledFlux() {}
};

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

#endif // !LSST_MEAS_ALGORITHMS_ScaledFlux_H