LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
ShapeletFunction.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_SHAPELETFUNCTION_H
26 #define LSST_AFW_MATH_SHAPELETS_SHAPELETFUNCTION_H
27 
28 #include "ndarray.h"
32 #include "lsst/geom.h"
33 #include "lsst/afw/geom/ellipses.h"
34 #include "lsst/afw/image/Image.h"
35 
36 #include <list>
37 
38 namespace lsst { namespace shapelet {
39 
40 class ShapeletFunctionEvaluator;
41 
66 public:
67 
70 
72 
73  static double const FLUX_FACTOR;
74 
76  int getOrder() const { return _order; }
77 
79  afw::geom::ellipses::Ellipse const & getEllipse() const { return _ellipse; }
80 
82  afw::geom::ellipses::Ellipse & getEllipse() { return _ellipse; }
83 
85  void setEllipse(afw::geom::ellipses::Ellipse const & ellipse) { _ellipse = ellipse; }
86 
88  BasisTypeEnum getBasisType() const { return _basisType; }
89 
91  void changeBasisType(BasisTypeEnum basisType) {
92  ConversionMatrix::convertCoefficientVector(_coefficients, _basisType, basisType, _order);
93  _basisType = basisType;
94  }
95 
97  void normalize(double value=1.0);
98 
100  ndarray::Array<double,1,1> const getCoefficients() { return _coefficients; }
101 
103  ndarray::Array<double const,1,1> const getCoefficients() const { return _coefficients; }
104 
107 
109  Evaluator evaluate() const;
110 
112  void shiftInPlace(geom::Extent2D const & offset) {
113  _ellipse.getCenter() += offset;
114  }
115 
118  _ellipse.transform(transform).inPlace();
119  }
120 
123 
126  int order, BasisTypeEnum basisType,
127  ndarray::Array<double,1,1> const & coefficients
128  );
129 
131  ShapeletFunction(int order, BasisTypeEnum basisType, double radius,
132  geom::Point2D const & center=geom::Point2D());
133 
136  int order, BasisTypeEnum basisType, double radius, geom::Point2D const & center,
137  ndarray::Array<double,1,1> const & coefficients
138  );
139 
142  afw::geom::ellipses::Ellipse const & ellipse);
143 
146  int order, BasisTypeEnum basisType,
147  afw::geom::ellipses::Ellipse const & ellipse,
148  ndarray::Array<double const,1,1> const & coefficients
149  );
150 
153 
156 
159 
160 private:
161 
162  int _order;
163  BasisTypeEnum _basisType;
165  ndarray::Array<double,1,1> _coefficients;
166 };
167 
178 public:
179 
182 
184  double operator()(double x, double y) const {
185  return this->operator()(geom::Point2D(x, y));
186  }
187 
189  double operator()(geom::Point2D const & point) const {
190  return _normalization * _h.sumEvaluation(_coefficients, _transform(point));
191  }
192 
194  double operator()(geom::Extent2D const & point) const {
195  return _normalization * _h.sumEvaluation(_coefficients, _transform(point));
196  }
197 
199  ndarray::Array<double,1,1> operator()(
200  ndarray::Array<double const,1> const & x,
201  ndarray::Array<double const,1> const & y
202  ) const;
203 
206  ndarray::Array<double,2,1> const & array,
207  geom::Point2I const & xy0 = geom::Point2I()
208  ) const;
209 
212  addToImage(image.getArray(), image.getXY0());
213  }
214 
216  double integrate() const {
217  return _h.sumIntegration(_coefficients);
218  }
219 
222 
224  void update(ShapeletFunction const & function);
225 
227  explicit ShapeletFunctionEvaluator(ShapeletFunction const & function);
228 
229 private:
230 
232 
233  void _computeRawMoments(double & q0, Eigen::Vector2d & q1, Eigen::Matrix2d & q2) const;
234 
235  double _normalization;
236  ndarray::Array<double const,1,1> _coefficients;
237  geom::AffineTransform _transform;
239 };
240 
242  return ShapeletFunctionEvaluator(*this);
243 }
244 
245 }} // namespace lsst::shapelet
246 
247 #endif // !defined(LSST_AFW_MATH_SHAPELETS_SHAPELETFUNCTION_H)
ndarray::Array< double const, 2, 2 > coefficients
double x
int y
Definition: SpanSet.cc:48
table::Key< int > transform
void inPlace()
Transform the ellipse in-place.
Definition: Transformer.cc:103
An ellipse defined by an arbitrary BaseCore and a center point.
Definition: Ellipse.h:51
lsst::geom::Point2D const & getCenter() const
Return the center point.
Definition: Ellipse.h:62
Transformer transform(lsst::geom::AffineTransform const &transform)
Definition: Transformer.h:124
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
An affine coordinate transformation consisting of a linear transformation and an offset.
static void convertCoefficientVector(ndarray::Array< double, 1 > const &array, BasisTypeEnum input, BasisTypeEnum output, int order)
Convert a coefficient vector between basis types in-place.
A class to evaluate HERMITE shapelet-related quantities.
double sumIntegration(ndarray::Array< double const, 1 > const &coeff, int xMoment=0, int yMoment=0) const
Integrate a simple unscaled shapelet expansion.
double sumEvaluation(ndarray::Array< double const, 1 > const &coeff, double x, double y, double *dx=0, double *dy=0) const
Evaluate a simple unscaled shapelet expansion at the given point.
std::shared_ptr< ShapeletFunctionEvaluator const > ConstPtr
void addToImage(afw::image::Image< double > &image) const
Evaluate the function on the given image.
afw::geom::ellipses::Ellipse computeMoments() const
Return the unweighted dipole and quadrupole moments of the function as an ellipse.
double operator()(geom::Extent2D const &point) const
Evaluate at the given point.
double operator()(double x, double y) const
Evaluate at the given point.
double operator()(geom::Point2D const &point) const
Evaluate at the given point.
void update(ShapeletFunction const &function)
Update the evaluator from the given function.
void addToImage(ndarray::Array< double, 2, 1 > const &array, geom::Point2I const &xy0=geom::Point2I()) const
Add the function to the given image-like array.
ShapeletFunctionEvaluator(ShapeletFunction const &function)
Construct an evaluator for the given function.
std::shared_ptr< ShapeletFunctionEvaluator > Ptr
ndarray::Array< double, 1, 1 > operator()(ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const
Evaluate at the given points, returning a newly-allocated array.
double integrate() const
Compute the definite integral or integral moments.
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.
ShapeletFunction(int order, BasisTypeEnum basisType)
Construct a function with a unit-circle ellipse and set all coefficients to zero.
int getOrder() const
Return the maximum order (inclusive), either or .
ShapeletFunction(int order, BasisTypeEnum basisType, ndarray::Array< double, 1, 1 > const &coefficients)
Construct a function with a unit-circle ellipse and a deep-copied coefficient vector.
BasisTypeEnum getBasisType() const
Return the basis type (HERMITE or LAGUERRE).
ShapeletFunctionEvaluator Evaluator
ShapeletFunction(int order, BasisTypeEnum basisType, afw::geom::ellipses::Ellipse const &ellipse)
Construct a function and set all coefficients to zero.
ShapeletFunction & operator=(ShapeletFunction const &other)
Assignment (deep).
void changeBasisType(BasisTypeEnum basisType)
Change the basis type and convert coefficients in-place correspondingly.
ShapeletFunction(int order, BasisTypeEnum basisType, double radius, geom::Point2D const &center, ndarray::Array< double, 1, 1 > const &coefficients)
Construct a function with a circular ellipse and a deep-copied coefficient vector.
std::shared_ptr< ShapeletFunction const > ConstPtr
afw::geom::ellipses::Ellipse & getEllipse()
Get the ellipse (non-const).
ShapeletFunction(int order, BasisTypeEnum basisType, afw::geom::ellipses::Ellipse const &ellipse, ndarray::Array< double const, 1, 1 > const &coefficients)
Construct a function with a deep-copied coefficient vector.
void shiftInPlace(geom::Extent2D const &offset)
Shift the shapelet function by shifting the basis ellipse.
ShapeletFunction convolve(ShapeletFunction const &other) const
Convolve the shapelet function.
ShapeletFunction(ShapeletFunction const &other)
Copy constructor (deep).
ndarray::Array< double const, 1, 1 > const getCoefficients() const
Return the coefficient vector (const).
void setEllipse(afw::geom::ellipses::Ellipse const &ellipse)
Set the ellipse.
std::shared_ptr< ShapeletFunction > Ptr
ShapeletFunction()
Default constructor to appease SWIG (used by std::list). Not for use by users.
void normalize(double value=1.0)
Normalize the integral of the shapelet function to the given value.
ShapeletFunction(int order, BasisTypeEnum basisType, double radius, geom::Point2D const &center=geom::Point2D())
Construct a function with a circular ellipse and set all coefficients to zero.
afw::geom::ellipses::Ellipse const & getEllipse() const
Get the ellipse (const).
void transformInPlace(geom::AffineTransform const &transform)
Transform the shapelet function by transforming the basis ellipse.
ndarray::Array< double, 1, 1 > const getCoefficients()
Return the coefficient vector.
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
A base class for image defects.
Constants, typedefs, and general-purpose functions for shapelets library.
table::Key< int > order