LSST Applications g070148d5b3+33e5256705,g0d53e28543+25c8b88941,g0da5cf3356+2dd1178308,g1081da9e2a+62d12e78cb,g17e5ecfddb+7e422d6136,g1c76d35bf8+ede3a706f7,g295839609d+225697d880,g2e2c1a68ba+cc1f6f037e,g2ffcdf413f+853cd4dcde,g38293774b4+62d12e78cb,g3b44f30a73+d953f1ac34,g48ccf36440+885b902d19,g4b2f1765b6+7dedbde6d2,g5320a0a9f6+0c5d6105b6,g56b687f8c9+ede3a706f7,g5c4744a4d9+ef6ac23297,g5ffd174ac0+0c5d6105b6,g6075d09f38+66af417445,g667d525e37+2ced63db88,g670421136f+2ced63db88,g71f27ac40c+2ced63db88,g774830318a+463cbe8d1f,g7876bc68e5+1d137996f1,g7985c39107+62d12e78cb,g7fdac2220c+0fd8241c05,g96f01af41f+368e6903a7,g9ca82378b8+2ced63db88,g9d27549199+ef6ac23297,gabe93b2c52+e3573e3735,gb065e2a02a+3dfbe639da,gbc3249ced9+0c5d6105b6,gbec6a3398f+0c5d6105b6,gc9534b9d65+35b9f25267,gd01420fc67+0c5d6105b6,geee7ff78d7+a14128c129,gf63283c776+ede3a706f7,gfed783d017+0c5d6105b6,w.2022.47
LSST Data Management Base Package
Loading...
Searching...
No Matches
ChebyshevBoundedField.h
Go to the documentation of this file.
1// -*- LSST-C++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2014 LSST Corporation.
5 *
6 * This product includes software developed by the
7 * LSST Project (http://www.lsst.org/).
8 *
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the LSST License Statement and
20 * the GNU General Public License along with this program. If not,
21 * see <http://www.lsstcorp.org/LegalNotices/>.
22 */
23
24#ifndef LSST_AFW_MATH_ChebyshevBoundedField_h_INCLUDED
25#define LSST_AFW_MATH_ChebyshevBoundedField_h_INCLUDED
26
27#include "ndarray.h"
28
29#include "lsst/pex/config.h"
32
33namespace lsst {
34namespace afw {
35namespace math {
36
39public:
41
42 LSST_CONTROL_FIELD(orderX, int, "maximum Chebyshev function order in x");
43
44 LSST_CONTROL_FIELD(orderY, int, "maximum Chebyshev function order in y");
45
47 "if true, only include terms where the sum of the x and y order "
48 "is less than or equal to max(orderX, orderY)");
49
51 int computeSize() const;
52};
53
76class ChebyshevBoundedField : public table::io::PersistableFacade<ChebyshevBoundedField>,
77 public BoundedField {
78public:
80
116 ndarray::Array<double const, 2, 2> const& coefficients);
117
123
135 ndarray::Array<double const, 1> const& x,
136 ndarray::Array<double const, 1> const& y,
137 ndarray::Array<double const, 1> const& z,
138 Control const& ctrl);
139
153 ndarray::Array<double const, 1> const& x,
154 ndarray::Array<double const, 1> const& y,
155 ndarray::Array<double const, 1> const& z,
156 ndarray::Array<double const, 1> const& w,
157 Control const& ctrl);
158
172 template <typename T>
174
180 ndarray::Array<double const, 2, 2> getCoefficients() const { return _coefficients; }
181
184
192
194 double evaluate(lsst::geom::Point2D const& position) const override;
195
197
199 double integrate() const override;
200
202 double mean() const override;
203
205 bool isPersistable() const noexcept override { return true; }
206
208 std::shared_ptr<BoundedField> operator*(double const scale) const override;
209
211 bool operator==(BoundedField const& rhs) const override;
212
213protected:
214 std::string getPersistenceName() const override;
215
216 std::string getPythonModule() const override;
217
218 void write(OutputArchiveHandle& handle) const override;
219
220private:
221 // Internal constructor for fit() routines: just initializes the transform,
222 // leaves coefficients empty.
224
225 lsst::geom::AffineTransform _toChebyshevRange; // maps points from the bbox to [-1,1]x[-1,1]
226 ndarray::Array<double const, 2, 2> _coefficients; // shape=(orderY+1, orderX+1)
227
228 std::string toString() const override;
229};
230} // namespace math
231} // namespace afw
232} // namespace lsst
233
234#endif // !LSST_AFW_MATH_ChebyshevBoundedField_h_INCLUDED
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
ndarray::Array< double const, 2, 2 > coefficients
double x
double z
Definition: Match.cc:44
int y
Definition: SpanSet.cc:48
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
An abstract base class for 2-d functions defined on an integer bounding boxes.
Definition: BoundedField.h:55
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.
A control object used when fitting ChebyshevBoundedField to data (see ChebyshevBoundedField::fit)
int computeSize() const
Return the number of nonzero coefficients in the Chebyshev function defined by this object.
bool triangular
"if true, only include terms where the sum of the x and y order " "is less than or equal to max(order...
int orderY
"maximum Chebyshev function order in y" ;
int orderX
"maximum Chebyshev function order in x" ;
A BoundedField based on 2-d Chebyshev polynomials of the first kind.
ChebyshevBoundedField & operator=(ChebyshevBoundedField const &)=delete
static std::shared_ptr< ChebyshevBoundedField > fit(lsst::geom::Box2I const &bbox, ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y, ndarray::Array< double const, 1 > const &z, Control const &ctrl)
Fit a Chebyshev approximation to non-gridded data with equal weights.
std::shared_ptr< ChebyshevBoundedField > relocate(lsst::geom::Box2I const &bbox) const
Return a new ChebyshevBoundedField with domain set to the given bounding box.
bool operator==(BoundedField const &rhs) const override
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
bool isPersistable() const noexcept override
ChebyshevBoundedField is always persistable.
ndarray::Array< double const, 2, 2 > getCoefficients() const
Return the coefficient matrix.
std::shared_ptr< BoundedField > operator*(double const scale) const override
Return a scaled BoundedField.
ChebyshevBoundedField(ChebyshevBoundedField &&)
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
double evaluate(lsst::geom::Point2D const &position) const override
Evaluate the field at the given point.
double mean() const override
Compute the mean of this function over its bounding-box.
ChebyshevBoundedField & operator=(ChebyshevBoundedField &&)=delete
std::shared_ptr< ChebyshevBoundedField > truncate(Control const &ctrl) const
Return a new ChebyshevBoudedField with maximum orders set by the given control object.
ChebyshevBoundedField(ChebyshevBoundedField const &)
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
double integrate() const override
Compute the integral of this function over its bounding-box.
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
An affine coordinate transformation consisting of a linear transformation and an offset.
An integer coordinate rectangle.
Definition: Box.h:55
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
double w
Definition: CoaddPsf.cc:69