LSST Applications  21.0.0+3c14b91618,21.0.0+9f51b1e3f7,21.0.0-1-ga51b5d4+6691386486,21.0.0-10-g2408eff+1a328412bf,21.0.0-10-g560fb7b+52fd22d7b4,21.0.0-10-g8d1d15d+2f9043cae0,21.0.0-10-gcf60f90+d15de71c48,21.0.0-11-g25eff31+d43066e4ef,21.0.0-15-g490e301a+a676f0d5cf,21.0.0-2-g103fe59+4758c8ef83,21.0.0-2-g1367e85+a9f57e981a,21.0.0-2-g45278ab+9f51b1e3f7,21.0.0-2-g5242d73+a9f57e981a,21.0.0-2-g7f82c8f+1bcc828e4f,21.0.0-2-g8f08a60+e6fd6d9ff9,21.0.0-2-ga326454+1bcc828e4f,21.0.0-2-gde069b7+66c51b65da,21.0.0-2-gecfae73+251b9830c3,21.0.0-2-gfc62afb+a9f57e981a,21.0.0-20-g09baf175d+e1e7d1c708,21.0.0-3-g357aad2+854c3902c3,21.0.0-3-g4be5c26+a9f57e981a,21.0.0-3-g65f322c+feaa1990e9,21.0.0-3-g7d9da8d+3c14b91618,21.0.0-3-ge02ed75+bda8df9b93,21.0.0-4-g591bb35+bda8df9b93,21.0.0-4-g65b4814+52fd22d7b4,21.0.0-4-g88306b8+656365ce3f,21.0.0-4-gccdca77+86bf7a300d,21.0.0-4-ge8a399c+b99e86088e,21.0.0-5-gd00fb1e+6a0dc09319,21.0.0-51-gd3b42663+bf9f0d1c8b,21.0.0-6-g2d4f3f3+9f51b1e3f7,21.0.0-7-g04766d7+ee2ae02087,21.0.0-7-g98eecf7+3609eddee2,21.0.0-7-gde99fe0+bda8df9b93,21.0.0-8-gd70ce6f+79e45e76e4,master-gac4afde19b+bda8df9b93,w.2021.10
LSST Data Management Base Package
BoundedField.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008-2014 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_AFW_MATH_BoundedField_h_INCLUDED
26 #define LSST_AFW_MATH_BoundedField_h_INCLUDED
27 
28 #include "ndarray.h"
29 
30 #include "lsst/base.h"
31 #include "lsst/geom/Point.h"
32 #include "lsst/afw/image/Image.h"
34 
35 namespace lsst {
36 namespace afw {
37 namespace math {
38 
56 public:
65  virtual double evaluate(lsst::geom::Point2D const& position) const = 0;
66 
75  double evaluate(double x, double y) const { return evaluate(lsst::geom::Point2D(x, y)); }
76 
87  virtual ndarray::Array<double, 1, 1> evaluate(ndarray::Array<double const, 1> const& x,
88  ndarray::Array<double const, 1> const& y) const;
89 
95  virtual double integrate() const;
96 
102  virtual double mean() const;
103 
112  lsst::geom::Box2I getBBox() const { return _bbox; }
113 
128  template <typename T>
129  void fillImage(image::Image<T>& image, bool overlapOnly = false, int xStep = 1, int yStep = 1) const;
130 
146  template <typename T>
147  void addToImage(image::Image<T>& image, double scaleBy = 1.0, bool overlapOnly = false, int xStep = 1,
148  int yStep = 1) const;
149 
164  template <typename T>
165  void multiplyImage(image::Image<T>& image, bool overlapOnly = false, int xStep = 1, int yStep = 1) const;
166 
181  template <typename T>
182  void divideImage(image::Image<T>& image, bool overlapOnly = false, int xStep = 1, int yStep = 1) const;
183 
189  virtual std::shared_ptr<BoundedField> operator*(double const scale) const = 0;
190  std::shared_ptr<BoundedField> operator/(double scale) const { return (*this) * (1.0 / scale); }
191 
193  virtual bool operator==(BoundedField const& rhs) const = 0;
195  bool operator!=(BoundedField const& rhs) const { return !(*this == rhs); };
196 
197  ~BoundedField() override = default;
198  BoundedField(BoundedField const&) = default;
202 
204  return os << bf.toString() << " on " << bf.getBBox();
205  }
206 
207 protected:
208  explicit BoundedField(lsst::geom::Box2I const& bbox) : _bbox(bbox) {}
209 
210 private:
211  lsst::geom::Box2I const _bbox;
212 
213  // String form of the mathematical component (not including the bbox)
214  virtual std::string toString() const = 0;
215 };
216 
218 } // namespace math
219 } // namespace afw
220 } // namespace lsst
221 
222 #endif // !LSST_AFW_MATH_BoundedField_h_INCLUDED
double scaleBy
Definition: BoundedField.cc:76
double x
std::ostream * os
Definition: Schema.cc:746
int y
Definition: SpanSet.cc:49
Basic LSST definitions.
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 bool operator==(BoundedField const &rhs) const =0
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
BoundedField & operator=(BoundedField const &)=delete
lsst::geom::Box2I getBBox() const
Return the bounding box that defines the region where the field is valid.
Definition: BoundedField.h:112
bool operator!=(BoundedField const &rhs) const
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
Definition: BoundedField.h:195
virtual double integrate() const
Compute the integral of this function over its bounding-box.
Definition: BoundedField.cc:49
void divideImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Divide an image by the field in-place.
~BoundedField() override=default
virtual double mean() const
Compute the mean of this function over its bounding-box.
Definition: BoundedField.cc:51
void addToImage(image::Image< T > &image, double scaleBy=1.0, bool overlapOnly=false, int xStep=1, int yStep=1) const
Add the field or a constant multiple of it to an image in-place.
BoundedField & operator=(BoundedField &&)=delete
BoundedField(BoundedField const &)=default
virtual std::string toString() const =0
void multiplyImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Multiply an image by the field in-place.
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.
virtual std::shared_ptr< BoundedField > operator*(double const scale) const =0
Return a scaled BoundedField.
BoundedField(lsst::geom::Box2I const &bbox)
Definition: BoundedField.h:208
friend std::ostream & operator<<(std::ostream &os, BoundedField const &bf)
Definition: BoundedField.h:203
std::shared_ptr< BoundedField > operator/(double scale) const
Definition: BoundedField.h:190
BoundedField(BoundedField &&)=default
double evaluate(double x, double y) const
Evaluate the field at the given point.
Definition: BoundedField.h:75
void fillImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Assign the field to an image, overwriting values already present.
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
An integer coordinate rectangle.
Definition: Box.h:55
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
std::shared_ptr< BoundedField > operator*(double const scale, std::shared_ptr< BoundedField const > bf)
A base class for image defects.
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117