LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
lsst::afw::geom::ellipses::Axes Class Reference

An ellipse core for the semimajor/semiminor axis and position angle parametrization (a,b,theta). More...

#include <Axes.h>

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

Public Types

enum  ParameterEnum { A = 0, B = 1, THETA = 2 }
 
typedef Eigen::Vector3d ParameterVector
 Parameter vector type. More...
 
typedef Eigen::Matrix3d Jacobian
 Parameter Jacobian matrix type. More...
 

Public Member Functions

double const getA () const
 
void setA (double a)
 
double const getB () const
 
void setB (double b)
 
double const getTheta () const
 
void setTheta (double theta)
 
std::shared_ptr< Axesclone () 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", if possible, and throw InvalidParameterError if they cannot be normalized. More...
 
void readParameters (double const *iter) override
 
void writeParameters (double *iter) const override
 
Axesoperator= (Axes const &other)
 Standard assignment. More...
 
Axesoperator= (Axes &&other)
 
Axesoperator= (BaseCore const &other)
 Converting assignment. More...
 
 Axes (double a=1.0, double b=1.0, double theta=0.0, bool normalize=false)
 Construct from parameter values. More...
 
 Axes (BaseCore::ParameterVector const &vector, bool normalize=false)
 Construct from a parameter vector. More...
 
 Axes (Axes const &other)
 Copy constructor. More...
 
 Axes (Axes &&other)
 
 ~Axes () override=default
 
 Axes (BaseCore const &other)
 Converting copy constructor. More...
 
 Axes (BaseCore::Transformer const &transformer)
 Converting copy constructor. More...
 
 Axes (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...
 
GridTransform const getGridTransform () const
 Return the transform that maps the ellipse to the unit circle. 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...
 
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)
 
Transformer const transform (lsst::geom::LinearTransform const &transform) const
 
Convolve two bivariate Gaussians defined by their 1-sigma ellipses.
Convolution convolve (BaseCore const &other)
 
Convolution const convolve (BaseCore const &other) const
 

Static Public Member Functions

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

Protected Member Functions

std::shared_ptr< BaseCore_clone () const override
 
void _assignToQuadrupole (double &ixx, double &iyy, double &ixy) const override
 
void _assignFromQuadrupole (double ixx, double iyy, double ixy) override
 
void _assignToAxes (double &a, double &b, double &theta) const override
 
void _assignFromAxes (double a, double b, double theta) override
 
Jacobian _dAssignToQuadrupole (double &ixx, double &iyy, double &ixy) const override
 
Jacobian _dAssignFromQuadrupole (double ixx, double iyy, double ixy) override
 
Jacobian _dAssignToAxes (double &a, double &b, double &theta) const override
 
Jacobian _dAssignFromAxes (double a, double b, double theta) override
 

Static Protected Member Functions

static void registerSubclass (std::shared_ptr< BaseCore > const &example)
 
static void _assignQuadrupoleToAxes (double ixx, double iyy, double ixy, double &a, double &b, double &theta)
 
static Jacobian _dAssignQuadrupoleToAxes (double ixx, double iyy, double ixy, double &a, double &b, double &theta)
 
static void _assignAxesToQuadrupole (double a, double b, double theta, double &ixx, double &iyy, double &ixy)
 
static Jacobian _dAssignAxesToQuadrupole (double a, double b, double theta, double &ixx, double &iyy, double &ixy)
 

Detailed Description

An ellipse core for the semimajor/semiminor axis and position angle parametrization (a,b,theta).

Definition at line 47 of file Axes.h.

Member Typedef Documentation

◆ Jacobian

typedef Eigen::Matrix3d lsst::afw::geom::ellipses::BaseCore::Jacobian
inherited

Parameter Jacobian matrix type.

Definition at line 64 of file BaseCore.h.

◆ ParameterVector

typedef Eigen::Vector3d lsst::afw::geom::ellipses::BaseCore::ParameterVector
inherited

Parameter vector type.

Definition at line 61 of file BaseCore.h.

Member Enumeration Documentation

◆ ParameterEnum

Enumerator
THETA 

Definition at line 49 of file Axes.h.

Constructor & Destructor Documentation

◆ Axes() [1/7]

lsst::afw::geom::ellipses::Axes::Axes ( double  a = 1.0,
double  b = 1.0,
double  theta = 0.0,
bool  normalize = false 
)
inlineexplicit

