LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
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 
33 namespace lsst {
34 namespace afw {
35 namespace math {
36 
39 public:
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 
76 class ChebyshevBoundedField : public table::io::PersistableFacade<ChebyshevBoundedField>,
77  public BoundedField {
78 public:
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 
213 protected:
214  std::string getPersistenceName() const override;
215 
216  std::string getPythonModule() const override;
217 
218  void write(OutputArchiveHandle& handle) const override;
219 
220 private:
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:49
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
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.
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.
std::shared_ptr< BoundedField > operator*(double const scale) const override
Return a scaled BoundedField.
ChebyshevBoundedField(ChebyshevBoundedField &&)
ChebyshevBoundedField & operator=(ChebyshevBoundedField &&)=delete
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 mean() const override
Compute the mean of this function over its bounding-box.
ndarray::Array< double const, 2, 2 > getCoefficients() const
Return the coefficient matrix.
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.
ChebyshevBoundedField & operator=(ChebyshevBoundedField const &)=delete
virtual double evaluate(lsst::geom::Point2D const &position) const=0
Evaluate the field at the given point.
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
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:108
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
A base class for image defects.
double w
Definition: CoaddPsf.cc:69