LSSTApplications  20.0.0
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 
72  std::shared_ptr<Separable> clone() const { return std::static_pointer_cast<Separable>(_clone()); }
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 
91 
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
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
lsst::afw::geom::ellipses::BaseCore::Transformer
A temporary-only expression object for ellipse core transformations.
Definition: Transformer.h:49
lsst::afw::geom::ellipses::Separable::ParameterEnum
ParameterEnum
Definition: Separable.h:52
lsst::afw::geom::ellipses::Separable::getE1
double const getE1() const
Definition: Separable.h:57
lsst::afw::geom::ellipses::Separable::clone
std::shared_ptr< Separable > clone() const
Deep copy the ellipse core.
Definition: Separable.h:72
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::geom::ellipses::Separable::getEllipticity
Ellipticity & getEllipticity()
Definition: Separable.h:69
lsst::afw::geom::ellipses::Separable::_assignFromAxes
void _assignFromAxes(double a, double b, double theta) override
Definition: Separable.cc:152
ellipses
lsst::afw::geom::ellipses::Separable::Separable
Separable(BaseCore::Convolution const &convolution)
Converting copy constructor.
Definition: Separable.h:125
lsst::afw::geom::ellipses::Separable::writeParameters
void writeParameters(double *iter) const override
Definition: Separable.cc:57
lsst::afw::geom::ellipses::Separable::getE2
double const getE2() const
Definition: Separable.h:60
lsst::afw::geom::ellipses::Separable::Separable
Separable(BaseCore::Transformer const &transformer)
Converting copy constructor.
Definition: Separable.h:122
lsst::afw::geom::ellipses::Separable::getEllipticity
Ellipticity const & getEllipticity() const
Definition: Separable.h:68
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom::ellipses::Separable::_assignFromQuadrupole
void _assignFromQuadrupole(double ixx, double iyy, double ixy) override
Definition: Separable.cc:135
GridTransform.h
lsst::afw::geom::ellipses::Separable::_dAssignFromAxes
Jacobian _dAssignFromAxes(double a, double b, double theta) override
Definition: Separable.cc:159
lsst::afw::geom::ellipses::Separable::_assignToAxes
void _assignToAxes(double &a, double &b, double &theta) const override
Definition: Separable.cc:119
lsst::afw::geom::ellipses::Separable::setRadius
void setRadius(Radius const &radius)
Definition: Separable.h:66
lsst::afw::geom::ellipses::BaseCore::Transformer::apply
void apply(BaseCore &result) const
Definition: Transformer.cc:41
lsst::afw::geom::ellipses::Separable::E1
@ E1
Definition: Separable.h:52
lsst::afw::geom::ellipses::Separable::Radius
Radius_ Radius
Definition: Separable.h:55
lsst::afw::geom::ellipses::Separable::getRadius
Radius & getRadius()
Definition: Separable.h:64
lsst::afw::geom::ellipses::BaseCore::Registrar
Definition: BaseCore.h:196
lsst::afw::geom::ellipses::Separable::_clone
std::shared_ptr< BaseCore > _clone() const override
Definition: Separable.h:128
lsst::afw::geom::ellipses::Separable::getRadius
Radius const & getRadius() const
Definition: Separable.h:63
lsst::afw::geom::ellipses::Separable::getName
std::string getName() const override
Return a string that identifies this parametrization.
Definition: Separable.cc:39
lsst::afw::geom::ellipses::Separable::setE2
void setE2(double e2)
Definition: Separable.h:61
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::Separable
An ellipse core with a complex ellipticity and radius parameterization.
Definition: radii.h:44
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::geom::ellipses::BaseCore::ParameterVector
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:61
lsst::afw::geom::ellipses::Separable::operator=
Separable & operator=(BaseCore const &other)
Converting assignment.
Definition: Separable.h:93
lsst::afw::geom::ellipses::Separable::RADIUS
@ RADIUS
Definition: Separable.h:52
lsst::afw::geom::ellipses::Separable::operator=
Separable & operator=(Separable const &other)
Standard assignment.
Definition: Separable.cc:64
lsst::afw::geom::ellipses::Separable::readParameters
void readParameters(double const *iter) override
Definition: Separable.cc:50
Transformer.h
lsst::afw::geom::ellipses::Separable::~Separable
~Separable() override=default
lsst::afw::geom::ellipses.Separable
dictionary Separable
Definition: __init__.py:27
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::ellipses::Separable::Ellipticity
Ellipticity_ Ellipticity
Definition: Separable.h:54
lsst::afw::geom::ellipses::BaseCore::Convolution::apply
void apply(BaseCore &result) const
Definition: Convolution.cc:50
lsst::geom
Definition: geomOperators.dox:4
lsst.pipe.tasks.insertFakes.radius
radius
Definition: insertFakes.py:288
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
lsst::afw::geom::ellipses::Separable::Separable
Separable(Separable const &other)
Copy constructor.
Definition: Separable.h:111
lsst::afw::geom::ellipses::Separable::_dAssignFromQuadrupole
Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override
Definition: Separable.cc:142
lsst::afw::geom::ellipses::Separable::_assignToQuadrupole
void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Definition: Separable.cc:103
lsst::afw::geom::ellipses::Separable::Separable
Separable(double e1=0.0, double e2=0.0, double radius=Radius(), bool normalize=true)
Construct from parameter values.
Definition: Separable.cc:78
std::complex< double >
lsst::afw::geom::ellipses::Separable::_dAssignToQuadrupole
Jacobian _dAssignToQuadrupole(double &ixx, double &iyy, double &ixy) const override
Definition: Separable.cc:109
lsst::afw::geom::ellipses::Separable::Separable
Separable(BaseCore const &other)
Converting copy constructor.
Definition: Separable.h:119
lsst::afw::geom::ellipses::Separable::E2
@ E2
Definition: Separable.h:52
lsst::afw::geom::ellipses::BaseCore::operator=
BaseCore & operator=(BaseCore const &other)
Set the parameters of this ellipse core from another.
Definition: BaseCore.cc:156
astshim.fitsChanContinued.iter
def iter(self)
Definition: fitsChanContinued.py:88
BaseCore.h
Convolution.h
lsst::afw::geom::ellipses::Separable::Separable
Separable(Separable &&other)
Definition: Separable.h:114
lsst::afw::geom::ellipses::Separable::setE1
void setE1(double e1)
Definition: Separable.h:58
lsst::afw::geom::ellipses::BaseCore::Convolution
A temporary-only expression object for ellipse core convolution.
Definition: Convolution.h:46
lsst::afw::geom::ellipses::Separable::setRadius
void setRadius(double radius)
Definition: Separable.h:65
lsst::afw::geom::ellipses::Separable::_dAssignToAxes
Jacobian _dAssignToAxes(double &a, double &b, double &theta) const override
Definition: Separable.cc:126
lsst::afw::geom::ellipses::Separable::normalize
void normalize() override
Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normaliz...
Definition: Separable.cc:44