MultiShapeletFunction.h

Go to the documentation of this file.

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

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010, 2011 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_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H
#define LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H

#include "lsst/shapelet/ShapeletFunction.h"
#include <vector>

namespace lsst { namespace shapelet {

class MultiShapeletFunctionEvaluator;

class MultiShapeletFunction {
public:

    typedef std::shared_ptr<MultiShapeletFunction> Ptr;
    typedef std::shared_ptr<MultiShapeletFunction const> ConstPtr;

    typedef MultiShapeletFunctionEvaluator Evaluator;

    typedef ShapeletFunction Component;

    typedef std::vector<Component> ComponentList;

    ComponentList & getComponents() { return _components; }

    ComponentList const & getComponents() const { return _components; }

    void normalize(double value=1.0);

    void shiftInPlace(afw::geom::Extent2D const & offset);

    void transformInPlace(afw::geom::AffineTransform const & transform);

    MultiShapeletFunction convolve(ShapeletFunction const & other) const;

    MultiShapeletFunction convolve(MultiShapeletFunction const & other) const;

    Evaluator evaluate() const;

    MultiShapeletFunction() : _components() {}

    MultiShapeletFunction(MultiShapeletFunction const & other) = default;

    explicit MultiShapeletFunction(ComponentList const & components) : _components(components) {}

    explicit MultiShapeletFunction(ShapeletFunction const & component) : _components(1, component) {}

private:
    ComponentList _components;
};

class MultiShapeletFunctionEvaluator {
public:

    typedef std::shared_ptr<MultiShapeletFunctionEvaluator> Ptr;
    typedef std::shared_ptr<MultiShapeletFunctionEvaluator const> ConstPtr;

    double operator()(double x, double y) const {
        return this->operator()(afw::geom::Point2D(x, y));
    }

    double operator()(afw::geom::Point2D const & point) const;

    double operator()(afw::geom::Extent2D const & point) const;

    ndarray::Array<double,1,1> operator()(
        ndarray::Array<double const,1> const & x,
        ndarray::Array<double const,1> const & y
    ) const;

    void addToImage(
        ndarray::Array<double,2,1> const & array,
        afw::geom::Point2I const & xy0 = afw::geom::Point2I()
    ) const;

    void addToImage(afw::image::Image<double> & image) const {
        addToImage(image.getArray(), image.getXY0());
    }

    double integrate() const;

    afw::geom::ellipses::Ellipse computeMoments() const;

    void update(MultiShapeletFunction const & function);

    explicit MultiShapeletFunctionEvaluator(MultiShapeletFunction const & function);

private:
    typedef ShapeletFunctionEvaluator Component;
    typedef std::list<Component> ComponentList;
    ComponentList _components;
};

inline MultiShapeletFunctionEvaluator MultiShapeletFunction::evaluate() const {
    return MultiShapeletFunctionEvaluator(*this);
}

}} // namespace lsst::shapelet

#endif // !defined(LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H)