LSST Applications 24.1.5,g02d81e74bb+fa3a7a026e,g180d380827+a53a32eff8,g2079a07aa2+86d27d4dc4,g2305ad1205+c0501b3732,g295015adf3+7d3e92f0ec,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g33d1c0ed96+0e5473021a,g3a166c0a6a+0e5473021a,g3ddfee87b4+5dd1654d75,g48712c4677+3bf1020dcb,g487adcacf7+065c13d9cf,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+d7ac436cfb,g5a732f18d5+53520f316c,g64a986408d+fa3a7a026e,g858d7b2824+fa3a7a026e,g8a8a8dda67+585e252eca,g99cad8db69+a5a909b84f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+4cf350ccb2,gb0e22166c9+60f28cb32d,gba4ed39666+c2a2e4ac27,gbb8dafda3b+f991a0b59f,gc120e1dc64+9ccbfdb8be,gc28159a63d+0e5473021a,gcf0d15dbbd+5dd1654d75,gd96a1ce819+42fd0ee607,gdaeeff99f8+f9a426f77a,ge6526c86ff+0d71447b4b,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gff1a9f87cc+fa3a7a026e
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::geom::ellipses::BaseCore Class Referenceabstract

A base class for parametrizations of the "core" of an ellipse - the ellipticity and size. More...

#include <BaseCore.h>

Inheritance diagram for lsst::afw::geom::ellipses::BaseCore:
lsst::afw::geom::ellipses::Axes lsst::afw::geom::ellipses::Quadrupole lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >

Classes

struct  Converter
 
class  Convolution
 A temporary-only expression object for ellipse core convolution. More...
 
class  GridTransform
 A temporary-only expression object representing an lsst::geom::LinearTransform that maps the ellipse core to a unit circle. More...
 
struct  Registrar
 
class  Transformer
 A temporary-only expression object for ellipse core transformations. More...
 

Public Types

using ParameterVector = Eigen::Vector3d
 Parameter vector type.
 
using Jacobian = Eigen::Matrix3d
 Parameter Jacobian matrix type.
 

Public Member Functions

virtual std::string getName () const =0
 Return a string that identifies this parametrization.
 
std::shared_ptr< BaseCoreclone () const
 Deep-copy the Core.
 
virtual void normalize ()=0
 Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normalized.
 
void grow (double buffer)
 Increase the major and minor radii of the ellipse core by the given buffer.
 
void scale (double factor)
 Scale the size of the ellipse core by the given factor.
 
double getArea () const
 Return the area of the ellipse core.
 
double getDeterminantRadius () const
 Return the radius defined as the 4th root of the determinant of the quadrupole matrix.
 
double getTraceRadius () const
 Return the radius defined as the square root of one half the trace of the quadrupole matrix.
 
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.
 
Transformer const transform (lsst::geom::LinearTransform const &transform) const
 Return the transform that maps the ellipse to the unit circle.
 
GridTransform const getGridTransform () const
 Return the transform that maps the ellipse to the unit circle.
 

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)
 

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

class Parametric
 Return the size of the bounding box for the ellipse core.
 
Convolution convolve (BaseCore const &other)
 Return the size of the bounding box for the ellipse core.
 
Convolution const convolve (BaseCore const &other) const
 Return the size of the bounding box for the ellipse core.
 
lsst::geom::Extent2D computeDimensions () const
 Return the size of the bounding box for the ellipse core.
 
virtual void readParameters (double const *iter)=0
 Return the size of the bounding box for the ellipse core.
 
virtual void writeParameters (double *iter) const =0
 Return the size of the bounding box for the ellipse core.
 
ParameterVector const getParameterVector () const
 Return the core parameters as a vector.
 
void setParameterVector (ParameterVector const &vector)
 Set the core parameters from a vector.
 
bool operator== (BaseCore const &other) const
 Compare two ellipse cores for equality.
 
bool operator!= (BaseCore const &other) const
 Compare two ellipse cores for inequality.
 
