LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
lsst::afw::geom::ellipses::Quadrupole Class Reference

An ellipse core with quadrupole moments as parameters. More...

#include <Quadrupole.h>

Inheritance diagram for lsst::afw::geom::ellipses::Quadrupole:
lsst::afw::geom::ellipses::BaseCore

Public Types

enum  ParameterEnum { IXX = 0 , IYY = 1 , IXY = 2 }
 
using Matrix = Eigen::Matrix< double, 2, 2, Eigen::DontAlign >
 Matrix type for the matrix representation of Quadrupole parameters. More...
 
using ParameterVector = Eigen::Vector3d
 Parameter vector type. More...
 
using Jacobian = Eigen::Matrix3d
 Parameter Jacobian matrix type. More...
 

Public Member Functions

double const getIxx () const
 
void setIxx (double ixx)
 
double const getIyy () const
 
void setIyy (double iyy)
 
double const getIxy () const
 
void setIxy (double ixy)
 
std::shared_ptr< Quadrupole > clone () const
 Deep copy the ellipse core. More...
 
std::string getName () const override
 Return a string that identifies this parametrization. More...
 
void normalize () override
 Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normalized. More...
 
void readParameters (double const *iter) override
 Return the size of the bounding box for the ellipse core. More...
 
void writeParameters (double *iter) const override
 Return the size of the bounding box for the ellipse core. More...
 
Matrix const & getMatrix () const
 Return a 2x2 symmetric matrix of the parameters. More...
 
double getDeterminant () const
 Return the determinant of the matrix representation. More...
 
Quadrupole & operator= (Quadrupole const &other)
 Standard assignment. More...
 
Quadrupole & operator= (Quadrupole &&other)
 
Quadrupole & operator= (BaseCore const &other)
 Converting assignment. More...
 
 Quadrupole (double ixx=1.0, double iyy=1.0, double ixy=0.0, bool normalize=false)
 Construct from parameter values. More...
 
 Quadrupole (BaseCore::ParameterVector const &vector, bool normalize=false)
 Construct from a parameter vector. More...
 
 Quadrupole (Matrix const &matrix, bool normalize=true)
 Construct from a 2x2 matrix. More...
 
 Quadrupole (Quadrupole const &other)
 Copy constructor. More...
 
 Quadrupole (Quadrupole &&other)
 
 ~Quadrupole () override=default
 
 Quadrupole (BaseCore const &other)
 Converting copy constructor. More...
 
 Quadrupole (BaseCore::Transformer const &transformer)
 Converting copy constructor. More...
 
 Quadrupole (BaseCore::Convolution const &convolution)
 Converting copy constructor. More...
 
void grow (double buffer)
 Increase the major and minor radii of the ellipse core by the given buffer. More...
 
void scale (double factor)
 Scale the size of the ellipse core by the given factor. More...
 
double getArea () const
 Return the area of the ellipse core. More...
 
double getDeterminantRadius () const
 Return the radius defined as the 4th root of the determinant of the quadrupole matrix. More...
 
double getTraceRadius () const
 Return the radius defined as the square root of one half the trace of the quadrupole matrix. More...
 
Coordinate transforms

These member functions transform the ellipse by the given lsst::geom::LinearTransform.

The transform can be done in-place by calling inPlace() on the returned expression object, or returned as a new shared_ptr by calling copy().

Transformer transform (lsst::geom::LinearTransform const &transform)
 Return the transform that maps the ellipse to the unit circle. More...
 
Transformer const transform (lsst::geom::LinearTransform const &transform) const
 Return the transform that maps the ellipse to the unit circle. More...
 
GridTransform const getGridTransform () const
 Return the transform that maps the ellipse to the unit circle. More...
 

Static Public Member Functions

static std::shared_ptr< BaseCore > make (std::string const &name)
 
static std::shared_ptr< BaseCore > make (std::string const &name, ParameterVector const &parameters)
 
static std::shared_ptr< BaseCore > make (std::string const &name, double v1, double v2, double v3)
 
static std::shared_ptr< BaseCore > make (std::string const &name, BaseCore const &other)
 
static std::shared_ptr< BaseCore > make (std::string const &name, Transformer const &other)
 
static std::shared_ptr< BaseCore > make (std::string const &name, Convolution const &other)
 

Protected Member Functions

std::shared_ptr< BaseCore > _clone () const override
 Return the size of the bounding box for the ellipse core. More...
 
