FluxUtilities.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014 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_BASE_FluxUtilities_h_INCLUDED
#define LSST_MEAS_BASE_FluxUtilities_h_INCLUDED

#include "lsst/meas/base/constants.h"
#include "lsst/afw/table/FunctorKey.h"
#include "lsst/afw/table/Schema.h"

namespace lsst { namespace meas { namespace base {

struct FluxResult {
    Flux flux; 
    FluxErrElement fluxSigma; 

    FluxResult();

    explicit FluxResult(Flux flux_, FluxErrElement fluxSigma_) :
        flux(flux_), fluxSigma(fluxSigma_)
    {}
};

class FluxResultKey : public afw::table::FunctorKey<FluxResult> {
public:

    static FluxResultKey addFields(
        afw::table::Schema & schema,
        std::string const & name,
        std::string const & doc
    );

    FluxResultKey() : _flux(), _fluxSigma() {}

    FluxResultKey(
        afw::table::Key<meas::base::Flux> const & flux,  // namespace qualification to unconfuse swig
        afw::table::Key<FluxErrElement> const & fluxSigma
    ) :
        _flux(flux), _fluxSigma(fluxSigma)
    {}

    FluxResultKey(afw::table::SubSchema const & s) : _flux(s["flux"]), _fluxSigma(s["fluxSigma"]) {}

    virtual FluxResult get(afw::table::BaseRecord const & record) const;

    virtual void set(afw::table::BaseRecord & record, FluxResult const & other) const;

    bool operator==(FluxResultKey const & other) const {
        return _flux == other._flux && _fluxSigma == other._fluxSigma;
    }
    bool operator!=(FluxResultKey const & other) const { return !(*this == other); }

    bool isValid() const { return _flux.isValid() && _fluxSigma.isValid(); }

    afw::table::Key<meas::base::Flux> getFlux() const { return _flux; }

    afw::table::Key<FluxErrElement> getFluxSigma() const { return _fluxSigma; }

private:
    afw::table::Key<Flux> _flux;
    afw::table::Key<FluxErrElement> _fluxSigma;
};

}}} // lsst::meas::base

#endif // !LSST_MEAS_BASE_FluxUtilities_h_INCLUDED