Construct from parameter values.

Definition at line 91 of file Axes.h.

92  : _vector(a, b, theta) {
93  if (normalize) this->normalize();
94  }
table::Key< int > b
table::Key< int > a
void normalize() override
Put the parameters into a "standard form", if possible, and throw InvalidParameterError if they canno...
Definition: Axes.cc:36

◆ Axes() [2/7]

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

Construct from a parameter vector.

Definition at line 97 of file Axes.h.

97  : _vector(vector) {
98  if (normalize) this->normalize();
99  }
void normalize() override
Put the parameters into a "standard form", if possible, and throw InvalidParameterError if they canno...
Definition: Axes.cc:36

◆ Axes() [3/7]

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

Copy constructor.

Definition at line 102 of file Axes.h.

102 : _vector(other._vector) {}
ItemVariant const * other
Definition: Schema.cc:56

◆ Axes() [4/7]

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

Definition at line 104 of file Axes.h.

104 : Axes(other) {}
Axes(double a=1.0, double b=1.0, double theta=0.0, bool normalize=false)
Construct from parameter values.
Definition: Axes.h:91
ItemVariant const * other
Definition: Schema.cc:56

◆ ~Axes()

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

◆ Axes() [5/7]

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

Converting copy constructor.

Definition at line 108 of file Axes.h.

108 { *this = other; }
ItemVariant const * other
Definition: Schema.cc:56

◆ Axes() [6/7]

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

Converting copy constructor.

Definition at line 111 of file Axes.h.

111 { transformer.apply(*this); }

◆ Axes() [7/7]

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

Converting copy constructor.

Definition at line 114 of file Axes.h.

