LSSTApplications  19.0.0-14-gb0260a2+64befe7c1c,20.0.0+0b340dd7c4,20.0.0+1540ce6389,20.0.0+7c6b12c2f9,20.0.0+ae956f52c5,20.0.0+be870186d9,20.0.0+e2e26847c2,20.0.0-1-g04bee24+7c6b12c2f9,20.0.0-1-g10df615+fbe45b1aff,20.0.0-1-g253301a+7c6b12c2f9,20.0.0-1-g2b7511a+46a6078777,20.0.0-1-g4d801e7+9d50d6c21a,20.0.0-1-g5b95a8c+8ebfc75efb,20.0.0-1-gb058bd0+46a6078777,20.0.0-1-gb88604f+acecce4127,20.0.0-1-gc96f8cb+016e330d09,20.0.0-1-gedffbd8+83814edeba,20.0.0-10-g0891cd99+a5f14e9acb,20.0.0-10-g9a20bd332+576ca7b471,20.0.0-17-gcdbda88+0e26bfb1e6,20.0.0-2-g4dae9ad+016e330d09,20.0.0-2-g61b8584+85c46248f3,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-21-g9bbb7f7+016e330d09,20.0.0-22-gc512666+f30f3883a7,20.0.0-23-g8900aa8+68630f7098,20.0.0-3-g1653f94+85c46248f3,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g750bffe+e05f822de9,20.0.0-3-gbd60e8c+ff10c6d78d,20.0.0-32-g15a0e07c+a4c9d0309b,20.0.0-4-g97dc21a+68630f7098,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-6-g9a5b7a1+b0f8c2be93,20.0.0-60-gad89340+e4dd172200,20.0.0-7-gcda7bf1+673816f70c,w.2020.43
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;
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
y
int y
Definition: SpanSet.cc:49
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
Persistable.h
std::string
STL class.
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
base.h
lsst::afw::math::BoundedField::operator=
BoundedField & operator=(BoundedField &&)=delete
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::math::BoundedField::BoundedField
BoundedField(BoundedField const &)=default
Image.h
lsst::afw::math::BoundedField::operator/
std::shared_ptr< BoundedField > operator/(double scale) const
Definition: BoundedField.h:190
lsst::afw::math::BoundedField::operator==
virtual bool operator==(BoundedField const &rhs) const =0
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
lsst::afw::math::BoundedField::operator<<
friend std::ostream & operator<<(std::ostream &os, BoundedField const &bf)
Definition: BoundedField.h:203
scaleBy
double scaleBy
Definition: BoundedField.cc:76
lsst::afw::math::BoundedField::BoundedField
BoundedField(BoundedField &&)=default
lsst::afw::math::BoundedField::evaluate
double evaluate(double x, double y) const
Evaluate the field at the given point.
Definition: BoundedField.h:75
Point.h
std::ostream
STL class.
lsst::afw::math::BoundedField::BoundedField
BoundedField(lsst::geom::Box2I const &bbox)
Definition: BoundedField.h:208
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::afw::math::BoundedField::~BoundedField
~BoundedField() override=default
lsst::afw::math::BoundedField::mean
virtual double mean() const
Compute the mean of this function over its bounding-box.
Definition: BoundedField.cc:51
lsst::afw::math::BoundedField::divideImage
void divideImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Divide an image by the field in-place.
Definition: BoundedField.cc:275
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::math::BoundedField::evaluate
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.
lsst::afw::math::BoundedField::getBBox
lsst::geom::Box2I getBBox() const
Return the bounding box that defines the region where the field is valid.
Definition: BoundedField.h:112
lsst::afw::math::BoundedField::addToImage
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.
Definition: BoundedField.cc:264
lsst::afw::table::io::Persistable
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
os
std::ostream * os
Definition: Schema.cc:746
lsst::afw::math::BoundedField::operator*
virtual std::shared_ptr< BoundedField > operator*(double const scale) const =0
Return a scaled BoundedField.
lsst::afw::math::operator*
std::shared_ptr< BoundedField > operator*(double const scale, std::shared_ptr< BoundedField const > bf)
Definition: BoundedField.cc:254
lsst::afw::math::BoundedField::fillImage
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.
Definition: BoundedField.cc:259
lsst::afw::math::BoundedField::operator!=
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
lsst::geom::Point< double, 2 >
lsst::afw::table::io::PersistableFacade
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
lsst::geom::Box2I
An integer coordinate rectangle.
Definition: Box.h:55
lsst::afw.display.ds9.scale
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
lsst::afw::math::BoundedField::operator=
BoundedField & operator=(BoundedField const &)=delete
lsst::afw::image::Image
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
lsst::afw::math::BoundedField::multiplyImage
void multiplyImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Multiply an image by the field in-place.
Definition: BoundedField.cc:270
bbox
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
lsst::afw::math::BoundedField::integrate
virtual double integrate() const
Compute the integral of this function over its bounding-box.
Definition: BoundedField.cc:49