ShapeControl.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_SHAPECONTROL_H
#define LSST_MEAS_ALGORITHMS_SHAPECONTROL_H
// Control/algorithm hierarchy for shape measurements.
//

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

namespace lsst {
namespace meas {
namespace algorithms {

class ShapeControl;

class ShapeAlgorithm : public Algorithm {
public:

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

    ShapeControl const & getControl() const;

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

protected:

    ShapeAlgorithm(ShapeControl const & ctrl, KeyTuple const & keys);

    ShapeAlgorithm(ShapeControl const & ctrl, afw::table::Schema & schema, char const * doc);

private:
    KeyTuple _keys;
};

class ShapeControl : public AlgorithmControl {
public:

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

    PTR(ShapeAlgorithm) 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<ShapeAlgorithm>(_makeAlgorithm(schema, metadata, others));
    }

protected:
    explicit ShapeControl(std::string const & name_) : AlgorithmControl(name_, 1.0) {}
};

inline ShapeAlgorithm::ShapeAlgorithm(ShapeControl const & ctrl, KeyTuple const & keys) :
    Algorithm(ctrl), _keys(keys)
{}

inline ShapeAlgorithm::ShapeAlgorithm(
    ShapeControl const & ctrl, afw::table::Schema & schema, char const * doc
) :
    Algorithm(ctrl), _keys(afw::table::addShapeFields(schema, ctrl.name, doc))
{}

inline ShapeControl const & ShapeAlgorithm::getControl() const {
    return static_cast<ShapeControl const &>(Algorithm::getControl());
}

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

#endif // !LSST_MEAS_ALGORITHMS_SHAPECONTROL_H