LSSTApplications  20.0.0
LSSTDataManagementBasePackage
GridTransform.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_GridTransform_h_INCLUDED
26 #define LSST_AFW_GEOM_ELLIPSES_GridTransform_h_INCLUDED
27 
28 /*
29  * Definitions for Ellipse::GridTransform and BaseCore::GridTransform.
30  *
31  * Note: do not include directly; use the main ellipse header file.
32  */
33 
34 #include "Eigen/Eigenvalues"
35 
38 
39 namespace lsst {
40 namespace afw {
41 namespace geom {
42 namespace ellipses {
43 
49 public:
51  typedef Eigen::Matrix<double, 4, 3> DerivativeMatrix;
52 
54  explicit GridTransform(BaseCore const& input);
55 
57  operator lsst::geom::LinearTransform() const;
58 
61 
63  DerivativeMatrix d() const;
64 
66  double getDeterminant() const;
67 
69 
75  [[deprecated("Use `inverted` instead. To be removed after 20.0.0.")]] // DM-22814
77  invert() const {
78  return inverted();
79  };
81 
82 private:
83  BaseCore const& _input;
84  Eigen::SelfAdjointEigenSolver<Eigen::Matrix2d> _eig;
85 };
86 
92 public:
94  typedef Eigen::Matrix<double, 6, 5> DerivativeMatrix;
95 
97  explicit GridTransform(Ellipse const& input);
98 
101 
103  DerivativeMatrix d() const;
104 
106  double getDeterminant() const;
107 
109  operator lsst::geom::AffineTransform() const;
110 
114 
115 private:
116  Ellipse const& _input;
117  BaseCore::GridTransform _coreGt;
118 };
119 
121  return BaseCore::GridTransform(*this);
122 }
123 
125  return Ellipse::GridTransform(*this);
126 }
127 } // namespace ellipses
128 } // namespace geom
129 } // namespace afw
130 } // namespace lsst
131 
132 #endif // !LSST_AFW_GEOM_ELLIPSES_GridTransform_h_INCLUDED
ellipses
lsst::afw::geom::ellipses::Ellipse::GridTransform::inverted
lsst::geom::AffineTransform inverted() const
Return the inverse of the AffineTransform.
Definition: GridTransform.cc:142
lsst::geom::LinearTransform
A 2D linear coordinate transformation.
Definition: LinearTransform.h:69
lsst::afw::geom::ellipses::Ellipse::GridTransform::getMatrix
lsst::geom::AffineTransform::Matrix getMatrix() const
Return the transform matrix as an Eigen object.
Definition: GridTransform.cc:102
AffineTransform.h
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom::ellipses::BaseCore::GridTransform::GridTransform
GridTransform(BaseCore const &input)
Standard constructor.
Definition: GridTransform.cc:35
lsst::afw::geom::ellipses::Ellipse::GridTransform::GridTransform
GridTransform(Ellipse const &input)
Standard constructor.
Definition: GridTransform.cc:100
lsst::afw::geom::ellipses::Ellipse::GridTransform::d
DerivativeMatrix d() const
Return the derivative of transform with respect to input ellipse.
Definition: GridTransform.cc:110
lsst::afw::geom::ellipses::BaseCore::GridTransform::invert
lsst::geom::LinearTransform invert() const
Definition: GridTransform.h:77
lsst::geom::AffineTransform
An affine coordinate transformation consisting of a linear transformation and an offset.
Definition: AffineTransform.h:75
lsst::afw::geom::ellipses::Ellipse::GridTransform::DerivativeMatrix
Eigen::Matrix< double, 6, 5 > DerivativeMatrix
Matrix type for derivative with respect to input ellipse parameters.
Definition: GridTransform.h:94
lsst::geom::AffineTransform::Matrix
Eigen::Matrix3d Matrix
Definition: AffineTransform.h:79
lsst::afw::geom::ellipses::BaseCore::GridTransform::getDeterminant
double getDeterminant() const
Return the determinant of the lsst::geom::LinearTransform.
Definition: GridTransform.cc:94
lsst::afw::geom::ellipses::BaseCore
A base class for parametrizations of the "core" of an ellipse - the ellipticity and size.
Definition: BaseCore.h:55
lsst::afw::geom::ellipses::Ellipse::GridTransform::getDeterminant
double getDeterminant() const
Return the determinant of the lsst::geom::AffineTransform.
Definition: GridTransform.cc:135
lsst::afw::geom::ellipses::Ellipse::GridTransform
A temporary-only expression object representing an lsst::geom::AffineTransform that maps the Ellipse ...
Definition: GridTransform.h:91
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::geom
Definition: geomOperators.dox:4
lsst::afw::geom::ellipses::BaseCore::GridTransform::getMatrix
lsst::geom::LinearTransform::Matrix getMatrix() const
Return the transform matrix as an Eigen object.
Definition: GridTransform.cc:38
lsst::afw::geom::ellipses::BaseCore::GridTransform::d
DerivativeMatrix d() const
Return the derivative of the transform with respect to input core.
Definition: GridTransform.cc:46
lsst::afw::geom::ellipses::BaseCore::GridTransform::DerivativeMatrix
Eigen::Matrix< double, 4, 3 > DerivativeMatrix
Matrix type for derivative with respect to ellipse parameters.
Definition: GridTransform.h:51
lsst::afw::geom::ellipses::BaseCore::GridTransform::inverted
lsst::geom::LinearTransform inverted() const
Return the inverse of the lsst::geom::LinearTransform;.
Definition: GridTransform.cc:96
lsst::geom::LinearTransform::Matrix
Eigen::Matrix< double, 2, 2, Eigen::DontAlign > Matrix
Definition: LinearTransform.h:77
lsst::afw::geom::ellipses::BaseCore::getGridTransform
GridTransform const getGridTransform() const
Return the transform that maps the ellipse to the unit circle.
Definition: GridTransform.h:120
lsst::afw::geom::ellipses::BaseCore::GridTransform
A temporary-only expression object representing an lsst::geom::LinearTransform that maps the ellipse ...
Definition: GridTransform.h:48
lsst::afw::geom::ellipses::Ellipse::getGridTransform
GridTransform const getGridTransform() const
Return the transform that maps the ellipse to the unit circle.
Definition: GridTransform.h:124
lsst::afw::geom::ellipses::Ellipse::GridTransform::invert
lsst::geom::AffineTransform invert() const
Definition: GridTransform.h:113