LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Quadrupole.cc
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  */
26 
27 namespace lsst {
28 namespace afw {
29 namespace geom {
30 namespace ellipses {
31 
32 BaseCore::Registrar<Quadrupole> Quadrupole::registrar;
33 
34 std::string Quadrupole::getName() const { return "Quadrupole"; }
35 
37  if (_matrix(0, 1) != _matrix(1, 0))
39  "Quadrupole matrix must be symmetric.");
40  if (getIxx() < 0 || getIyy() < 0)
42  "Quadrupole matrix cannot have negative diagonal elements.");
43  if (getDeterminant() < 0)
45  "Quadrupole matrix cannot have negative determinant.");
46 }
47 
48 void Quadrupole::readParameters(double const* iter) {
49  setIxx(*iter++);
50  setIyy(*iter++);
51  setIxy(*iter++);
52 }
53 
54 void Quadrupole::writeParameters(double* iter) const {
55  *iter++ = getIxx();
56  *iter++ = getIyy();
57  *iter++ = getIxy();
58 }
59 
60 Quadrupole::Quadrupole(double ixx, double iyy, double ixy, bool normalize) {
61  setIxx(ixx);
62  setIyy(iyy);
63  setIxy(ixy);
64  if (normalize) this->normalize();
65 }
66 
67 Quadrupole::Quadrupole(BaseCore::ParameterVector const& vector, bool normalize) {
68  setIxx(vector[IXX]);
69  setIyy(vector[IYY]);
70  setIxy(vector[IXY]);
71  if (normalize) this->normalize();
72 }
73 
74 Quadrupole::Quadrupole(Matrix const& matrix, bool normalize) : _matrix(matrix) {
75  if (normalize) this->normalize();
76 }
77 
78 void Quadrupole::_assignToQuadrupole(double& ixx, double& iyy, double& ixy) const {
79  ixx = getIxx();
80  iyy = getIyy();
81  ixy = getIxy();
82 }
83 
84 BaseCore::Jacobian Quadrupole::_dAssignToQuadrupole(double& ixx, double& iyy, double& ixy) const {
85  ixx = getIxx();
86  iyy = getIyy();
87  ixy = getIxy();
88  return Jacobian::Identity();
89 }
90 
91 void Quadrupole::_assignToAxes(double& a, double& b, double& theta) const {
93 }
94 
95 BaseCore::Jacobian Quadrupole::_dAssignToAxes(double& a, double& b, double& theta) const {
96  return BaseCore::_dAssignQuadrupoleToAxes(getIxx(), getIyy(), getIxy(), a, b, theta);
97 }
98 
99 void Quadrupole::_assignFromQuadrupole(double ixx, double iyy, double ixy) {
100  setIxx(ixx);
101  setIyy(iyy);
102  setIxy(ixy);
103 }
104 
105 BaseCore::Jacobian Quadrupole::_dAssignFromQuadrupole(double ixx, double iyy, double ixy) {
106  setIxx(ixx);
107  setIyy(iyy);
108  setIxy(ixy);
109  return Jacobian::Identity();
110 }
111 
112 void Quadrupole::_assignFromAxes(double a, double b, double theta) {
113  BaseCore::_assignAxesToQuadrupole(a, b, theta, _matrix(0, 0), _matrix(1, 1), _matrix(0, 1));
114  _matrix(1, 0) = _matrix(0, 1);
115 }
116 
117 BaseCore::Jacobian Quadrupole::_dAssignFromAxes(double a, double b, double theta) {
118  Jacobian r = BaseCore::_dAssignAxesToQuadrupole(a, b, theta, _matrix(0, 0), _matrix(1, 1), _matrix(0, 1));
119  _matrix(1, 0) = _matrix(0, 1);
120  return r;
121 }
122 } // namespace ellipses
123 } // namespace geom
124 } // namespace afw
125 } // namespace lsst
lsst::afw::geom::ellipses::Quadrupole::getIxx
double const getIxx() const
Definition: Quadrupole.h:54
lsst::afw::geom::ellipses::Quadrupole::setIxx
void setIxx(double ixx)
Definition: Quadrupole.h:55
lsst::afw::geom::ellipses::Quadrupole::setIyy
void setIyy(double iyy)
Definition: Quadrupole.h:58
std::string
STL class.
ellipses
Axes.h
lsst::afw::geom::ellipses::Quadrupole::_assignFromAxes
void _assignFromAxes(double a, double b, double theta) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:112
lsst::afw::geom::ellipses::BaseCore::_dAssignAxesToQuadrupole
static Jacobian _dAssignAxesToQuadrupole(double a, double b, double theta, double &ixx, double &iyy, double &ixy)
Return the size of the bounding box for the ellipse core.
Definition: BaseCore.cc:232
lsst::afw
Definition: imageAlgorithm.dox:1
Quadrupole.h
lsst::afw::geom::ellipses::Quadrupole::getIxy
double const getIxy() const
Definition: Quadrupole.h:60
lsst::afw::geom::ellipses::Quadrupole::Quadrupole
Quadrupole(double ixx=1.0, double iyy=1.0, double ixy=0.0, bool normalize=false)
Construct from parameter values.
Definition: Quadrupole.cc:60
lsst::afw::geom::ellipses::Quadrupole::_dAssignFromAxes
Jacobian _dAssignFromAxes(double a, double b, double theta) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:117
lsst::afw::geom::ellipses::Quadrupole::_assignToQuadrupole
void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:78
lsst::afw::geom::ellipses::Quadrupole::Matrix
Eigen::Matrix< double, 2, 2, Eigen::DontAlign > Matrix
Matrix type for the matrix representation of Quadrupole parameters.
Definition: Quadrupole.h:52
lsst::afw::geom::ellipses::Quadrupole::IXY
@ IXY
Definition: Quadrupole.h:49
lsst::afw::geom::ellipses::BaseCore::_dAssignQuadrupoleToAxes
static Jacobian _dAssignQuadrupoleToAxes(double ixx, double iyy, double ixy, double &a, double &b, double &theta)
Return the size of the bounding box for the ellipse core.
Definition: BaseCore.cc:194
lsst::afw::geom::ellipses::Quadrupole::writeParameters
void writeParameters(double *iter) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:54
lsst::afw::geom::ellipses::Quadrupole::getName
std::string getName() const override
Return a string that identifies this parametrization.
Definition: Quadrupole.cc:34
lsst::afw::geom::ellipses::Quadrupole::setIxy
void setIxy(double ixy)
Definition: Quadrupole.h:61
lsst::afw::geom::ellipses::Quadrupole::getIyy
double const getIyy() const
Definition: Quadrupole.h:57
lsst::afw::geom::ellipses::BaseCore::ParameterVector
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:61
lsst::afw::geom::ellipses::Quadrupole::_assignFromQuadrupole
void _assignFromQuadrupole(double ixx, double iyy, double ixy) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:99
lsst::afw::geom::ellipses::Quadrupole::_dAssignToAxes
Jacobian _dAssignToAxes(double &a, double &b, double &theta) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:95
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::afw::geom::ellipses::Quadrupole::IXX
@ IXX
Definition: Quadrupole.h:49
lsst::geom
Definition: geomOperators.dox:4
lsst::afw::geom::ellipses::BaseCore::Jacobian
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64
lsst::afw::geom::ellipses::Quadrupole::_dAssignFromQuadrupole
Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:105
lsst::pex::exceptions::InvalidParameterError
Reports invalid arguments.
Definition: Runtime.h:66
lsst::afw::geom::ellipses::BaseCore::_assignAxesToQuadrupole
static void _assignAxesToQuadrupole(double a, double b, double theta, double &ixx, double &iyy, double &ixy)
Return the size of the bounding box for the ellipse core.
Definition: BaseCore.cc:219
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::afw::geom::ellipses::Quadrupole::getDeterminant
double getDeterminant() const
Return the determinant of the matrix representation.
Definition: Quadrupole.h:83
lsst::afw::geom::ellipses::Quadrupole::normalize
void normalize() override
Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normaliz...
Definition: Quadrupole.cc:36
lsst::afw::geom::ellipses::Quadrupole::readParameters
void readParameters(double const *iter) override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:48
astshim.fitsChanContinued.iter
def iter(self)
Definition: fitsChanContinued.py:88
lsst::afw::geom::ellipses::Quadrupole::_assignToAxes
void _assignToAxes(double &a, double &b, double &theta) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:91
lsst::afw::geom::ellipses::BaseCore::_assignQuadrupoleToAxes
static void _assignQuadrupoleToAxes(double ixx, double iyy, double ixy, double &a, double &b, double &theta)
Return the size of the bounding box for the ellipse core.
Definition: BaseCore.cc:184
lsst::afw::geom::ellipses::Quadrupole::_dAssignToQuadrupole
Jacobian _dAssignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.cc:84
lsst::afw::geom::ellipses::Quadrupole::IYY
@ IYY
Definition: Quadrupole.h:49