Measure.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/>.
 */
 
#if !defined(LSST_MEAS_ALGORITHMS_MEASURE_H)
#define LSST_MEAS_ALGORITHMS_MEASURE_H

// Measure properties of an image selected by a Footprint
//
#include <list>
#include <cmath>

#include "boost/cstdint.hpp"
#include "boost/type_traits.hpp"
#include "boost/array.hpp"

#include "lsst/base.h"
#include "lsst/pex/logging/Log.h"
#include "lsst/pex/config.h"
#include "lsst/afw/image/MaskedImage.h"
#include "lsst/afw/image/ImageUtils.h"
#include "lsst/afw/detection.h"
#include "lsst/meas/algorithms/Algorithm.h"
#include "lsst/meas/algorithms/CentroidControl.h"

namespace lsst { namespace meas { namespace algorithms {

class MeasureSourcesBuilder;

class MeasureSources {
public:
    typedef MeasureSourcesBuilder Builder;
    typedef std::list<CONST_PTR(Algorithm)> AlgorithmList;

    AlgorithmList const & getAlgorithms() const { return _algorithms; }

    template <typename PixelT>
    void apply(
        afw::table::SourceRecord & source,
        afw::image::Exposure<PixelT> const & exposure,
        afw::geom::Point2D const & center,
        bool refineCenter=true
    ) const;

    template <typename PixelT>
    void apply(
        afw::table::SourceRecord & source,
        afw::image::Exposure<PixelT> const & exposure
    ) const;

    template <typename PixelT>
    void applyWithCoord(
        afw::table::SourceRecord & source,
        afw::image::Exposure<PixelT> const & exposure
    ) const {
        apply(source, exposure, exposure.getWcs()->skyToPixel(source.getCoord()), false);
    }

    template <typename PixelT>
    void applyWithPixel(
        afw::table::SourceRecord & source,
        afw::image::Exposure<PixelT> const & exposure
    ) const {
        apply(source, exposure, afw::geom::Point2D(source.getX(), source.getY()), false);
    }

    template <typename PixelT>
    void apply(
        afw::table::SourceRecord & source,
        afw::image::Exposure<PixelT> const & exposure,
        afw::table::SourceRecord const& reference,
        CONST_PTR(afw::image::Wcs) referenceWcs = CONST_PTR(afw::image::Wcs)()
    ) const;

private:

    MeasureSources() {}

    friend class MeasureSourcesBuilder;

    afw::table::Key<afw::table::Flag> _badCentroidKey;
    PTR(pex::logging::Log) _log;
    AlgorithmList _algorithms;
    PTR(CentroidAlgorithm) _centroider;
};

class MeasureSourcesBuilder {
public:

    MeasureSourcesBuilder & addAlgorithm(AlgorithmControl const & algorithmControl);

    MeasureSourcesBuilder & setCentroider(CentroidControl const & centroidControl);
    
    MeasureSources build(
        afw::table::Schema & schema,
        PTR(daf::base::PropertyList) const & metadata = PTR(daf::base::PropertyList)()
    ) const;

    explicit MeasureSourcesBuilder(std::string const & prefix = "") : _prefix(prefix) {}

private:

    struct ComparePriority {
        bool operator()(CONST_PTR(AlgorithmControl) const & a, CONST_PTR(AlgorithmControl) const & b) const {
            return (a->priority < b->priority) ||
                (a->priority == b->priority && a->name < b->name);
        }
    };

    typedef std::set<CONST_PTR(AlgorithmControl),ComparePriority> ControlSet;
    
    std::string _prefix;
    CONST_PTR(CentroidControl) _centroider;
    ControlSet _ctrls;
};

}}}
#endif // LSST_MEAS_ALGORITHMS_MEASURE_H