LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
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"
35
36#include <list>
37
38namespace lsst { namespace shapelet {
39
40class ShapeletFunctionEvaluator;
41
66public:
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
83
85 void setEllipse(afw::geom::ellipses::Ellipse const & ellipse) { _ellipse = ellipse; }
86
88 BasisTypeEnum getBasisType() const { return _basisType; }
89
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
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
160private:
161
162 int _order;
163 BasisTypeEnum _basisType;
165 ndarray::Array<double,1,1> _coefficients;
166};
167
178public:
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
229private:
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
afw::geom::ellipses::Ellipse const & getEllipse() const
Get the ellipse (const).
ShapeletFunction(int order, BasisTypeEnum basisType, afw::geom::ellipses::Ellipse const &ellipse)
Construct a function and set all coefficients to zero.
void changeBasisType(BasisTypeEnum basisType)
Change the basis type and convert coefficients in-place correspondingly.
ndarray::Array< double, 1, 1 > const getCoefficients()
Return the coefficient vector.
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
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.
afw::geom::ellipses::Ellipse & getEllipse()
Get the ellipse (non-const).
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).
void setEllipse(afw::geom::ellipses::Ellipse const &ellipse)
Set the ellipse.
std::shared_ptr< ShapeletFunction > Ptr
ndarray::Array< double const, 1, 1 > const getCoefficients() const
Return the coefficient vector (const).
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.
ShapeletFunction & operator=(ShapeletFunction const &other)
Assignment (deep).
void transformInPlace(geom::AffineTransform const &transform)
Transform the shapelet function by transforming the basis ellipse.
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