BaseCoreoperator= (BaseCore const &other)
 Set the parameters of this ellipse core from another.
 
BaseCoreoperator= (BaseCore &&other)
 Return the size of the bounding box for the ellipse core.
 
Jacobian dAssign (BaseCore const &other)
 Assign other to this and return the derivative of the conversion, d(this)/d(other).
 
template<typename Output >
Converter< Output > as () const
 Convert this to the core type specified as a template parameter.
 
virtual ~BaseCore ()=default
 Return the size of the bounding box for the ellipse core.
 
 BaseCore ()=default
 Return the size of the bounding box for the ellipse core.
 
virtual std::shared_ptr< BaseCore_clone () const =0
 Return the size of the bounding box for the ellipse core.
 
virtual void _assignToQuadrupole (double &ixx, double &iyy, double &ixy) const =0
 Return the size of the bounding box for the ellipse core.
 
virtual void _assignFromQuadrupole (double ixx, double iyy, double ixy)=0
 Return the size of the bounding box for the ellipse core.
 
virtual void _assignToAxes (double &a, double &b, double &theta) const =0
 Return the size of the bounding box for the ellipse core.
 
virtual void _assignFromAxes (double a, double b, double theta)=0
 Return the size of the bounding box for the ellipse core.
 
virtual Jacobian _dAssignToQuadrupole (double &ixx, double &iyy, double &ixy) const =0
 Return the size of the bounding box for the ellipse core.
 
virtual Jacobian _dAssignFromQuadrupole (double ixx, double iyy, double ixy)=0
 Return the size of the bounding box for the ellipse core.
 
virtual Jacobian _dAssignToAxes (double &a, double &b, double &theta) const =0
 Return the size of the bounding box for the ellipse core.
 
virtual Jacobian _dAssignFromAxes (double a, double b, double theta)=0
 Return the size of the bounding box for the ellipse core.
 
static void registerSubclass (std::shared_ptr< BaseCore > const &example)
 Return the size of the bounding box for the ellipse core.
 
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.
 
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.
 
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.
 
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.
 

Detailed Description

A base class for parametrizations of the "core" of an ellipse - the ellipticity and size.

A subclass of BaseCore provides a particular interpretation of the three pointing point values that define an ellipse's size and ellipticity (including position angle). All core subclasses are implicitly convertible and can be assigned to from any other core.

Definition at line 55 of file BaseCore.h.

Member Typedef Documentation

◆ Jacobian

Parameter Jacobian matrix type.

Definition at line 64 of file BaseCore.h.

◆ ParameterVector

Parameter vector type.

Definition at line 63 of file BaseCore.h.

Constructor & Destructor Documentation

◆ ~BaseCore()

virtual lsst::afw::geom::ellipses::BaseCore::~BaseCore ( )
virtualdefault

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

◆ BaseCore()

lsst::afw::geom::ellipses::BaseCore::BaseCore ( )
protecteddefault

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

Member Function Documentation

◆ _assignAxesToQuadrupole()

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

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}
table::Key< int > b
table::Key< int > a
T cos(T... args)
T sin(T... args)

◆ _assignFromAxes()

virtual void lsst::afw::geom::ellipses::BaseCore::_assignFromAxes ( double a,
double b,
double theta )
protectedpure virtual

◆ _assignFromQuadrupole()

virtual void lsst::afw::geom::ellipses::BaseCore::_assignFromQuadrupole ( double ixx,
double iyy,
double ixy )
protectedpure virtual

◆ _assignQuadrupoleToAxes()

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

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}
T atan2(T... args)
T sqrt(T... args)

◆ _assignToAxes()

virtual void lsst::afw::geom::ellipses::BaseCore::_assignToAxes ( double & a,
double & b,
double & theta ) const
protectedpure virtual

◆ _assignToQuadrupole()

virtual void lsst::afw::geom::ellipses::BaseCore::_assignToQuadrupole ( double & ixx,
double & iyy,
double & ixy ) const
protectedpure virtual