114 { 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

Definition at line 219 of file BaseCore.cc.

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

◆ _assignFromAxes()

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

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

Definition at line 92 of file Axes.cc.

92  {
93  _vector[A] = a;
94  _vector[B] = b;
95  _vector[THETA] = theta;
96 }
table::Key< int > b
table::Key< int > a

◆ _assignFromQuadrupole()

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

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

Definition at line 82 of file Axes.cc.

82  {
83  BaseCore::_assignQuadrupoleToAxes(ixx, iyy, ixy, _vector[A], _vector[B], _vector[THETA]);
84  normalize();
85 }
static void _assignQuadrupoleToAxes(double ixx, double iyy, double ixy, double &a, double &b, double &theta)
Definition: BaseCore.cc:184
void normalize() override
Put the parameters into a "standard form", if possible, and throw InvalidParameterError if they canno...
Definition: Axes.cc:36

◆ _assignQuadrupoleToAxes()

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

Definition at line 184 of file BaseCore.cc.

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

◆ _assignToAxes()

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

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

Definition at line 69 of file Axes.cc.

69  {
70  a = _vector[A];
71  b = _vector[B];
72  theta = _vector[THETA];
73 }
table::Key< int > b
table::Key< int > a

◆ _assignToQuadrupole()

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

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

Definition at line 61 of file Axes.cc.

61  {
62  BaseCore::_assignAxesToQuadrupole(_vector[A], _vector[B], _vector[THETA], ixx, iyy, ixy);
63 }
static void _assignAxesToQuadrupole(double a, double b, double theta, double &ixx, double &iyy, double &ixy)
Definition: BaseCore.cc:219

◆ _clone()

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

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

Definition at line 117 of file Axes.h.

117 { return std::make_shared<Axes>(*this); }

◆ _dAssignAxesToQuadrupole()

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

Definition at line 232 of file BaseCore.cc.

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

◆ _dAssignFromAxes()

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

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

Definition at line 98 of file Axes.cc.

98  {
99  _vector[A] = a;
100  _vector[B] = b;
101  _vector[THETA] = theta;
102  return Jacobian::Identity();
103 }
table::Key< int > b
table::Key< int > a

◆ _dAssignFromQuadrupole()

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

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

Definition at line 87 of file Axes.cc.

87  {
88  return BaseCore::_dAssignQuadrupoleToAxes(ixx, iyy, ixy, _vector[A], _vector[B], _vector[THETA]);
89  normalize();
90 }
static Jacobian _dAssignQuadrupoleToAxes(double ixx, double iyy, double ixy, double &a, double &b, double &theta)
Definition: BaseCore.cc:194
void normalize() override
Put the parameters into a "standard form", if possible, and throw InvalidParameterError if they canno...
Definition: Axes.cc:36

◆ _dAssignQuadrupoleToAxes()

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

Definition at line 194 of file BaseCore.cc.

195  {
196  double xx_p_yy = ixx + iyy;
197  double xx_m_yy = ixx - iyy;
198  double t2 = xx_m_yy * xx_m_yy + 4.0 * ixy * ixy;
199  Eigen::Vector3d dt2(2.0 * xx_m_yy, -2.0 * xx_m_yy, 8.0 * ixy);
200  double t = std::sqrt(t2);
201  a = std::sqrt(0.5 * (xx_p_yy + t));
202  b = std::sqrt(0.5 * (xx_p_yy - t));
203  theta = 0.5 * std::atan2(2.0 * ixy, xx_m_yy);
204  Jacobian m = Jacobian::Zero();
205  m(0, 0) = 0.25 * (1.0 + 0.5 * dt2[0] / t) / a;
206  m(0, 1) = 0.25 * (1.0 + 0.5 * dt2[1] / t) / a;
207  m(0, 2) = 0.25 * (0.5 * dt2[2] / t) / a;
208  m(1, 0) = 0.25 * (1.0 - 0.5 * dt2[0] / t) / b;
209  m(1, 1) = 0.25 * (1.0 - 0.5 * dt2[1] / t) / b;
210  m(1, 2) = 0.25 * (-0.5 * dt2[2] / t) / b;
211 
212  m.row(2).setConstant(1.0 / (t * t));
213  m(2, 0) *= -ixy;
214  m(2, 1) *= ixy;
215  m(2, 2) *= xx_m_yy;
216  return m;
217 }
table::Key< int > b
table::Key< int > a
T atan2(T... args)
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition: BaseCore.h:64
int m
Definition: SpanSet.cc:49
T sqrt(T... args)

◆ _dAssignToAxes()

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

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

Definition at line 75 of file Axes.cc.

75  {
76  a = _vector[A];
77  b = _vector[B];
78  theta = _vector[THETA];
79  return Jacobian::Identity();
80 }
table::Key< int > b
table::Key< int > a

◆ _dAssignToQuadrupole()

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

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

Definition at line 65 of file Axes.cc.

65  {
66  return BaseCore::_dAssignAxesToQuadrupole(_vector[A], _vector[B], _vector[THETA], ixx, iyy, ixy);
67 }
static Jacobian _dAssignAxesToQuadrupole(double a, double b, double theta, double &ixx, double &iyy, double &ixy)
Definition: BaseCore.cc:232

◆ as()

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

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

Definition at line 240 of file BaseCore.h.

240  {
241  return Converter<Output>(*this);
242 }

◆ clone()

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

Deep copy the ellipse core.

Definition at line 61 of file Axes.h.

61 { return std::static_pointer_cast<Axes>(_clone()); }
Axes(double a=1.0, double b=1.0, double theta=0.0, bool normalize=false)
Construct from parameter values.
Definition: Axes.h:91
T static_pointer_cast(T... args)
std::shared_ptr< BaseCore > _clone() const override
Definition: Axes.h:117

◆ 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 130 of file BaseCore.cc.

130  {
131  double a, b, theta;
132  _assignToAxes(a, b, theta);
133  double c = std::cos(theta);
134  double s = std::sin(theta);
135  c *= c;
136  s *= s;
137  b *= b;
138  a *= a;
139  lsst::geom::Extent2D dimensions(std::sqrt(b * s + a * c), std::sqrt(a * s + b * c));
140  dimensions *= 2;
141  return dimensions;
142 }
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:49
table::Key< int > b
table::Key< int > a
T sin(T... args)
T cos(T... args)
virtual void _assignToAxes(double &a, double &b, double &theta) const =0
solver_t * s
T sqrt(T... args)

◆ convolve() [1/2]

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

Definition at line 93 of file Convolution.h.

93  {
94  return BaseCore::Convolution(*this, other);
95 }
ItemVariant const * other
Definition: Schema.cc:56

◆ convolve() [2/2]

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

Definition at line 97 of file Convolution.h.

97  {
98  return BaseCore::Convolution(const_cast<BaseCore &>(*this), other);
99 }
ItemVariant const * other
Definition: Schema.cc:56

◆ 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 169 of file BaseCore.cc.

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

◆ getA()

double const lsst::afw::geom::ellipses::Axes::getA ( ) const
inline

Definition at line 51 of file Axes.h.

51 { return _vector[A]; }

◆ getArea()

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

Return the area of the ellipse core.

Definition at line 112 of file BaseCore.cc.

112  {
113  double a, b, theta;
114  _assignToAxes(a, b, theta);
115  return a * b * lsst::geom::PI;
116 }
table::Key< int > b
table::Key< int > a
virtual void _assignToAxes(double &a, double &b, double &theta) const =0
double constexpr PI
The ratio of a circle&#39;s circumference to diameter.
Definition: Angle.h:39

◆ getB()

double const lsst::afw::geom::ellipses::Axes::getB ( ) const
inline

Definition at line 54 of file Axes.h.

54 { return _vector[B]; }

◆ 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 118 of file BaseCore.cc.

118  {
119  double a, b, theta;
120  _assignToAxes(a, b, theta);
121  return std::sqrt(a * b);
122 }
table::Key< int > b
table::Key< int > a
virtual void _assignToAxes(double &a, double &b, double &theta) const =0
T sqrt(T... args)

◆ 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 116 of file GridTransform.h.

116  {
117  return BaseCore::GridTransform(*this);
118 }

◆ getName()

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

Return a string that identifies this parametrization.

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

Definition at line 34 of file Axes.cc.

34 { return "Axes"; }

◆ getParameterVector()

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

Return the core parameters as a vector.

Definition at line 144 of file BaseCore.cc.

144  {
145  ParameterVector r;
146  writeParameters(r.data());
147  return r;
148 }
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:61
virtual void writeParameters(double *iter) const =0

◆ getTheta()

double const lsst::afw::geom::ellipses::Axes::getTheta ( ) const
inline

Definition at line 57 of file Axes.h.

57 { return _vector[THETA]; }

◆ 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 124 of file BaseCore.cc.

124  {
125  double ixx, iyy, ixy;
126  _assignToQuadrupole(ixx, iyy, ixy);
127  return std::sqrt(0.5 * (ixx + iyy));
128 }
T sqrt(T... args)
virtual void _assignToQuadrupole(double &ixx, double &iyy, double &ixy) const =0

◆ 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 96 of file BaseCore.cc.

96  {
97  double a, b, theta;
98  _assignToAxes(a, b, theta);
99  a += buffer;
100  b += buffer;
101  _assignFromAxes(a, b, theta);
102 }
table::Key< int > b
table::Key< int > a
virtual void _assignFromAxes(double a, double b, double theta)=0
virtual void _assignToAxes(double &a, double &b, double &theta) const =0

◆ make() [1/6]

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

Definition at line 56 of file BaseCore.cc.

56  {
57  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
58  *result = Quadrupole();
59  return result;
60 }
py::object result
Definition: schema.cc:418

◆ make() [2/6]

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

Definition at line 62 of file BaseCore.cc.

62  {
63  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
64  result->setParameterVector(parameters);
65  return result;
66 }
py::object result
Definition: schema.cc:418

◆ make() [3/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 68 of file BaseCore.cc.

68  {
69  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
70  result->setParameterVector(ParameterVector(v1, v2, v3));
71  return result;
72 }
py::object result
Definition: schema.cc:418
Eigen::Vector3d ParameterVector
Parameter vector type.
Definition: BaseCore.h:61

◆ make() [4/6]

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

Definition at line 74 of file BaseCore.cc.

74  {
75  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
76  *result = other;
77  return result;
78 }
py::object result
Definition: schema.cc:418
ItemVariant const * other
Definition: Schema.cc:56

◆ make() [5/6]

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

Definition at line 80 of file BaseCore.cc.

80  {
81  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
82  other.apply(*result);
83  return result;
84 }
py::object result
Definition: schema.cc:418
ItemVariant const * other
Definition: Schema.cc:56

◆ make() [6/6]

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

Definition at line 86 of file BaseCore.cc.

86  {
87  std::shared_ptr<BaseCore> result = getRegistryCopy(name);
88  other.apply(*result);
89  return result;
90 }
py::object result
Definition: schema.cc:418
ItemVariant const * other
Definition: Schema.cc:56

◆ normalize()

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

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

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

Definition at line 36 of file Axes.cc.

36  {
37  if (_vector[A] < 0 || _vector[B] < 0)
39  "Major and minor axes cannot be negative.");
40  if (_vector[A] < _vector[B]) {
41  std::swap(_vector[A], _vector[B]);
42  _vector[THETA] += M_PI_2;
43  }
44  if (_vector[THETA] > M_PI_2 || _vector[THETA] <= -M_PI_2) {
45  _vector[THETA] -= M_PI * std::ceil(_vector[THETA] / M_PI - 0.5);
46  }
47 }
T ceil(T... args)
T swap(T... args)
#define M_PI
Definition: ListMatch.cc:31
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
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); }
ItemVariant const * other
Definition: Schema.cc:56
bool operator==(BaseCore const &other) const
Compare two ellipse cores for equality.
Definition: BaseCore.cc:152

