lsst.afw  22.0.1-37-g8beae7976+adf6a225de
PixelAreaBoundedField.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of afw.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
28 #ifndef LSST_AFW_MATH_PixelAreaBoundedField_h_INCLUDED
29 #define LSST_AFW_MATH_PixelAreaBoundedField_h_INCLUDED
30 
31 
32 #include "lsst/geom/Angle.h"
33 #include "lsst/afw/geom/SkyWcs.h"
35 #include "lsst/pex/exceptions.h"
36 
37 namespace lsst {
38 namespace afw {
39 namespace math {
40 
48 public:
49 
63  lsst::geom::Box2I const &bbox,
66  double scaling = 1.0
67  );
68 
69  ~PixelAreaBoundedField() override = default;
70 
75 
77  double evaluate(lsst::geom::Point2D const &position) const override;
78 
80  ndarray::Array<double, 1, 1> evaluate(ndarray::Array<double const, 1> const & x,
81  ndarray::Array<double const, 1> const & y) const override;
82 
85  bool isPersistable() const noexcept override;
86 
88  std::shared_ptr<BoundedField> operator*(double const scale) const override;
89 
91  bool operator==(BoundedField const &rhs) const override;
92 
93 protected:
94 
95  std::string getPersistenceName() const override;
96  std::string getPythonModule() const override;
97  void write(OutputArchiveHandle &handle) const override;
98 
99 private:
100 
101  std::string toString() const override;
102 
103  std::shared_ptr<geom::SkyWcs const> _skyWcs;
104  double _scaling;
105 };
106 
107 } // namespace math
108 } // namespace afw
109 } // namespace lsst
110 
111 #endif // !LSST_AFW_MATH_PixelAreaBoundedField_h_INCLUDED
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
double x
table::Key< double > scaling
int y
Definition: SpanSet.cc:48
An abstract base class for 2-d functions defined on an integer bounding boxes.
Definition: BoundedField.h:55
A BoundedField that evaluate the pixel area of a SkyWcs in angular units.
double evaluate(lsst::geom::Point2D const &position) const override
Evaluate the field at the given point.
bool isPersistable() const noexcept override
PixelAreaBoundedField is persistable if and only if the nested SkyWcs is.
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
PixelAreaBoundedField(lsst::geom::Box2I const &bbox, std::shared_ptr< geom::SkyWcs const > skyWcs, lsst::geom::AngleUnit const &unit=lsst::geom::radians, double scaling=1.0)
Create a PixelAreaBoundedField from a SkyWcs.
PixelAreaBoundedField & operator=(PixelAreaBoundedField const &)=delete
PixelAreaBoundedField(PixelAreaBoundedField const &)=default
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
PixelAreaBoundedField & operator=(PixelAreaBoundedField &&)=delete
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
PixelAreaBoundedField(PixelAreaBoundedField &&)=default
An object passed to Persistable::write to allow it to persist itself.
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:108
constexpr AngleUnit radians
A base class for image defects.
STL namespace.