LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
radii.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_radii_h_INCLUDED
26 #define LSST_AFW_GEOM_ELLIPSES_radii_h_INCLUDED
27 
28 /*
29  * Helper classes defining radii for Separable core.
30  *
31  * Note: do not include directly; use the main ellipse header file.
32  */
33 
36 #include <complex>
37 
38 namespace lsst {
39 namespace afw {
40 namespace geom {
41 namespace ellipses {
42 
43 template <typename Ellipticity_, typename Radius_>
44 class Separable;
45 
46 class DeterminantRadius;
47 class TraceRadius;
48 class LogDeterminantRadius;
49 class LogTraceRadius;
50 
58 public:
59  void normalize() {
60  if (_value < 0)
62  "Ellipse radius cannot be negative.");
63  }
64 
65  static std::string getName() { return "DeterminantRadius"; }
66 
67  explicit DeterminantRadius(double value = 1.0) : _value(value) {}
68 
70 
73  ~DeterminantRadius() = default;
74 
75  operator double const &() const { return _value; }
76 
77  operator double &() { return _value; }
78 
79  DeterminantRadius &operator=(double value) {
80  _value = value;
81  return *this;
82  }
83 
87 
92 
93 private:
94  template <typename T1, typename T2>
95  friend class Separable;
96 
97  void assignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
98 
99  BaseCore::Jacobian dAssignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
100 
101  void assignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy, double &ixy) const;
102 
103  BaseCore::Jacobian dAssignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy,
104  double &ixy) const;
105 
106  double _value;
107 };
108 
115 public:
116  void normalize() {
117  if (_value < 0)
119  "Ellipse radius cannot be negative.");
120  }
121 
122  static std::string getName() { return "TraceRadius"; }
123 
124  explicit TraceRadius(double value = 1.0) : _value(value) {}
125 
126  explicit TraceRadius(LogTraceRadius const &other);
127 
128  TraceRadius(TraceRadius const &) = default;
129  TraceRadius(TraceRadius &&) = default;
130  ~TraceRadius() = default;
131 
132  operator double const &() const { return _value; }
133 
134  operator double &() { return _value; }
135 
136  TraceRadius &operator=(double value) {
137  _value = value;
138  return *this;
139  }
140 
142  TraceRadius &operator=(TraceRadius const &) = default;
144 
149 
150 private:
151  template <typename T1, typename T2>
152  friend class Separable;
153 
154  void assignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
155 
156  BaseCore::Jacobian dAssignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
157 
158  void assignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy, double &ixy) const;
159 
160  BaseCore::Jacobian dAssignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy,
161  double &ixy) const;
162 
163  double _value;
164 };
165 
170 public:
171  void normalize() {}
172 
173  static std::string getName() { return "LogDeterminantRadius"; }
174 
175  explicit LogDeterminantRadius(double value = 0.0) : _value(value) {}
176 
178 
182 
183  operator double const &() const { return _value; }
184 
185  operator double &() { return _value; }
186 
188  _value = value;
189  return *this;
190  }
191 
195 
200 
201 private:
202  template <typename T1, typename T2>
203  friend class Separable;
204 
205  void assignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
206 
207  BaseCore::Jacobian dAssignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
208 
209  void assignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy, double &ixy) const;
210 
211  BaseCore::Jacobian dAssignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy,
212  double &ixy) const;
213 
214  double _value;
215 };
216 
221 public:
222  void normalize() {}
223 
224  static std::string getName() { return "LogTraceRadius"; }
225 
226  explicit LogTraceRadius(double value = 0.0) : _value(value) {}
227 
228  explicit LogTraceRadius(TraceRadius const &other);
229 
230  LogTraceRadius(LogTraceRadius const &) = default;
232  ~LogTraceRadius() = default;
233 
234  operator double const &() const { return _value; }
235 
236  operator double &() { return _value; }
237 
238  LogTraceRadius &operator=(double value) {
239  _value = value;
240  return *this;
241  }
242 
243  LogTraceRadius &operator=(TraceRadius const &value);
246 
251 
252 private:
253  template <typename T1, typename T2>
254  friend class Separable;
255 
256  void assignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
257 
258  BaseCore::Jacobian dAssignFromQuadrupole(double ixx, double iyy, double ixy, Distortion &distortion);
259 
260  void assignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy, double &ixy) const;
261 
262  BaseCore::Jacobian dAssignToQuadrupole(Distortion const &distortion, double &ixx, double &iyy,
263  double &ixy) const;
264 
265  double _value;
266 };
267 
269 inline TraceRadius::TraceRadius(LogTraceRadius const &other) : _value(std::exp(other)) {}
272 
274  _value = std::exp(other);
275  return *this;
276 }
277 
279  _value = std::exp(other);
280  return *this;
281 }
282 
284  _value = std::log(other);
285  return *this;
286 }
287 
289  _value = std::log(other);
290  return *this;
291 }
292 } // namespace ellipses
293 } // namespace geom
294 } // namespace afw
295 } // namespace lsst
296 
297 #endif // !LSST_AFW_GEOM_ELLIPSES_radii_h_INCLUDED
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
ItemVariant const * other
Definition: Schema.cc:56
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64
The radius defined as the 4th root of the determinant of the quadrupole matrix.
Definition: radii.h:57
DeterminantRadius(DeterminantRadius &&)=default
DeterminantRadius & operator=(double value)
Definition: radii.h:79
DeterminantRadius & operator=(TraceRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
DeterminantRadius(DeterminantRadius const &)=default
DeterminantRadius & operator=(LogTraceRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
DeterminantRadius & operator=(DeterminantRadius &&)=default
DeterminantRadius & operator=(DeterminantRadius const &)=default
A complex ellipticity with magnitude .
Definition: Distortion.h:44
The natural logarithm of the DeterminantRadius.
Definition: radii.h:169
LogDeterminantRadius & operator=(LogTraceRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
LogDeterminantRadius & operator=(LogDeterminantRadius &&)=default
LogDeterminantRadius(LogDeterminantRadius &&)=default
LogDeterminantRadius & operator=(LogDeterminantRadius const &)=default
LogDeterminantRadius & operator=(double value)
Definition: radii.h:187
LogDeterminantRadius & operator=(TraceRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
LogDeterminantRadius(LogDeterminantRadius const &)=default
The natural logarithm of the TraceRadius.
Definition: radii.h:220
LogTraceRadius(LogTraceRadius &&)=default
LogTraceRadius(LogTraceRadius const &)=default
LogTraceRadius & operator=(LogTraceRadius const &)=default
LogTraceRadius & operator=(LogTraceRadius &&)=default
LogTraceRadius & operator=(DeterminantRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
LogTraceRadius & operator=(LogDeterminantRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
LogTraceRadius & operator=(double value)
Definition: radii.h:238
An ellipse core with a complex ellipticity and radius parameterization.
Definition: Separable.h:50
The radius defined as .
Definition: radii.h:114
TraceRadius(TraceRadius const &)=default
TraceRadius & operator=(DeterminantRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
TraceRadius(TraceRadius &&)=default
TraceRadius & operator=(TraceRadius const &)=default
TraceRadius & operator=(TraceRadius &&)=default
static std::string getName()
Definition: radii.h:122
TraceRadius & operator=(double value)
Definition: radii.h:136
TraceRadius & operator=(LogDeterminantRadius const &)=delete
Conversion between trace and determinant radii requires ellipticity.
Reports invalid arguments.
Definition: Runtime.h:66
T exp(T... args)
T log(T... args)
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
A base class for image defects.
STL namespace.