LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Convolution.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 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_GEOM_ELLIPSES_Convolution_h_INCLUDED
26 #define LSST_AFW_GEOM_ELLIPSES_Convolution_h_INCLUDED
27 
28 /*
29  * Definitions for BaseEllipse::Convolution and BaseCore::Convolution.
30  *
31  * Note: do not include directly; use the main ellipse header file.
32  */
33 
34 #include <boost/tuple/tuple.hpp>
35 
37 
38 namespace lsst {
39 namespace afw {
40 namespace geom {
41 namespace ellipses {
42 
46 class BaseCore::Convolution final {
47 public:
49  typedef Eigen::Matrix3d DerivativeMatrix;
50 
53 
56 
58  void inPlace();
59 
61  DerivativeMatrix d() const;
62 
63  void apply(BaseCore &result) const;
64 
65  BaseCore &self;
66  BaseCore const &other;
67 };
68 
72 class Ellipse::Convolution final {
73 public:
75  typedef Eigen::Matrix<double, 5, 5> DerivativeMatrix;
76 
79 
82 
84  void inPlace();
85 
87  DerivativeMatrix d() const;
88 
89  Ellipse &self;
90  Ellipse const &other;
91 };
92 
94  return BaseCore::Convolution(*this, other);
95 }
96 
98  return BaseCore::Convolution(const_cast<BaseCore &>(*this), other);
99 }
100 
101 inline Ellipse::Convolution Ellipse::convolve(Ellipse const &other) {
102  return Ellipse::Convolution(*this, other);
103 }
104 
105 inline Ellipse::Convolution const Ellipse::convolve(Ellipse const &other) const {
106  return Ellipse::Convolution(const_cast<Ellipse &>(*this), other);
107 }
108 } // namespace ellipses
109 } // namespace geom
110 } // namespace afw
111 } // namespace lsst
112 
113 #endif // !LSST_AFW_GEOM_ELLIPSES_Convolution_h_INCLUDED
lsst::afw::geom::ellipses::Ellipse::convolve
Convolution convolve(Ellipse const &other)
Return the transform that maps the ellipse to the unit circle.
Definition: Convolution.h:101
std::shared_ptr
STL class.
ellipses
lsst::afw::geom::ellipses::BaseCore::Convolution::self
BaseCore & self
Definition: Convolution.h:65
ellipses::Ellipse::Convolution
A temporary-only expression object for ellipse convolution.
Definition: Convolution.h:72
ellipses::Ellipse::Convolution::d
DerivativeMatrix d() const
Return the derivative of convolved ellipse with respect to self.
Definition: Convolution.cc:69
lsst::afw
Definition: imageAlgorithm.dox:1
ellipses::Ellipse::Convolution::inPlace
void inPlace()
Convolve the ellipse in-place.
Definition: Convolution.cc:64
ellipses::Ellipse::Convolution::copy
std::shared_ptr< Ellipse > copy() const
Return a new convolved ellipse.
Definition: Convolution.cc:58
lsst::afw::geom::ellipses::BaseCore::Convolution::DerivativeMatrix
Eigen::Matrix3d DerivativeMatrix
Matrix type for derivative with respect to input ellipse parameters.
Definition: Convolution.h:49
lsst::afw::geom::ellipses::BaseCore::Convolution::d
DerivativeMatrix d() const
Return the derivative of convolved core with respect to self.
Definition: Convolution.cc:40
lsst::afw::geom::ellipses::BaseCore
A base class for parametrizations of the "core" of an ellipse - the ellipticity and size.
Definition: BaseCore.h:55
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::geom::ellipses::BaseCore::convolve
Convolution convolve(BaseCore const &other)
Return the size of the bounding box for the ellipse core.
Definition: Convolution.h:93
ellipses::Ellipse::Convolution::DerivativeMatrix
Eigen::Matrix< double, 5, 5 > DerivativeMatrix
Matrix type for derivative with respect to input ellipse parameters.
Definition: Convolution.h:75
lsst::afw::geom::ellipses::BaseCore::Convolution::inPlace
void inPlace()
Convolve the ellipse core in-place.
Definition: Convolution.cc:38
result
py::object result
Definition: _schema.cc:429
Ellipse.h
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::afw::geom::ellipses::BaseCore::Convolution::apply
void apply(BaseCore &result) const
Definition: Convolution.cc:50
lsst::geom
Definition: geomOperators.dox:4
ellipses::Ellipse::Convolution::other
Ellipse const & other
Definition: Convolution.h:90
lsst::afw::geom::ellipses::BaseCore::Convolution::other
BaseCore const & other
Definition: Convolution.h:66
lsst::afw::geom::ellipses::BaseCore::Convolution::Convolution
Convolution(BaseCore &self, BaseCore const &other)
Standard constructor.
Definition: Convolution.h:52
lsst::afw::geom::ellipses::BaseCore::Convolution::copy
std::shared_ptr< BaseCore > copy() const
Return a new convolved ellipse core.
Definition: Convolution.cc:32
ellipses::Ellipse::Convolution::Convolution
Convolution(Ellipse &self, Ellipse const &other)
Standard constructor.
Definition: Convolution.h:78
ellipses::Ellipse::Convolution::self
Ellipse & self
Definition: Convolution.h:89
lsst::afw::geom::ellipses::BaseCore::Convolution
A temporary-only expression object for ellipse core convolution.
Definition: Convolution.h:46
lsst::afw::geom::ellipses::Ellipse::Ellipse
Ellipse(BaseCore const &core, lsst::geom::Point2D const &center=lsst::geom::Point2D())
Return the transform that maps the ellipse to the unit circle.
Definition: Ellipse.h:164