void _assignToQuadrupole (double &ixx, double &iyy, double &ixy) const override
 Return the size of the bounding box for the ellipse core. More...
 
void _assignFromQuadrupole (double ixx, double iyy, double ixy) override
 Return the size of the bounding box for the ellipse core. More...
 
void _assignToAxes (double &a, double &b, double &theta) const override
 Return the size of the bounding box for the ellipse core. More...
 
void _assignFromAxes (double a, double b, double theta) override
 Return the size of the bounding box for the ellipse core. More...
 
Jacobian _dAssignToQuadrupole (double &ixx, double &iyy, double &ixy) const override
 Return the size of the bounding box for the ellipse core. More...
 
Jacobian _dAssignFromQuadrupole (double ixx, double iyy, double ixy) override
 Return the size of the bounding box for the ellipse core. More...
 
Jacobian _dAssignToAxes (double &a, double &b, double &theta) const override
 Return the size of the bounding box for the ellipse core. More...
 
Jacobian _dAssignFromAxes (double a, double b, double theta) override
 Return the size of the bounding box for the ellipse core. More...
 

Convolve two bivariate Gaussians defined by their 1-sigma ellipses.

Convolution convolve (BaseCore const &other)
 Return the size of the bounding box for the ellipse core. More...
 
Convolution const convolve (BaseCore const &other) const
 Return the size of the bounding box for the ellipse core. More...
 
lsst::geom::Extent2D computeDimensions () const
 Return the size of the bounding box for the ellipse core. More...
 
ParameterVector const getParameterVector () const
 Return the core parameters as a vector. More...
 
void setParameterVector (ParameterVector const &vector)
 Set the core parameters from a vector. More...
 
bool operator== (BaseCore const &other) const
 Compare two ellipse cores for equality. More...
 
bool operator!= (BaseCore const &other) const
 Compare two ellipse cores for inequality. More...
 
Jacobian dAssign (BaseCore const &other)
 Assign other to this and return the derivative of the conversion, d(this)/d(other). More...
 
template<typename Output >
Converter< Output > as () const
 Convert this to the core type specified as a template parameter. More...
 
static void registerSubclass (std::shared_ptr< BaseCore > const &example)
 Return the size of the bounding box for the ellipse core. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

Detailed Description

An ellipse core with quadrupole moments as parameters.

Definition at line 47 of file Quadrupole.h.

Member Typedef Documentation

◆ Jacobian

using lsst::afw::geom::ellipses::BaseCore::Jacobian = Eigen::Matrix3d
inherited

Parameter Jacobian matrix type.

Definition at line 64 of file BaseCore.h.

◆ Matrix

using lsst::afw::geom::ellipses::Quadrupole::Matrix = Eigen::Matrix<double, 2, 2, Eigen::DontAlign>

Matrix type for the matrix representation of Quadrupole parameters.

Definition at line 52 of file Quadrupole.h.

◆ ParameterVector

using lsst::afw::geom::ellipses::BaseCore::ParameterVector = Eigen::Vector3d
inherited

Parameter vector type.

Definition at line 63 of file BaseCore.h.

Member Enumeration Documentation

◆ ParameterEnum

enum lsst::afw::geom::ellipses::Quadrupole::ParameterEnum
Enumerator
IXX 
IYY 
IXY 

Definition at line 49 of file Quadrupole.h.

49 { IXX = 0, IYY = 1, IXY = 2 };

Constructor & Destructor Documentation

