LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
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
175 static ndarray::Array<double, 2, 2> makeFitMatrix(
176 lsst::geom::Box2I const& bbox,
177 ndarray::Array<double const, 1> const& x,
178 ndarray::Array<double const, 1> const& y,
179 Control const& ctrl
180 );
181
195 template <typename T>
197
203 ndarray::Array<double const, 2, 2> getCoefficients() const { return _coefficients; }
204
207
215
217 double evaluate(lsst::geom::Point2D const& position) const override;
218
220
222 double integrate() const override;
223
225 double mean() const override;
226
228 bool isPersistable() const noexcept override { return true; }
229
231 std::shared_ptr<BoundedField> operator*(double const scale) const override;
232
234 bool operator==(BoundedField const& rhs) const override;
235
236protected:
237 std::string getPersistenceName() const override;
238
239 std::string getPythonModule() const override;
240
241 void write(OutputArchiveHandle& handle) const override;
242
243private:
244 // Internal constructor for fit() routines: just initializes the transform,
245 // leaves coefficients empty.
246 explicit ChebyshevBoundedField(lsst::geom::Box2I const& bbox);
247
248 lsst::geom::AffineTransform _toChebyshevRange; // maps points from the bbox to [-1,1]x[-1,1]
249 ndarray::Array<double const, 2, 2> _coefficients; // shape=(orderY+1, orderX+1)
250
251 std::string toString() const override;
252};
253} // namespace math
254} // namespace afw
255} // namespace lsst
256
257#endif // !LSST_AFW_MATH_ChebyshevBoundedField_h_INCLUDED
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.
BoundedField(BoundedField const &)=default
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" ;
ChebyshevBoundedField & operator=(ChebyshevBoundedField const &)=delete
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.
static ndarray::Array< double, 2, 2 > makeFitMatrix(lsst::geom::Box2I const &bbox, ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y, Control const &ctrl)
Construct a matrix that can be used to fit or evaluate a Chebyshev polynomial at a set of points.
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.
ChebyshevBoundedField(lsst::geom::Box2I const &bbox, ndarray::Array< double const, 2, 2 > const &coefficients)
Initialize the field from its bounding box an coefficients.
double integrate() const override
Compute the integral of this function over its bounding-box.
A CRTP facade class for subclasses of Persistable.
io::OutputArchiveHandle OutputArchiveHandle
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
Definition __init__.py:1
Point< double, 2 > Point2D
Definition Point.h:324