◆ _clone()

virtual std::shared_ptr< BaseCore > lsst::afw::geom::ellipses::BaseCore::_clone ( ) const
protectedpure virtual

◆ _dAssignAxesToQuadrupole()

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

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}
int m
Definition SpanSet.cc:48
Eigen::Matrix3d Jacobian
Parameter Jacobian matrix type.
Definition BaseCore.h:64

◆ _dAssignFromAxes()

virtual Jacobian lsst::afw::geom::ellipses::BaseCore::_dAssignFromAxes ( double a,
double b,
double theta )
protectedpure virtual

◆ _dAssignFromQuadrupole()

virtual Jacobian lsst::afw::geom::ellipses::BaseCore::_dAssignFromQuadrupole ( double ixx,
double iyy,
double ixy )
protectedpure virtual

◆ _dAssignQuadrupoleToAxes()

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

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()

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

◆ _dAssignToQuadrupole()

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

◆ as()

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

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< BaseCore > lsst::afw::geom::ellipses::BaseCore::clone ( ) const
inline

Deep-copy the Core.

Definition at line 82 of file BaseCore.h.

82{ return _clone(); }
virtual std::shared_ptr< BaseCore > _clone() const =0
Return the size of the bounding box for the ellipse core.

◆ computeDimensions()

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

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}
afw::table::PointKey< int > dimensions
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)
inline

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
inline

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}
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)

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}
virtual std::string getName() const =0
Return a string that identifies this parametrization.
virtual Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy)=0
Return the size of the bounding box for the ellipse core.
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

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}
double constexpr PI
The ratio of a circle's circumference to diameter.
Definition Angle.h:40

◆ getDeterminantRadius()

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

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
inline

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}

◆ getName()

virtual std::string lsst::afw::geom::ellipses::BaseCore::getName ( ) const
pure virtual

◆ getParameterVector()

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

Return the core parameters as a vector.

Definition at line 143 of file BaseCore.cc.

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

◆ getTraceRadius()

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

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}
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)

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}
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)
static

Definition at line 55 of file BaseCore.cc.

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

◆ make() [2/6]

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

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 )
static

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 )
static

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 )
static

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 )
static

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()

virtual void lsst::afw::geom::ellipses::BaseCore::normalize ( )
pure virtual

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

Implemented in lsst::afw::geom::ellipses::Axes, lsst::afw::geom::ellipses::Quadrupole, and lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >.

◆ operator!=()

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

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); }
bool operator==(BaseCore const &other) const
Compare two ellipse cores for equality.
Definition BaseCore.cc:151

◆ operator=() [1/2]

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

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

Definition at line 166 of file BaseCore.cc.

166{ return *this = other; }

◆ operator=() [2/2]

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

Set the parameters of this ellipse core from another.

This does not change the parametrization of the ellipse core.

Definition at line 155 of file BaseCore.cc.

155 {
156 if (&other != this) {
157 // We use Axes instead of Quadrupole here because it allows us to copy Axes without
158 // implicitly normalizing them.
159 double a, b, theta;
160 other._assignToAxes(a, b, theta);
161 _assignFromAxes(a, b, theta);
162 }
163 return *this;
164}

◆ operator==()

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

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}
ParameterVector const getParameterVector() const
Return the core parameters as a vector.
Definition BaseCore.cc:143

◆ readParameters()

virtual void lsst::afw::geom::ellipses::BaseCore::readParameters ( double const * iter)
pure virtual

◆ registerSubclass()

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

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)

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}

◆ setParameterVector()

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

Set the core parameters from a vector.

Definition at line 149 of file BaseCore.cc.

149{ readParameters(p.data()); }
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)
inline

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}

◆ transform() [2/2]

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

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()

virtual void lsst::afw::geom::ellipses::BaseCore::writeParameters ( double * iter) const
pure virtual

Friends And Related Symbol Documentation

◆ Parametric

friend class Parametric
friend

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

Definition at line 189 of file BaseCore.h.


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