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
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
39namespace lsst {
40namespace afw {
41namespace geom {
42namespace ellipses {
43
47class Quadrupole : public BaseCore {
48public:
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
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) {
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
126protected:
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
141private:
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
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
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
Matrix const & getMatrix() const
Return a 2x2 symmetric matrix of the parameters.
Definition Quadrupole.h:80
Quadrupole(Quadrupole const &other)
Copy constructor.
Definition Quadrupole.h:110
Quadrupole(BaseCore::Convolution const &convolution)
Converting copy constructor.
Definition Quadrupole.h:124
std::shared_ptr< Quadrupole > clone() const
Deep copy the ellipse core.
Definition Quadrupole.h:64
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
std::string getName() const override
Return a string that identifies this parametrization.
Definition Quadrupole.cc:33
Quadrupole & operator=(BaseCore const &other)
Converting assignment.
Definition Quadrupole.h:95
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
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(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.
void _assignFromAxes(double a, double b, double theta) override
Return the size of the bounding box for the ellipse core.
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.
Quadrupole & operator=(Quadrupole &&other)
Definition Quadrupole.h:92
std::shared_ptr< BaseCore > _clone() const override
Return the size of the bounding box for the ellipse core.
Definition Quadrupole.h:127