◆ Quadrupole() [1/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( double  ixx = 1.0,
double  iyy = 1.0,
double  ixy = 0.0,
bool  normalize = false 
)
explicit

Construct from parameter values.

Definition at line 59 of file Quadrupole.cc.

59  {
60  setIxx(ixx);
61  setIyy(iyy);
62  setIxy(ixy);
63  if (normalize) this->normalize();
64 }
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:35

◆ Quadrupole() [2/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( BaseCore::ParameterVector const &  vector,
bool  normalize = false 
)
explicit

Construct from a parameter vector.

Definition at line 66 of file Quadrupole.cc.

66  {
67  setIxx(vector[IXX]);
68  setIyy(vector[IYY]);
69  setIxy(vector[IXY]);
70  if (normalize) this->normalize();
71 }

◆ Quadrupole() [3/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( Matrix const &  matrix,
bool  normalize = true 
)
explicit

Construct from a 2x2 matrix.

Definition at line 73 of file Quadrupole.cc.

73  : _matrix(matrix) {
74  if (normalize) this->normalize();
75 }

◆ Quadrupole() [4/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( Quadrupole const &  other)
inline

Copy constructor.

Definition at line 110 of file Quadrupole.h.

110 : _matrix(other._matrix) {}

◆ Quadrupole() [5/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( Quadrupole &&  other)
inline

Definition at line 113 of file Quadrupole.h.

113 : Quadrupole(other) {}
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:59

◆ ~Quadrupole()

lsst::afw::geom::ellipses::Quadrupole::~Quadrupole ( )
overridedefault

◆ Quadrupole() [6/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( BaseCore const &  other)
inline

Converting copy constructor.

Definition at line 118 of file Quadrupole.h.

118 { *this = other; }

◆ Quadrupole() [7/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( BaseCore::Transformer const &  transformer)
inline

Converting copy constructor.

Definition at line 121 of file Quadrupole.h.

121 { transformer.apply(*this); }

◆ Quadrupole() [8/8]

lsst::afw::geom::ellipses::Quadrupole::Quadrupole ( BaseCore::Convolution const &  convolution)
inline

Converting copy constructor.

Definition at line 124 of file Quadrupole.h.

124 { convolution.apply(*this); }

Member Function Documentation

◆ _assignAxesToQuadrupole()

void lsst::afw::geom::ellipses::BaseCore::_assignAxesToQuadrupole ( double  a,
double  b,
double  theta,
double &  ixx,
double &  iyy,
double &  ixy 
)
staticprotectedinherited

Return the size of the bounding box for the ellipse core.

Definition at line 218 of file BaseCore.cc.

219  {
220  a *= a;
221  b *= b;
222  double c = std::cos(theta);
223  double s = std::sin(theta);
224  ixy = (a - b) * c * s;
225  c *= c;
226  s *= s;
227  ixx = c * a + s * b;
228  iyy = s * a + c * b;
229 }
b
table::Key< int > b
Definition: TransmissionCurve.cc:466
a
table::Key< int > a
Definition: TransmissionCurve.cc:465
std::cos
T cos(T... args)
std::sin
T sin(T... args)

◆ _assignFromAxes()

void lsst::afw::geom::ellipses::Quadrupole::_assignFromAxes ( double  a,
double  b,
double  theta 
)
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 111 of file Quadrupole.cc.

111  {
112  BaseCore::_assignAxesToQuadrupole(a, b, theta, _matrix(0, 0), _matrix(1, 1), _matrix(0, 1));
113  _matrix(1, 0) = _matrix(0, 1);
114 }
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:218

◆ _assignFromQuadrupole()

void lsst::afw::geom::ellipses::Quadrupole::_assignFromQuadrupole ( double  ixx,
double  iyy,
double  ixy 
)
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 98 of file Quadrupole.cc.

98  {
99  setIxx(ixx);
100  setIyy(iyy);
101  setIxy(ixy);
102 }

◆ _assignQuadrupoleToAxes()

void lsst::afw::geom::ellipses::BaseCore::_assignQuadrupoleToAxes ( double  ixx,
double  iyy,
double  ixy,
double &  a,
double &  b,
double &  theta 
)
staticprotectedinherited

Return the size of the bounding box for the ellipse core.

Definition at line 183 of file BaseCore.cc.

184  {
185  double xx_p_yy = ixx + iyy;
186  double xx_m_yy = ixx - iyy;
187  double t = std::sqrt(xx_m_yy * xx_m_yy + 4 * ixy * ixy);
188  a = std::sqrt(0.5 * (xx_p_yy + t));
189  b = std::sqrt(0.5 * (xx_p_yy - t));
190  theta = 0.5 * std::atan2(2.0 * ixy, xx_m_yy);
191 }
std::atan2
T atan2(T... args)
std::sqrt
T sqrt(T... args)

◆ _assignToAxes()

void lsst::afw::geom::ellipses::Quadrupole::_assignToAxes ( double &  a,
double &  b,
double &  theta 
) const
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 90 of file Quadrupole.cc.

90  {
91  BaseCore::_assignQuadrupoleToAxes(getIxx(), getIyy(), getIxy(), a, b, theta);
92 }
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:183

◆ _assignToQuadrupole()

void lsst::afw::geom::ellipses::Quadrupole::_assignToQuadrupole ( double &  ixx,
double &  iyy,
double &  ixy 
) const
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 77 of file Quadrupole.cc.

77  {
78  ixx = getIxx();
79  iyy = getIyy();
80  ixy = getIxy();
81 }

◆ _clone()

std::shared_ptr<BaseCore> lsst::afw::geom::ellipses::Quadrupole::_clone ( ) const
inlineoverrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 127 of file Quadrupole.h.

127 { return std::make_shared<Quadrupole>(*this); }

◆ _dAssignAxesToQuadrupole()

BaseCore::Jacobian lsst::afw::geom::ellipses::BaseCore::_dAssignAxesToQuadrupole ( double  a,
double  b,
double  theta,
double &  ixx,
double &  iyy,
double &  ixy 
)
staticprotectedinherited

Return the size of the bounding box for the ellipse core.

Definition at line 231 of file BaseCore.cc.

232  {
233  Jacobian m;
234  m.col(0).setConstant(2 * a);
235  m.col(1).setConstant(2 * b);
236  a *= a;
237  b *= b;
238  m.col(2).setConstant(a - b);
239  double c = std::cos(theta);
240  double s = std::sin(theta);
241  double cs = c * s;
242  ixy = (a - b) * c * s;
243  c *= c;
244  s *= s;
245  ixx = c * a + s * b;
246  iyy = s * a + c * b;
247  m(0, 0) *= c;
248  m(0, 1) *= s;
249  m(0, 2) *= -2.0 * cs;
250  m(1, 0) *= s;
251  m(1, 1) *= c;
252  m(1, 2) *= 2.0 * cs;
253  m(2, 0) *= cs;
254  m(2, 1) *= -cs;
255  m(2, 2) *= (c - s);
256  return m;
257 }
m
int m
Definition: SpanSet.cc:48
lsst::afw::geom::ellipses::BaseCore::Jacobian
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64

◆ _dAssignFromAxes()

BaseCore::Jacobian lsst::afw::geom::ellipses::Quadrupole::_dAssignFromAxes ( double  a,
double  b,
double  theta 
)
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 116 of file Quadrupole.cc.

116  {
117  Jacobian r = BaseCore::_dAssignAxesToQuadrupole(a, b, theta, _matrix(0, 0), _matrix(1, 1), _matrix(0, 1));
118  _matrix(1, 0) = _matrix(0, 1);
119  return r;
120 }
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:231

◆ _dAssignFromQuadrupole()

BaseCore::Jacobian lsst::afw::geom::ellipses::Quadrupole::_dAssignFromQuadrupole ( double  ixx,
double  iyy,
double  ixy 
)
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 104 of file Quadrupole.cc.

104  {
105  setIxx(ixx);
106  setIyy(iyy);
107  setIxy(ixy);
108  return Jacobian::Identity();
109 }

◆ _dAssignQuadrupoleToAxes()

BaseCore::Jacobian lsst::afw::geom::ellipses::BaseCore::_dAssignQuadrupoleToAxes ( double  ixx,
double  iyy,
double  ixy,
double &  a,
double &  b,
double &  theta 
)
staticprotectedinherited

Return the size of the bounding box for the ellipse core.

Definition at line 193 of file BaseCore.cc.

194  {
195  double xx_p_yy = ixx + iyy;
196  double xx_m_yy = ixx - iyy;
197  double t2 = xx_m_yy * xx_m_yy + 4.0 * ixy * ixy;
198  Eigen::Vector3d dt2(2.0 * xx_m_yy, -2.0 * xx_m_yy, 8.0 * ixy);
199  double t = std::sqrt(t2);
200  a = std::sqrt(0.5 * (xx_p_yy + t));
201  b = std::sqrt(0.5 * (xx_p_yy - t));
202  theta = 0.5 * std::atan2(2.0 * ixy, xx_m_yy);
203  Jacobian m = Jacobian::Zero();
204  m(0, 0) = 0.25 * (1.0 + 0.5 * dt2[0] / t) / a;
205  m(0, 1) = 0.25 * (1.0 + 0.5 * dt2[1] / t) / a;
206  m(0, 2) = 0.25 * (0.5 * dt2[2] / t) / a;
207  m(1, 0) = 0.25 * (1.0 - 0.5 * dt2[0] / t) / b;
208  m(1, 1) = 0.25 * (1.0 - 0.5 * dt2[1] / t) / b;
209  m(1, 2) = 0.25 * (-0.5 * dt2[2] / t) / b;
210 
211  m.row(2).setConstant(1.0 / (t * t));
212  m(2, 0) *= -ixy;
213  m(2, 1) *= ixy;
214  m(2, 2) *= xx_m_yy;
215  return m;
216 }

◆ _dAssignToAxes()

BaseCore::Jacobian lsst::afw::geom::ellipses::Quadrupole::_dAssignToAxes ( double &  a,
double &  b,
double &  theta 
) const
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 94 of file Quadrupole.cc.

94  {
95  return BaseCore::_dAssignQuadrupoleToAxes(getIxx(), getIyy(), getIxy(), a, b, theta);
96 }
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:193

◆ _dAssignToQuadrupole()

BaseCore::Jacobian lsst::afw::geom::ellipses::Quadrupole::_dAssignToQuadrupole ( double &  ixx,
double &  iyy,
double &  ixy 
) const
overrideprotectedvirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 83 of file Quadrupole.cc.

83  {
84  ixx = getIxx();
85  iyy = getIyy();
86  ixy = getIxy();
87  return Jacobian::Identity();
88 }

◆ as()

template<typename Output >
BaseCore::Converter< Output > lsst::afw::geom::ellipses::BaseCore::as
inlineinherited

Convert this to the core type specified as a template parameter.

Definition at line 238 of file BaseCore.h.

238  {
239  return Converter<Output>(*this);
240 }

◆ clone()

std::shared_ptr<Quadrupole> lsst::afw::geom::ellipses::Quadrupole::clone ( ) const
inline

Deep copy the ellipse core.

Definition at line 64 of file Quadrupole.h.

64 { return std::static_pointer_cast<Quadrupole>(_clone()); }
lsst::afw::geom::ellipses::Quadrupole::_clone
std::shared_ptr< BaseCore > _clone() const override
Return the size of the bounding box for the ellipse core.
Definition: Quadrupole.h:127

◆ computeDimensions()

lsst::geom::Extent2D lsst::afw::geom::ellipses::BaseCore::computeDimensions ( ) const
inherited

Return the size of the bounding box for the ellipse core.

Definition at line 129 of file BaseCore.cc.

129  {
130  double a, b, theta;
131  _assignToAxes(a, b, theta);
132  double c = std::cos(theta);
133  double s = std::sin(theta);
134  c *= c;
135  s *= s;
136  b *= b;
137  a *= a;
138  lsst::geom::Extent2D dimensions(std::sqrt(b * s + a * c), std::sqrt(a * s + b * c));
139  dimensions *= 2;
140  return dimensions;
141 }
dimensions
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:48
lsst::afw::geom::ellipses::BaseCore::_assignToAxes
virtual void _assignToAxes(double &a, double &b, double &theta) const =0
Return the size of the bounding box for the ellipse core.

◆ convolve() [1/2]

BaseCore::Convolution lsst::afw::geom::ellipses::BaseCore::convolve ( BaseCore const &  other)
inlineinherited

Return the size of the bounding box for the ellipse core.

Definition at line 91 of file Convolution.h.

91  {
92  return BaseCore::Convolution(*this, other);
93 }

◆ convolve() [2/2]

BaseCore::Convolution const lsst::afw::geom::ellipses::BaseCore::convolve ( BaseCore const &  other) const
inlineinherited

Return the size of the bounding box for the ellipse core.

Definition at line 95 of file Convolution.h.

95  {
96  return BaseCore::Convolution(const_cast<BaseCore &>(*this), other);
97 }
lsst::afw::geom::ellipses::BaseCore::BaseCore
BaseCore()=default
Return the size of the bounding box for the ellipse core.

◆ dAssign()

BaseCore::Jacobian lsst::afw::geom::ellipses::BaseCore::dAssign ( BaseCore const &  other)
inherited

Assign other to this and return the derivative of the conversion, d(this)/d(other).

Definition at line 168 of file BaseCore.cc.

168  {
169  if (getName() == other.getName()) {
170  this->operator=(other);
171  return Jacobian::Identity();
172  }
173  // We use Quadrupole instead of Axes here because the ambiguity of the position angle
174  // in the circular case causes some of the Jacobians to/from Axes to be undefined for
175  // exact circles. Quadrupoles don't have that problem, and the Axes-to-Axes case is
176  // handled by the above if block.
177  double ixx, iyy, ixy;
178  Jacobian rhs = other._dAssignToQuadrupole(ixx, iyy, ixy);
179  Jacobian lhs = _dAssignFromQuadrupole(ixx, iyy, ixy);
180  return lhs * rhs;
181 }
lsst::afw::geom::ellipses::BaseCore::getName
virtual std::string getName() const =0
Return a string that identifies this parametrization.
lsst::afw::geom::ellipses::BaseCore::_dAssignFromQuadrupole
virtual Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy)=0
Return the size of the bounding box for the ellipse core.
lsst::afw::geom::ellipses::BaseCore::operator=
BaseCore & operator=(BaseCore const &other)
Set the parameters of this ellipse core from another.
Definition: BaseCore.cc:155

◆ getArea()

double lsst::afw::geom::ellipses::BaseCore::getArea ( ) const
inherited

Return the area of the ellipse core.

Definition at line 111 of file BaseCore.cc.

111  {
112  double a, b, theta;
113  _assignToAxes(a, b, theta);
114  return a * b * lsst::geom::PI;
115 }
lsst::geom::PI
constexpr double PI
The ratio of a circle's circumference to diameter.
Definition: Angle.h:39

◆ getDeterminant()

double lsst::afw::geom::ellipses::Quadrupole::getDeterminant ( ) const
inline

Return the determinant of the matrix representation.

Definition at line 83 of file Quadrupole.h.

83 { return getIxx() * getIyy() - getIxy() * getIxy(); }

◆ getDeterminantRadius()

double lsst::afw::geom::ellipses::BaseCore::getDeterminantRadius ( ) const
inherited

Return the radius defined as the 4th root of the determinant of the quadrupole matrix.

The determinant radius is equal to the standard radius for a circle, and its square times pi is the area of the ellipse.

Definition at line 117 of file BaseCore.cc.

117  {
118  double a, b, theta;
119  _assignToAxes(a, b, theta);
120  return std::sqrt(a * b);
121 }

◆ getGridTransform()

BaseCore::GridTransform const lsst::afw::geom::ellipses::BaseCore::getGridTransform ( ) const
inlineinherited

Return the transform that maps the ellipse to the unit circle.

The returned proxy object is implicitly convertible to lsst::geom::LinearTransform and also supports differentiation.

Definition at line 110 of file GridTransform.h.

110  {
111  return BaseCore::GridTransform(*this);
112 }

◆ getIxx()

double const lsst::afw::geom::ellipses::Quadrupole::getIxx ( ) const
inline

Definition at line 54 of file Quadrupole.h.

54 { return _matrix(0, 0); }

◆ getIxy()

double const lsst::afw::geom::ellipses::Quadrupole::getIxy ( ) const
inline

Definition at line 60 of file Quadrupole.h.

60 { return _matrix(1, 0); }

◆ getIyy()

double const lsst::afw::geom::ellipses::Quadrupole::getIyy ( ) const
inline

Definition at line 57 of file Quadrupole.h.

57 { return _matrix(1, 1); }

◆ getMatrix()

Matrix const& lsst::afw::geom::ellipses::Quadrupole::getMatrix ( ) const
inline

Return a 2x2 symmetric matrix of the parameters.

Definition at line 80 of file Quadrupole.h.

80 { return _matrix; }

◆ getName()

std::string lsst::afw::geom::ellipses::Quadrupole::getName ( ) const
overridevirtual

Return a string that identifies this parametrization.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 33 of file Quadrupole.cc.

33 { return "Quadrupole"; }

◆ getParameterVector()

BaseCore::ParameterVector const lsst::afw::geom::ellipses::BaseCore::getParameterVector ( ) const
inherited

Return the core parameters as a vector.

Definition at line 143 of file BaseCore.cc.

143  {
144  ParameterVector r;
145  writeParameters(r.data());
146  return r;
147 }
lsst::afw::geom::ellipses::BaseCore::writeParameters
virtual void writeParameters(double *iter) const =0
Return the size of the bounding box for the ellipse core.
lsst::afw::geom::ellipses::BaseCore::ParameterVector
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:63

◆ getTraceRadius()

double lsst::afw::geom::ellipses::BaseCore::getTraceRadius ( ) const
inherited

Return the radius defined as the square root of one half the trace of the quadrupole matrix.

The trace radius is equal to the standard radius for a circle.

Definition at line 123 of file BaseCore.cc.

123  {
124  double ixx, iyy, ixy;
125  _assignToQuadrupole(ixx, iyy, ixy);
126  return std::sqrt(0.5 * (ixx + iyy));
127 }
lsst::afw::geom::ellipses::BaseCore::_assignToQuadrupole
virtual void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const =0
Return the size of the bounding box for the ellipse core.

◆ grow()

void lsst::afw::geom::ellipses::BaseCore::grow ( double  buffer)
inherited

Increase the major and minor radii of the ellipse core by the given buffer.

Definition at line 95 of file BaseCore.cc.

95  {
96  double a, b, theta;
97  _assignToAxes(a, b, theta);
98  a += buffer;
99  b += buffer;
100  _assignFromAxes(a, b, theta);
101 }
lsst::afw::geom::ellipses::BaseCore::_assignFromAxes
virtual void _assignFromAxes(double a, double b, double theta)=0
Return the size of the bounding box for the ellipse core.

◆ make() [1/6]

std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::make ( std::string const &  name)
staticinherited

Definition at line 55 of file BaseCore.cc.

55  {
56  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
57  *result = Quadrupole();
58  return result;
59 }
result
py::object result
Definition: _schema.cc:429
name
table::Key< std::string > name
Definition: Amplifier.cc:116

◆ make() [2/6]

std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::make ( std::string const &  name,
BaseCore const &  other 
)
staticinherited

Definition at line 73 of file BaseCore.cc.

73  {
74  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
75  *result = other;
76  return result;
77 }

◆ make() [3/6]

std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::make ( std::string const &  name,
Convolution const &  other 
)
staticinherited

Definition at line 85 of file BaseCore.cc.

85  {
86  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
87  other.apply(*result);
88  return result;
89 }

◆ make() [4/6]

std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::make ( std::string const &  name,
double  v1,
double  v2,
double  v3 
)
staticinherited

Definition at line 67 of file BaseCore.cc.

67  {
68  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
69  result->setParameterVector(ParameterVector(v1, v2, v3));
70  return result;
71 }

◆ make() [5/6]

std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::make ( std::string const &  name,
ParameterVector const &  parameters 
)
staticinherited

Definition at line 61 of file BaseCore.cc.

61  {
62  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
63  result->setParameterVector(parameters);
64  return result;
65 }

◆ make() [6/6]

std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::make ( std::string const &  name,
Transformer const &  other 
)
staticinherited

Definition at line 79 of file BaseCore.cc.

79  {
80  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
81  other.apply(*result);
82  return result;
83 }

◆ normalize()

void lsst::afw::geom::ellipses::Quadrupole::normalize ( )
overridevirtual

Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normalized.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 35 of file Quadrupole.cc.

35  {
36  if (_matrix(0, 1) != _matrix(1, 0))
37  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
38  "Quadrupole matrix must be symmetric.");
39  if (getIxx() < 0 || getIyy() < 0)
40  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
41  "Quadrupole matrix cannot have negative diagonal elements.");
42  if (getDeterminant() < 0)
43  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
44  "Quadrupole matrix cannot have negative determinant.");
45 }
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::afw::geom::ellipses::Quadrupole::getDeterminant
double getDeterminant() const
Return the determinant of the matrix representation.
Definition: Quadrupole.h:83
lsst.pex::exceptions::InvalidParameterError
Reports invalid arguments.
Definition: Runtime.h:66

◆ operator!=()

bool lsst::afw::geom::ellipses::BaseCore::operator!= ( BaseCore const &  other) const
inlineinherited

Compare two ellipse cores for inequality.

Ellipses are only equal if they have the same type.

Definition at line 167 of file BaseCore.h.

167 { return !operator==(other); }
lsst::afw::geom::ellipses::BaseCore::operator==
bool operator==(BaseCore const &other) const
Compare two ellipse cores for equality.
Definition: BaseCore.cc:151

◆ operator=() [1/3]

Quadrupole& lsst::afw::geom::ellipses::Quadrupole::operator= ( BaseCore const &  other)
inline

Converting assignment.

Definition at line 95 of file Quadrupole.h.

95  {
96  BaseCore::operator=(other);
97  return *this;
98  }

◆ operator=() [2/3]

Quadrupole& lsst::afw::geom::ellipses::Quadrupole::operator= ( Quadrupole &&  other)
inline

Definition at line 92 of file Quadrupole.h.

92 { return *this = other; }

◆ operator=() [3/3]

Quadrupole& lsst::afw::geom::ellipses::Quadrupole::operator= ( Quadrupole const &  other)
inline

Standard assignment.

Definition at line 86 of file Quadrupole.h.

86  {
87  _matrix = other._matrix;
88  return *this;
89  }

◆ operator==()

bool lsst::afw::geom::ellipses::BaseCore::operator== ( BaseCore const &  other) const
inherited

Compare two ellipse cores for equality.

Ellipse cores are only equal if they have the same type.

Definition at line 151 of file BaseCore.cc.

151  {
152  return getParameterVector() == other.getParameterVector() && getName() == other.getName();
153 }
lsst::afw::geom::ellipses::BaseCore::getParameterVector
ParameterVector const getParameterVector() const
Return the core parameters as a vector.
Definition: BaseCore.cc:143

◆ readParameters()

void lsst::afw::geom::ellipses::Quadrupole::readParameters ( double const *  iter)
overridevirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 47 of file Quadrupole.cc.

47  {
48  setIxx(*iter++);
49  setIyy(*iter++);
50  setIxy(*iter++);
51 }

◆ registerSubclass()

void lsst::afw::geom::ellipses::BaseCore::registerSubclass ( std::shared_ptr< BaseCore > const &  example)
staticprotectedinherited

Return the size of the bounding box for the ellipse core.

Definition at line 91 of file BaseCore.cc.

91  {
92  getRegistry()[example->getName()] = example;
93 }

◆ scale()

void lsst::afw::geom::ellipses::BaseCore::scale ( double  factor)
inherited

Scale the size of the ellipse core by the given factor.

Definition at line 103 of file BaseCore.cc.

103  {
104  double a, b, theta;
105  _assignToAxes(a, b, theta);
106  a *= factor;
107  b *= factor;
108  _assignFromAxes(a, b, theta);
109 }

◆ setIxx()

void lsst::afw::geom::ellipses::Quadrupole::setIxx ( double  ixx)
inline

Definition at line 55 of file Quadrupole.h.

55 { _matrix(0, 0) = ixx; }

◆ setIxy()

void lsst::afw::geom::ellipses::Quadrupole::setIxy ( double  ixy)
inline

Definition at line 61 of file Quadrupole.h.

61 { _matrix(0, 1) = _matrix(1, 0) = ixy; }

◆ setIyy()

void lsst::afw::geom::ellipses::Quadrupole::setIyy ( double  iyy)
inline

Definition at line 58 of file Quadrupole.h.

58 { _matrix(1, 1) = iyy; }

◆ setParameterVector()

void lsst::afw::geom::ellipses::BaseCore::setParameterVector ( ParameterVector const &  vector)
inherited

Set the core parameters from a vector.

Definition at line 149 of file BaseCore.cc.

149 { readParameters(p.data()); }
lsst::afw::geom::ellipses::BaseCore::readParameters
virtual void readParameters(double const *iter)=0
Return the size of the bounding box for the ellipse core.

◆ transform() [1/2]

BaseCore::Transformer lsst::afw::geom::ellipses::BaseCore::transform ( lsst::geom::LinearTransform const &  transform)
inlineinherited

Return the transform that maps the ellipse to the unit circle.

The returned proxy object is implicitly convertible to lsst::geom::LinearTransform and also supports differentiation.

Definition at line 116 of file Transformer.h.

116  {
117  return BaseCore::Transformer(*this, transform);
118 }
lsst::afw::geom::ellipses::BaseCore::transform
Transformer transform(lsst::geom::LinearTransform const &transform)
Return the transform that maps the ellipse to the unit circle.
Definition: Transformer.h:116

◆ transform() [2/2]

BaseCore::Transformer const lsst::afw::geom::ellipses::BaseCore::transform ( lsst::geom::LinearTransform const &  transform) const
inlineinherited

Return the transform that maps the ellipse to the unit circle.

The returned proxy object is implicitly convertible to lsst::geom::LinearTransform and also supports differentiation.

Definition at line 120 of file Transformer.h.

120  {
121  return BaseCore::Transformer(const_cast<BaseCore &>(*this), transform);
122 }

◆ writeParameters()

void lsst::afw::geom::ellipses::Quadrupole::writeParameters ( double *  iter) const
overridevirtual

Return the size of the bounding box for the ellipse core.

Implements lsst::afw::geom::ellipses::BaseCore.

Definition at line 53 of file Quadrupole.cc.

53  {
54  *iter++ = getIxx();
55  *iter++ = getIyy();
56  *iter++ = getIxy();
57 }
The documentation for this class was generated from the following files:
Generated on Fri Nov 26 2021 10:16:11 for LSST Applications by doxygen 1.9.1