LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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;
199  BoundedField(BoundedField&&) = default;
200  BoundedField& operator=(BoundedField const&) = delete;
201  BoundedField& operator=(BoundedField&&) = delete;
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
virtual double mean() const
Compute the mean of this function over its bounding-box.
Definition: BoundedField.cc:51
Basic LSST definitions.
virtual std::shared_ptr< BoundedField > operator*(double const scale) const =0
Return a scaled BoundedField.
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
int y
Definition: SpanSet.cc:49
void multiplyImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Multiply an image by the field in-place.
STL class.
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
BoundedField & operator=(BoundedField const &)=delete
BoundedField(BoundedField const &)=default
A base class for image defects.
lsst::geom::Box2I getBBox() const
Return the bounding box that defines the region where the field is valid.
Definition: BoundedField.h:112
table::Box2IKey bbox
Definition: Detector.cc:169
virtual bool operator==(BoundedField const &rhs) const =0
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal...
double evaluate(double x, double y) const
Evaluate the field at the given point.
Definition: BoundedField.h:75
double x
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.
BoundedField(lsst::geom::Box2I const &bbox)
Definition: BoundedField.h:208
~BoundedField() override=default
double scaleBy
Definition: BoundedField.cc:76
friend std::ostream & operator<<(std::ostream &os, BoundedField const &bf)
Definition: BoundedField.h:203
An abstract base class for 2-d functions defined on an integer bounding boxes.
Definition: BoundedField.h:55
void divideImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Divide an image by the field in-place.
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects...
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.
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
An integer coordinate rectangle.
Definition: Box.h:54
STL class.
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:59
std::shared_ptr< BoundedField > operator/(double scale) const
Definition: BoundedField.h:190
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
std::ostream * os
Definition: Schema.cc:746