Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
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"
34
35namespace lsst {
36namespace afw {
37namespace math {
38
56public:
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
207protected:
208 explicit BoundedField(lsst::geom::Box2I const& bbox) : _bbox(bbox) {}
209
210private:
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
Basic LSST definitions.
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
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
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.
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