◆ operator=() [1/3]

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

Standard assignment.

Definition at line 77 of file Axes.h.

77  {
78  _vector = other._vector;
79  return *this;
80  }
ItemVariant const * other
Definition: Schema.cc:56

◆ operator=() [2/3]

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

Definition at line 82 of file Axes.h.

82 { return *this = other; }
ItemVariant const * other
Definition: Schema.cc:56

◆ operator=() [3/3]

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

Converting assignment.

Definition at line 85 of file Axes.h.

85  {
87  return *this;
88  }
BaseCore & operator=(BaseCore const &other)
Set the parameters of this ellipse core from another.
Definition: BaseCore.cc:156
ItemVariant const * other
Definition: Schema.cc:56

◆ 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 152 of file BaseCore.cc.

152  {
153  return getParameterVector() == other.getParameterVector() && getName() == other.getName();
154 }
ParameterVector const getParameterVector() const
Return the core parameters as a vector.
Definition: BaseCore.cc:144
virtual std::string getName() const =0
Return a string that identifies this parametrization.
ItemVariant const * other
Definition: Schema.cc:56

◆ readParameters()

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

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

Definition at line 49 of file Axes.cc.

49  {
50  setA(*iter++);
51  setB(*iter++);
52  setTheta(*iter++);
53 }
void setB(double b)
Definition: Axes.h:55
void setA(double a)
Definition: Axes.h:52
void setTheta(double theta)
Definition: Axes.h:58

