Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+9666464c73,g0fba68d861+079660c10e,g1fd858c14a+94f68680cf,g208c678f98+627fe8cd4e,g271391ec13+ac98094cfc,g2c84ff76c0+12036dbf49,g2c9e612ef2+a92a2e6025,g35bb328faa+fcb1d3bbc8,g4d2262a081+bcdfaf528c,g4e0f332c67+c58e4b632d,g53246c7159+fcb1d3bbc8,g60b5630c4e+a92a2e6025,g67b6fd64d1+9d1b2ab50a,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+506db7da85,g89139ef638+9d1b2ab50a,g8d6b6b353c+a92a2e6025,g9125e01d80+fcb1d3bbc8,g989de1cb63+9d1b2ab50a,g9f33ca652e+d1749da127,ga2b97cdc51+a92a2e6025,gabe3b4be73+1e0a283bba,gb1101e3267+6ecbd0580e,gb58c049af0+f03b321e39,gb89ab40317+9d1b2ab50a,gb90eeb9370+384e1fc23b,gcf25f946ba+506db7da85,gd315a588df+382ef11c06,gd6cbbdb0b4+75aa4b1db4,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+a095917f21,ge278dab8ac+c61fbefdff,ge410e46f29+9d1b2ab50a,ge82c20c137+e12a08b75a,gf67bdafdda+9d1b2ab50a,gfd5510ef7b+df344d16e5,v29.0.0.rc2
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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"
35
36namespace lsst {
37namespace afw {
38namespace math {
39
57public:
66 virtual double evaluate(lsst::geom::Point2D const& position) const = 0;
67
76 double evaluate(double x, double y) const { return evaluate(lsst::geom::Point2D(x, y)); }
77
88 virtual ndarray::Array<double, 1, 1> evaluate(ndarray::Array<double const, 1> const& x,
89 ndarray::Array<double const, 1> const& y) const;
90
96 virtual double integrate() const;
97
103 virtual double mean() const;
104
113 lsst::geom::Box2I getBBox() const { return _bbox; }
114
129 template <typename T>
130 void fillImage(image::Image<T>& image, bool overlapOnly = false, int xStep = 1, int yStep = 1) const;
131
147 template <typename T>
148 void addToImage(image::Image<T>& image, double scaleBy = 1.0, bool overlapOnly = false, int xStep = 1,
149 int yStep = 1) const;
150
152
166 template <typename T>
167 void multiplyImage(image::Image<T>& image, bool overlapOnly = false, int xStep = 1, int yStep = 1) const;
168
169 template <typename T>
170 void multiplyImage(image::MaskedImage<T>& image, bool overlapOnly = false) const;
172
174
188 template <typename T>
189 void divideImage(image::Image<T>& image, bool overlapOnly = false, int xStep = 1, int yStep = 1) const;
190
191 template <typename T>
192 void divideImage(image::MaskedImage<T>& image, bool overlapOnly = false) const;
194
200 virtual std::shared_ptr<BoundedField> operator*(double const scale) const = 0;
201 std::shared_ptr<BoundedField> operator/(double scale) const { return (*this) * (1.0 / scale); }
202
204 virtual bool operator==(BoundedField const& rhs) const = 0;
206 bool operator!=(BoundedField const& rhs) const { return !(*this == rhs); };
207
208 ~BoundedField() override = default;
209 BoundedField(BoundedField const&) = default;
213
215 return os << bf.toString() << " on " << bf.getBBox();
216 }
217
218protected:
219 explicit BoundedField(lsst::geom::Box2I const& bbox) : _bbox(bbox) {}
220
221private:
222 lsst::geom::Box2I const _bbox;
223
224 // String form of the mathematical component (not including the bbox)
225 virtual std::string toString() const = 0;
226};
227
229} // namespace math
230} // namespace afw
231} // namespace lsst
232
233#endif // !LSST_AFW_MATH_BoundedField_h_INCLUDED
Basic LSST definitions.
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
virtual bool operator==(BoundedField const &rhs) const =0
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
lsst::geom::Box2I getBBox() const
Return the bounding box that defines the region where the field is valid.
bool operator!=(BoundedField const &rhs) const
BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.
virtual double integrate() const
Compute the integral of this function over its bounding-box.
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.
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(BoundedField const &)=default
virtual std::string toString() const =0
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.
void multiplyImage(image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
Multiply an image by the field in-place.
BoundedField(lsst::geom::Box2I const &bbox)
friend std::ostream & operator<<(std::ostream &os, BoundedField const &bf)
BoundedField & operator=(BoundedField const &)=delete
BoundedField(BoundedField &&)=default
virtual std::shared_ptr< BoundedField > operator*(double const scale) const =0
Return a scaled BoundedField.
std::shared_ptr< BoundedField > operator/(double scale) const
BoundedField & operator=(BoundedField &&)=delete
double evaluate(double x, double y) const
Evaluate the field at the given point.
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.
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
std::shared_ptr< BoundedField > operator*(double const scale, std::shared_ptr< BoundedField const > bf)
Point< double, 2 > Point2D
Definition Point.h:324