LSSTApplications  20.0.0
LSSTDataManagementBasePackage
MultiShapeletFunction.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010, 2011 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_SHAPELETS_MULTISHAPELETFUNCTION_H
26 #define LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H
27 
29 #include <vector>
30 
31 namespace lsst { namespace shapelet {
32 
33 class MultiShapeletFunctionEvaluator;
34 
39 public:
40 
43 
45 
47 
49 
50  ComponentList & getComponents() { return _components; }
51 
52  ComponentList const & getComponents() const { return _components; }
53 
55  void normalize(double value=1.0);
56 
58  void shiftInPlace(geom::Extent2D const & offset);
59 
62 
65 
68 
70  Evaluator evaluate() const;
71 
72  MultiShapeletFunction() : _components() {}
73 
75 
76  explicit MultiShapeletFunction(ComponentList const & components) : _components(components) {}
77 
78  explicit MultiShapeletFunction(ShapeletFunction const & component) : _components(1, component) {}
79 
80 private:
81  ComponentList _components;
82 };
83 
94 public:
95 
98 
100  double operator()(double x, double y) const {
101  return this->operator()(geom::Point2D(x, y));
102  }
103 
105  double operator()(geom::Point2D const & point) const;
106 
108  double operator()(geom::Extent2D const & point) const;
109 
111  ndarray::Array<double,1,1> operator()(
112  ndarray::Array<double const,1> const & x,
113  ndarray::Array<double const,1> const & y
114  ) const;
115 
118  ndarray::Array<double,2,1> const & array,
119  geom::Point2I const & xy0 = geom::Point2I()
120  ) const;
121 
124  addToImage(image.getArray(), image.getXY0());
125  }
126 
128  double integrate() const;
129 
132 
134  void update(MultiShapeletFunction const & function);
135 
138 
139 private:
142  ComponentList _components;
143 };
144 
146  return MultiShapeletFunctionEvaluator(*this);
147 }
148 
149 }} // namespace lsst::shapelet
150 
151 #endif // !defined(LSST_AFW_MATH_SHAPELETS_MULTISHAPELETFUNCTION_H)
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
lsst::shapelet::MultiShapeletFunctionEvaluator::operator()
double operator()(geom::Point2D const &point) const
Evaluate at the given point.
std::shared_ptr
STL class.
lsst::shapelet::MultiShapeletFunctionEvaluator::operator()
double operator()(double x, double y) const
Evaluate at the given point.
Definition: MultiShapeletFunction.h:100
std::list< Component >
lsst::shapelet::MultiShapeletFunction::ComponentList
std::vector< Component > ComponentList
Definition: MultiShapeletFunction.h:48
std::vector< Component >
lsst::shapelet::MultiShapeletFunction::getComponents
ComponentList & getComponents()
Definition: MultiShapeletFunction.h:50
lsst::shapelet::MultiShapeletFunctionEvaluator
Evaluates a MultiShapeletFunction.
Definition: MultiShapeletFunction.h:93
lsst::shapelet::MultiShapeletFunction::normalize
void normalize(double value=1.0)
Normalize the integral of the shapelet function to the given value.
lsst::shapelet::MultiShapeletFunctionEvaluator::ConstPtr
std::shared_ptr< MultiShapeletFunctionEvaluator const > ConstPtr
Definition: MultiShapeletFunction.h:97
ShapeletFunction.h
lsst::shapelet::MultiShapeletFunctionEvaluator::operator()
ndarray::Array< double, 1, 1 > operator()(ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const
Evaluate at the given points, returning a newly-allocated array.
lsst::shapelet::MultiShapeletFunction::Component
ShapeletFunction Component
Definition: MultiShapeletFunction.h:46
lsst::geom::AffineTransform
An affine coordinate transformation consisting of a linear transformation and an offset.
Definition: AffineTransform.h:75
lsst::shapelet::MultiShapeletFunctionEvaluator::integrate
double integrate() const
Compute the definite integral or integral moments.
lsst::shapelet::ShapeletFunction
A 2-d function defined by an expansion onto a Gauss-Laguerre or Gauss-Hermite basis.
Definition: ShapeletFunction.h:65
lsst::shapelet::MultiShapeletFunctionEvaluator::update
void update(MultiShapeletFunction const &function)
Update the evaluator from the given function.
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::shapelet::MultiShapeletFunction::convolve
MultiShapeletFunction convolve(ShapeletFunction const &other) const
Convolve the multi-shapelet function.
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::shapelet::MultiShapeletFunction::Ptr
std::shared_ptr< MultiShapeletFunction > Ptr
Definition: MultiShapeletFunction.h:41
lsst::shapelet::MultiShapeletFunctionEvaluator::addToImage
void addToImage(ndarray::Array< double, 2, 1 > const &array, geom::Point2I const &xy0=geom::Point2I()) const
Add the function to the given image-like array.
lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction
MultiShapeletFunction(ComponentList const &components)
Definition: MultiShapeletFunction.h:76
lsst::shapelet::MultiShapeletFunctionEvaluator::MultiShapeletFunctionEvaluator
MultiShapeletFunctionEvaluator(MultiShapeletFunction const &function)
Construct an evaluator for the given function.
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::ellipses::Ellipse
An ellipse defined by an arbitrary BaseCore and a center point.
Definition: Ellipse.h:51
lsst::shapelet::MultiShapeletFunction::Evaluator
MultiShapeletFunctionEvaluator Evaluator
Definition: MultiShapeletFunction.h:44
lsst::shapelet::MultiShapeletFunction::getComponents
ComponentList const & getComponents() const
Definition: MultiShapeletFunction.h:52
lsst::shapelet::MultiShapeletFunction::convolve
MultiShapeletFunction convolve(MultiShapeletFunction const &other) const
Convolve the multi-shapelet function.
lsst::geom::Point< double, 2 >
lsst::shapelet::MultiShapeletFunctionEvaluator::operator()
double operator()(geom::Extent2D const &point) const
Evaluate at the given point.
lsst::shapelet::MultiShapeletFunction::ConstPtr
std::shared_ptr< MultiShapeletFunction const > ConstPtr
Definition: MultiShapeletFunction.h:42
lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction
MultiShapeletFunction(ShapeletFunction const &component)
Definition: MultiShapeletFunction.h:78
lsst::shapelet::MultiShapeletFunction::transformInPlace
void transformInPlace(geom::AffineTransform const &transform)
Transform the shapelet function by transforming the ellipse of each component.
transform
table::Key< int > transform
Definition: TransformMap.cc:299
lsst::shapelet::MultiShapeletFunction::shiftInPlace
void shiftInPlace(geom::Extent2D const &offset)
Shift the shapelet function by shifting the ellipse of each component.
lsst::shapelet::MultiShapeletFunction::evaluate
Evaluator evaluate() const
Construct a helper object that can efficiently evaluate the function.
Definition: MultiShapeletFunction.h:145
lsst::shapelet::MultiShapeletFunctionEvaluator::computeMoments
afw::geom::ellipses::Ellipse computeMoments() const
Return the unweighted dipole and quadrupole moments of the function as an ellipse.
lsst::shapelet::MultiShapeletFunction
A multi-scale shapelet function.
Definition: MultiShapeletFunction.h:38
lsst::afw::image::Image
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
lsst::shapelet::MultiShapeletFunctionEvaluator::Ptr
std::shared_ptr< MultiShapeletFunctionEvaluator > Ptr
Definition: MultiShapeletFunction.h:96
lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction
MultiShapeletFunction(MultiShapeletFunction const &other)=default
lsst::shapelet::MultiShapeletFunctionEvaluator::addToImage
void addToImage(afw::image::Image< double > &image) const
Evaluate the function on the given image.
Definition: MultiShapeletFunction.h:123
lsst::geom::Extent< double, 2 >
lsst::shapelet::ShapeletFunctionEvaluator
Evaluates a ShapeletFunction.
Definition: ShapeletFunction.h:177
components
table::Key< table::Array< int > > components
Definition: LinearCombinationKernel.cc:301
lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction
MultiShapeletFunction()
Definition: MultiShapeletFunction.h:72