LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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  typedef Eigen::Matrix<double, 2, 2, Eigen::DontAlign> Matrix;
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 
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 
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
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
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
void _assignToAxes(double &a, double &b, double &theta) const override
Definition: Quadrupole.cc:91
Matrix const & getMatrix() const
Return a 2x2 symmetric matrix of the parameters.
Definition: Quadrupole.h:80
Quadrupole(double ixx=1.0, double iyy=1.0, double ixy=0.0, bool normalize=false)
Construct from parameter values.
Definition: Quadrupole.cc:60
A temporary-only expression object for ellipse core transformations.
Definition: Transformer.h:49
Jacobian _dAssignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Definition: Quadrupole.cc:84
Quadrupole & operator=(Quadrupole const &other)
Standard assignment.
Definition: Quadrupole.h:86
table::Key< int > b
table::Key< int > a
Jacobian _dAssignFromAxes(double a, double b, double theta) override
Definition: Quadrupole.cc:117
Quadrupole(Quadrupole const &other)
Copy constructor.
Definition: Quadrupole.h:110
Quadrupole & operator=(BaseCore const &other)
Converting assignment.
Definition: Quadrupole.h:95
void readParameters(double const *iter) override
Definition: Quadrupole.cc:48
Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override
Definition: Quadrupole.cc:105
STL class.
void normalize() override
Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normaliz...
Definition: Quadrupole.cc:36
Quadrupole(BaseCore::Convolution const &convolution)
Converting copy constructor.
Definition: Quadrupole.h:124
BaseCore & operator=(BaseCore const &other)
Set the parameters of this ellipse core from another.
Definition: BaseCore.cc:156
A base class for image defects.
std::shared_ptr< BaseCore > _clone() const override
Definition: Quadrupole.h:127
Quadrupole & operator=(Quadrupole &&other)
Definition: Quadrupole.h:92
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:61
std::string getName() const override
Return a string that identifies this parametrization.
Definition: Quadrupole.cc:34
Eigen::Matrix< double, 2, 2, Eigen::DontAlign > Matrix
Matrix type for the matrix representation of Quadrupole parameters.
Definition: Quadrupole.h:52
T static_pointer_cast(T... args)
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64
Jacobian _dAssignToAxes(double &a, double &b, double &theta) const override
Definition: Quadrupole.cc:95
Quadrupole(BaseCore::Transformer const &transformer)
Converting copy constructor.
Definition: Quadrupole.h:121
void writeParameters(double *iter) const override
Definition: Quadrupole.cc:54
A base class for parametrizations of the "core" of an ellipse - the ellipticity and size...
Definition: BaseCore.h:55
void _assignFromQuadrupole(double ixx, double iyy, double ixy) override
Definition: Quadrupole.cc:99
ItemVariant const * other
Definition: Schema.cc:56
Quadrupole(BaseCore const &other)
Converting copy constructor.
Definition: Quadrupole.h:118
double getDeterminant() const
Return the determinant of the matrix representation.
Definition: Quadrupole.h:83
std::shared_ptr< Quadrupole > clone() const
Deep copy the ellipse core.
Definition: Quadrupole.h:64
A temporary-only expression object for ellipse core convolution.
Definition: Convolution.h:46
void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Definition: Quadrupole.cc:78
void _assignFromAxes(double a, double b, double theta) override
Definition: Quadrupole.cc:112