◆ registerSubclass()

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

Definition at line 92 of file BaseCore.cc.

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

◆ 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 104 of file BaseCore.cc.

104  {
105  double a, b, theta;
106  _assignToAxes(a, b, theta);
107  a *= factor;
108  b *= factor;
109  _assignFromAxes(a, b, theta);
110 }
table::Key< int > b
table::Key< int > a
virtual void _assignFromAxes(double a, double b, double theta)=0
virtual void _assignToAxes(double &a, double &b, double &theta) const =0

◆ setA()

void lsst::afw::geom::ellipses::Axes::setA ( double  a)
inline

Definition at line 52 of file Axes.h.

52 { _vector[A] = a; }
table::Key< int > a

◆ setB()

void lsst::afw::geom::ellipses::Axes::setB ( double  b)
inline

Definition at line 55 of file Axes.h.

55 { _vector[B] = b; }
table::Key< int > b

◆ setParameterVector()

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

Set the core parameters from a vector.

Definition at line 150 of file BaseCore.cc.

150 { readParameters(p.data()); }
virtual void readParameters(double const *iter)=0

◆ setTheta()

void lsst::afw::geom::ellipses::Axes::setTheta ( double  theta)
inline

Definition at line 58 of file Axes.h.

58 { _vector[THETA] = theta; }

◆ transform() [1/2]

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

Definition at line 116 of file Transformer.h.

116  {
117  return BaseCore::Transformer(*this, transform);
118 }

◆ transform() [2/2]

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

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::Axes::writeParameters ( double *  iter) const
overridevirtual

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

Definition at line 55 of file Axes.cc.

55  {
56  *iter++ = getA();
57  *iter++ = getB();
58  *iter++ = getTheta();
59 }
double const getB() const
Definition: Axes.h:54
double const getA() const
Definition: Axes.h:51
double const getTheta() const
Definition: Axes.h:57

The documentation for this class was generated from the following files: