lsst.shapelet  13.0-4-g5a043c4+16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
MultiShapeletFunction.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010, 2011 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H
26 #define LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H
27 
29 #include <vector>
30 
31 namespace lsst { namespace shapelet {
32 
33 class MultiShapeletFunctionEvaluator;
34 
39 public:
40 
41  typedef std::shared_ptr<MultiShapeletFunction> Ptr;
42  typedef std::shared_ptr<MultiShapeletFunction const> ConstPtr;
43 
45 
47 
48  typedef std::vector<Component> ComponentList;
49 
50  ComponentList & getComponents() { return _components; }
51 
52  ComponentList const & getComponents() const { return _components; }
53 
55  void normalize(double value=1.0);
56 
58  void shiftInPlace(afw::geom::Extent2D const & offset);
59 
61  void transformInPlace(afw::geom::AffineTransform const & transform);
62 
64  MultiShapeletFunction convolve(ShapeletFunction const & other) const;
65 
68 
70  Evaluator evaluate() const;
71 
72  MultiShapeletFunction() : _components() {}
73 
74  MultiShapeletFunction(MultiShapeletFunction const & other) = default;
75 
76  explicit MultiShapeletFunction(ComponentList const & components) : _components(components) {}
77 
78  explicit MultiShapeletFunction(ShapeletFunction const & component) : _components(1, component) {}
79 
80 private:
81  ComponentList _components;
82 };
83 
94 public:
95 
96  typedef std::shared_ptr<MultiShapeletFunctionEvaluator> Ptr;
97  typedef std::shared_ptr<MultiShapeletFunctionEvaluator const> ConstPtr;
98 
100  double operator()(double x, double y) const {
101  return this->operator()(afw::geom::Point2D(x, y));
102  }
103 
105  double operator()(afw::geom::Point2D const & point) const;
106 
108  double operator()(afw::geom::Extent2D const & point) const;
109 
111  ndarray::Array<double,1,1> operator()(
112  ndarray::Array<double const,1> const & x,
113  ndarray::Array<double const,1> const & y
114  ) const;
115 
117  void addToImage(
118  ndarray::Array<double,2,1> const & array,
119  afw::geom::Point2I const & xy0 = afw::geom::Point2I()
120  ) const;
121 
123  void addToImage(afw::image::Image<double> & image) const {
124  addToImage(image.getArray(), image.getXY0());
125  }
126 
128  double integrate() const;
129 
131  afw::geom::ellipses::Ellipse computeMoments() const;
132 
134  void update(MultiShapeletFunction const & function);
135 
137  explicit MultiShapeletFunctionEvaluator(MultiShapeletFunction const & function);
138 
139 private:
140  typedef ShapeletFunctionEvaluator Component;
141  typedef std::list<Component> ComponentList;
142  ComponentList _components;
143 };
144 
146  return MultiShapeletFunctionEvaluator(*this);
147 }
148 
149 }} // namespace lsst::shapelet
150 
151 #endif // !defined(LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H)
void update(MultiShapeletFunction const &function)
Update the evaluator from the given function.
MultiShapeletFunctionEvaluator Evaluator
MultiShapeletFunction(ComponentList const &components)
void normalize(double value=1.0)
Normalize the integral of the shapelet function to the given value.
void addToImage(ndarray::Array< double, 2, 1 > const &array, afw::geom::Point2I const &xy0=afw::geom::Point2I()) const
Add the function to the given image-like array.
MultiShapeletFunctionEvaluator(MultiShapeletFunction const &function)
Construct an evaluator for the given function.
A multi-scale shapelet function.
Evaluates a ShapeletFunction.
ComponentList const & getComponents() const
std::shared_ptr< MultiShapeletFunction const > ConstPtr
double integrate() const
Compute the definite integral or integral moments.
void addToImage(afw::image::Image< double > &image) const
Evaluate the function on the given image.
void transformInPlace(afw::geom::AffineTransform const &transform)
Transform the shapelet function by transforming the ellipse of each component.
MultiShapeletFunction convolve(ShapeletFunction const &other) const
Convolve the multi-shapelet function.
MultiShapeletFunction(ShapeletFunction const &component)
void shiftInPlace(afw::geom::Extent2D const &offset)
Shift the shapelet function by shifting the ellipse of each component.
std::shared_ptr< MultiShapeletFunction > Ptr
A 2-d function defined by an expansion onto a Gauss-Laguerre or Gauss-Hermite basis.
Evaluator evaluate() const
Construct a helper object that can efficiently evaluate the function.
double operator()(double x, double y) const
Evaluate at the given point.
afw::geom::ellipses::Ellipse computeMoments() const
Return the unweighted dipole and quadrupole moments of the function as an ellipse.
std::shared_ptr< MultiShapeletFunctionEvaluator const > ConstPtr
std::shared_ptr< MultiShapeletFunctionEvaluator > Ptr