LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Quadrupole.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_Quadrupole_h_INCLUDED
26 #define LSST_AFW_GEOM_ELLIPSES_Quadrupole_h_INCLUDED
27 
28 /*
29  * Definitions and inlines for Quadrupole.
30  *
31  * Note: do not include directly; use the main ellipse header file.
32  */
33 
38 
39 namespace lsst {
40 namespace afw {
41 namespace geom {
42 namespace ellipses {
43 
47 class Quadrupole : public BaseCore {
48 public:
49  enum ParameterEnum { IXX = 0, IYY = 1, IXY = 2 };
50 
52  using Matrix = Eigen::Matrix<double, 2, 2, Eigen::DontAlign>;
53 
54  double const getIxx() const { return _matrix(0, 0); }
55  void setIxx(double ixx) { _matrix(0, 0) = ixx; }
56 
57  double const getIyy() const { return _matrix(1, 1); }
58  void setIyy(double iyy) { _matrix(1, 1) = iyy; }
59 
60  double const getIxy() const { return _matrix(1, 0); }
61  void setIxy(double ixy) { _matrix(0, 1) = _matrix(1, 0) = ixy; }
62 
64  std::shared_ptr<Quadrupole> clone() const { return std::static_pointer_cast<Quadrupole>(_clone()); }
65 
67  std::string getName() const override;
68 
73  void normalize() override;
74 
75  void readParameters(double const* iter) override;
76 
77  void writeParameters(double* iter) const override;
78 
80  Matrix const& getMatrix() const { return _matrix; }
81 
83  double getDeterminant() const { return getIxx() * getIyy() - getIxy() * getIxy(); }
84 
86  Quadrupole& operator=(Quadrupole const& other) {
87  _matrix = other._matrix;
88  return *this;
89  }
90 
91  // Delegate to copy-assignment for backwards compatibility
92  Quadrupole& operator=(Quadrupole&& other) { return *this = other; }
93 
95  Quadrupole& operator=(BaseCore const& other) {
96  BaseCore::operator=(other);
97  return *this;
98  }
99 
101  explicit Quadrupole(double ixx = 1.0, double iyy = 1.0, double ixy = 0.0, bool normalize = false);
102 
104  explicit Quadrupole(BaseCore::ParameterVector const& vector, bool normalize = false);
105 
107  explicit Quadrupole(Matrix const& matrix, bool normalize = true);
108 
110  Quadrupole(Quadrupole const& other) : _matrix(other._matrix) {}
111 
112  // Delegate to copy-constructor for backwards compatibility
113  Quadrupole(Quadrupole&& other) : Quadrupole(other) {}
114 
115  ~Quadrupole() override = default;
116 
118  Quadrupole(BaseCore const& other) { *this = other; }
119 
121  Quadrupole(BaseCore::Transformer const& transformer) { transformer.apply(*this); }
122 
124  Quadrupole(BaseCore::Convolution const& convolution) { convolution.apply(*this); }
125 
126 protected:
127  std::shared_ptr<BaseCore> _clone() const override { return std::make_shared<Quadrupole>(*this); }
128 
129  void _assignToQuadrupole(double& ixx, double& iyy, double& ixy) const override;
130  void _assignFromQuadrupole(double ixx, double iyy, double ixy) override;
131 
132  void _assignToAxes(double& a, double& b, double& theta) const override;
133  void _assignFromAxes(double a, double b, double theta) override;
134 
135  Jacobian _dAssignToQuadrupole(double& ixx, double& iyy, double& ixy) const override;
136  Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override;
137 
138  Jacobian _dAssignToAxes(double& a, double& b, double& theta) const override;
139  Jacobian _dAssignFromAxes(double a, double b, double theta) override;
140 
141 private:
142  static Registrar<Quadrupole> registrar;
143 
144  Matrix _matrix;
145 };
146 } // namespace ellipses
147 } // namespace geom
148 } // namespace afw
149 } // namespace lsst
150 
151 #endif // !LSST_AFW_GEOM_ELLIPSES_Quadrupole_h_INCLUDED
table::Key< int > b
table::Key< int > a
A temporary-only expression object for ellipse core convolution.
Definition: Convolution.h:44
A temporary-only expression object for ellipse core transformations.
Definition: Transformer.h:49
A base class for parametrizations of the "core" of an ellipse - the ellipticity and size.
Definition: BaseCore.h:55
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:63
BaseCore & operator=(BaseCore const &other)
Set the parameters of this ellipse core from another.
Definition: BaseCore.cc:155
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
Eigen::Matrix< double, 2, 2, Eigen::DontAlign > Matrix
Matrix type for the matrix representation of Quadrupole parameters.
Definition: Quadrupole.h:52
std::shared_ptr< Quadrupole > clone() const
Deep copy the ellipse core.
Definition: Quadrupole.h:64
Quadrupole & operator=(Quadrupole const &other)
Standard assignment.
Definition: Quadrupole.h:86
void _assignToAxes(double &a, double &b, double &theta) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:90
double getDeterminant() const
Return the determinant of the matrix representation.
Definition: Quadrupole.h:83
void normalize() override
Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normaliz...
Definition: Quadrupole.cc:35
Quadrupole(Quadrupole const &other)
Copy constructor.
Definition: Quadrupole.h:110
Quadrupole(BaseCore::Convolution const &convolution)
Converting copy constructor.
Definition: Quadrupole.h:124
Jacobian _dAssignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:83
Quadrupole(double ixx=1.0, double iyy=1.0, double ixy=0.0, bool normalize=false)
Construct from parameter values.
Definition: Quadrupole.cc:59
void _assignFromQuadrupole(double ixx, double iyy, double ixy) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:98
Matrix const & getMatrix() const
Return a 2x2 symmetric matrix of the parameters.
Definition: Quadrupole.h:80
std::string getName() const override
Return a string that identifies this parametrization.
Definition: Quadrupole.cc:33
std::shared_ptr< BaseCore > _clone() const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.h:127
void writeParameters(double *iter) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:53
void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:77
Quadrupole & operator=(Quadrupole &&other)
Definition: Quadrupole.h:92
Jacobian _dAssignToAxes(double &a, double &b, double &theta) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:94
Quadrupole & operator=(BaseCore const &other)
Converting assignment.
Definition: Quadrupole.h:95
Quadrupole(BaseCore const &other)
Converting copy constructor.
Definition: Quadrupole.h:118
Quadrupole(BaseCore::Transformer const &transformer)
Converting copy constructor.
Definition: Quadrupole.h:121
Jacobian _dAssignFromAxes(double a, double b, double theta) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:116
void _assignFromAxes(double a, double b, double theta) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:111
void readParameters(double const *iter) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:47
Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:104
A base class for image defects.