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
Separable.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_Separable_h_INCLUDED
26 #define LSST_AFW_GEOM_ELLIPSES_Separable_h_INCLUDED
27 
28 /*
29  * Definitions and inlines for Separable.
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 
49 template <typename Ellipticity_, typename Radius_>
50 class Separable : public BaseCore {
51 public:
52  enum ParameterEnum { E1 = 0, E2 = 1, RADIUS = 2 };
53 
54  typedef Ellipticity_ Ellipticity;
55  typedef Radius_ Radius;
56 
57  double const getE1() const { return _ellipticity.getE1(); }
58  void setE1(double e1) { _ellipticity.setE1(e1); }
59 
60  double const getE2() const { return _ellipticity.getE2(); }
61  void setE2(double e2) { _ellipticity.setE2(e2); }
62 
63  Radius const& getRadius() const { return _radius; }
64  Radius& getRadius() { return _radius; }
65  void setRadius(double radius) { _radius = radius; }
66  void setRadius(Radius const& radius) { _radius = radius; }
67 
68  Ellipticity const& getEllipticity() const { return _ellipticity; }
69  Ellipticity& getEllipticity() { return _ellipticity; }
70 
73 
75  std::string getName() const override;
76 
81  void normalize() override;
82 
83  void readParameters(double const* iter) override;
84 
85  void writeParameters(double* iter) const override;
86 
89 
90  Separable& operator=(Separable&& other);
91 
93  Separable& operator=(BaseCore const& other) {
94  BaseCore::operator=(other);
95  return *this;
96  }
97 
99  explicit Separable(double e1 = 0.0, double e2 = 0.0, double radius = Radius(), bool normalize = true);
100 
102  explicit Separable(std::complex<double> const& complex, double radius = Radius(), bool normalize = true);
103 
105  explicit Separable(Ellipticity const& ellipticity, double radius = Radius(), bool normalize = true);
106 
108  explicit Separable(BaseCore::ParameterVector const& vector, bool normalize = false);
109 
111  Separable(Separable const& other) : _ellipticity(other._ellipticity), _radius(other._radius) {}
112 
113  // Delegate to copy-constructor for backwards compatibility
114  Separable(Separable&& other) : Separable(other) {}
115 
116  ~Separable() override = default;
117 
119  Separable(BaseCore const& other) { *this = other; }
120 
122  Separable(BaseCore::Transformer const& transformer) { transformer.apply(*this); }
123 
125  Separable(BaseCore::Convolution const& convolution) { convolution.apply(*this); }
126 
127 protected:
128  std::shared_ptr<BaseCore> _clone() const override { return std::make_shared<Separable>(*this); }
129 
130  void _assignToQuadrupole(double& ixx, double& iyy, double& ixy) const override;
131  void _assignFromQuadrupole(double ixx, double iyy, double ixy) override;
132 
133  void _assignToAxes(double& a, double& b, double& theta) const override;
134  void _assignFromAxes(double a, double b, double theta) override;
135 
136  Jacobian _dAssignToQuadrupole(double& ixx, double& iyy, double& ixy) const override;
137  Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override;
138 
139  Jacobian _dAssignToAxes(double& a, double& b, double& theta) const override;
140  Jacobian _dAssignFromAxes(double a, double b, double theta) override;
141 
142 private:
143  static BaseCore::Registrar<Separable> registrar;
144 
145  Ellipticity _ellipticity;
146  Radius _radius;
147 };
148 } // namespace ellipses
149 } // namespace geom
150 } // namespace afw
151 } // namespace lsst
152 
153 #endif // !LSST_AFW_GEOM_ELLIPSES_Separable_h_INCLUDED
void _assignFromAxes(double a, double b, double theta) override
Definition: Separable.cc:152
std::shared_ptr< Separable > clone() const
Deep copy the ellipse core.
Definition: Separable.h:72
void setRadius(Radius const &radius)
Definition: Separable.h:66
A temporary-only expression object for ellipse core transformations.
Definition: Transformer.h:49
void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Definition: Separable.cc:103
table::Key< int > b
Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override
Definition: Separable.cc:142
table::Key< int > a
Jacobian _dAssignFromAxes(double a, double b, double theta) override
Definition: Separable.cc:159
Jacobian _dAssignToAxes(double &a, double &b, double &theta) const override
Definition: Separable.cc:126
STL class.
void writeParameters(double *iter) const override
Definition: Separable.cc:57
Jacobian _dAssignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Definition: Separable.cc:109
std::string getName() const override
Return a string that identifies this parametrization.
Definition: Separable.cc:39
void normalize() override
Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normaliz...
Definition: Separable.cc:44
BaseCore & operator=(BaseCore const &other)
Set the parameters of this ellipse core from another.
Definition: BaseCore.cc:156
A base class for image defects.
Separable(double e1=0.0, double e2=0.0, double radius=Radius(), bool normalize=true)
Construct from parameter values.
Definition: Separable.cc:78
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:61
std::shared_ptr< BaseCore > _clone() const override
Definition: Separable.h:128
T static_pointer_cast(T... args)
double const getE1() const
Definition: Separable.h:57
Separable(BaseCore::Convolution const &convolution)
Converting copy constructor.
Definition: Separable.h:125
Separable(BaseCore::Transformer const &transformer)
Converting copy constructor.
Definition: Separable.h:122
An ellipse core with a complex ellipticity and radius parameterization.
Definition: radii.h:44
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64
void readParameters(double const *iter) override
Definition: Separable.cc:50
A base class for parametrizations of the "core" of an ellipse - the ellipticity and size...
Definition: BaseCore.h:55
Separable(Separable const &other)
Copy constructor.
Definition: Separable.h:111
Separable(BaseCore const &other)
Converting copy constructor.
Definition: Separable.h:119
void _assignFromQuadrupole(double ixx, double iyy, double ixy) override
Definition: Separable.cc:135
Separable & operator=(BaseCore const &other)
Converting assignment.
Definition: Separable.h:93
Separable & operator=(Separable const &other)
Standard assignment.
Definition: Separable.cc:64
ItemVariant const * other
Definition: Schema.cc:56
double const getE2() const
Definition: Separable.h:60
Radius const & getRadius() const
Definition: Separable.h:63
void _assignToAxes(double &a, double &b, double &theta) const override
Definition: Separable.cc:119
A temporary-only expression object for ellipse core convolution.
Definition: Convolution.h:46
void setRadius(double radius)
Definition: Separable.h:65
Ellipticity const & getEllipticity() const
Definition: Separable.h:68