LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
AmpInfoBoxKey bbox
Definition Amplifier.cc:117
double scaleBy
int y
Definition SpanSet.cc:48
Basic LSST definitions.
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
An abstract base class for 2-d functions defined on an integer bounding boxes.
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)