LSSTApplications  20.0.0
LSSTDataManagementBasePackage
chebyshevBoundedField.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2016 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include <pybind11/pybind11.h>
24 #include <pybind11/operators.h>
25 #include <pybind11/stl.h>
26 
27 #include "ndarray/pybind11.h"
28 
29 #include "lsst/pex/config/python.h" // defines LSST_DECLARE_CONTROL_FIELD
31 
35 
36 namespace py = pybind11;
37 
38 using namespace lsst::afw::math;
39 
40 using ClsField = py::class_<ChebyshevBoundedField, std::shared_ptr<ChebyshevBoundedField>,
41  BoundedField>;
42 
43 template <typename PixelT>
48 }
49 
50 PYBIND11_MODULE(chebyshevBoundedField, mod) {
51  /* Module level */
52  py::class_<ChebyshevBoundedFieldControl> clsChebyshevBoundedFieldControl(mod,
53  "ChebyshevBoundedFieldControl");
54  ClsField clsChebyshevBoundedField(mod, "ChebyshevBoundedField");
55 
56  /* Member types and enums */
58 
59  /* Constructors */
60  clsChebyshevBoundedFieldControl.def(py::init<>());
61  clsChebyshevBoundedField.def(
62  py::init<lsst::geom::Box2I const &, ndarray::Array<double const, 2, 2> const &>());
63 
64  /* Operators are defined only in the BoundedField base class;
65  we let Python inheritance provide them here. */
66 
67  /* Members */
68  LSST_DECLARE_CONTROL_FIELD(clsChebyshevBoundedFieldControl, ChebyshevBoundedFieldControl, orderX);
69  LSST_DECLARE_CONTROL_FIELD(clsChebyshevBoundedFieldControl, ChebyshevBoundedFieldControl, orderY);
70  LSST_DECLARE_CONTROL_FIELD(clsChebyshevBoundedFieldControl, ChebyshevBoundedFieldControl, triangular);
71 
72  clsChebyshevBoundedFieldControl.def("computeSize", &ChebyshevBoundedFieldControl::computeSize);
73 
74  clsChebyshevBoundedField.def("getCoefficients", &ChebyshevBoundedField::getCoefficients);
75  clsChebyshevBoundedField.def_static(
77  lsst::geom::Box2I const &, ndarray::Array<double const, 1> const &,
78  ndarray::Array<double const, 1> const &, ndarray::Array<double const, 1> const &,
79  Control const &)) &
81  clsChebyshevBoundedField.def_static(
83  lsst::geom::Box2I const &, ndarray::Array<double const, 1> const &,
84  ndarray::Array<double const, 1> const &, ndarray::Array<double const, 1> const &,
85  ndarray::Array<double const, 1> const &, Control const &)) &
87 
88  clsChebyshevBoundedField.def("truncate", &ChebyshevBoundedField::truncate);
89 
90  // Pybind11 resolves overloads by picking the first one that might work
91  declareTemplates<double>(clsChebyshevBoundedField);
92  declareTemplates<float>(clsChebyshevBoundedField);
93 }
lsst::afw::math::ChebyshevBoundedFieldControl
A control object used when fitting ChebyshevBoundedField to data (see ChebyshevBoundedField::fit)
Definition: ChebyshevBoundedField.h:38
std::shared_ptr
STL class.
lsst::afw::math::BoundedField
An abstract base class for 2-d functions defined on an integer bounding boxes.
Definition: BoundedField.h:55
declareTemplates
void declareTemplates(ClsField &cls)
Definition: chebyshevBoundedField.cc:44
lsst::afw::math::ChebyshevBoundedField::truncate
std::shared_ptr< ChebyshevBoundedField > truncate(Control const &ctrl) const
Return a new ChebyshevBoudedField with maximum orders set by the given control object.
Definition: ChebyshevBoundedField.cc:216
lsst::afw::math::PYBIND11_MODULE
PYBIND11_MODULE(approximate, mod)
Definition: approximate.cc:56
lsst::afw::math::ChebyshevBoundedField::fit
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.
Definition: ChebyshevBoundedField.cc:149
lsst::afw::math::ChebyshevBoundedField::getCoefficients
ndarray::Array< double const, 2, 2 > getCoefficients() const
Return the coefficient matrix.
Definition: ChebyshevBoundedField.h:180
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
orderX
table::Key< int > orderX
Definition: ChebyshevBoundedField.cc:316
python.h
lsst::afw::math::ChebyshevBoundedFieldControl::computeSize
int computeSize() const
Return the number of nonzero coefficients in the Chebyshev function defined by this object.
Definition: ChebyshevBoundedField.cc:44
python.h
ClsField
py::class_< ChebyshevBoundedField, std::shared_ptr< ChebyshevBoundedField >, BoundedField > ClsField
Definition: chebyshevBoundedField.cc:41
Persistable.h
lsst::afw::math
Definition: statistics.dox:6
ChebyshevBoundedField.h
lsst::geom::Box2I
An integer coordinate rectangle.
Definition: Box.h:55
LSST_DECLARE_CONTROL_FIELD
#define LSST_DECLARE_CONTROL_FIELD(WRAPPER, CLASS, NAME)
Macro used to wrap fields declared by LSST_CONTROL_FIELD using Pybind11.
Definition: python.h:50
pybind11
Definition: _GenericMap.cc:40
lsst::afw::image::Image
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
lsst::utils.tests.init
def init()
Definition: tests.py:58
BoundedField.h
lsst::ip::diffim.Control
Control
Definition: __init__.py:49