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

#include <Quadrupole.h>

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

Public Types
enum	ParameterEnum { IXX = 0, IYY = 1, IXY = 2 }

typedef Eigen::Matrix< double, 2, 2, Eigen::DontAlign >	Matrix
	Matrix type for the matrix representation of Quadrupole parameters. More...

typedef Eigen::Vector3d	ParameterVector
	Parameter vector type. More...

typedef Eigen::Matrix3d	Jacobian
	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

void	writeParameters (double *iter) const override

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...

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

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 with quadrupole moments as parameters.

Definition at line 47 of file Quadrupole.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.

◆ Matrix

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

Matrix type for the matrix representation of Quadrupole parameters.

Definition at line 52 of file Quadrupole.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

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

lsst::afw::geom::ellipses::Quadrupole::IXY

Definition: Quadrupole.h:49

lsst::afw::geom::ellipses::Quadrupole::IXX

Definition: Quadrupole.h:49

lsst::afw::geom::ellipses::Quadrupole::IYY

Definition: Quadrupole.h:49

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 60 of file Quadrupole.cc.

                                                                          {
     setIxx(ixx);
     setIyy(iyy);
     setIxy(ixy);
     if (normalize) this->normalize();
 }

◆ 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 67 of file Quadrupole.cc.

                                                                             {
     setIxx(vector[IXX]);
     setIyy(vector[IYY]);
     setIxy(vector[IXY]);
     if (normalize) this->normalize();
 }

◆ Quadrupole() [3/8]

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

explicit

Construct from a 2x2 matrix.

Definition at line 74 of file Quadrupole.cc.

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

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

other

ItemVariant const * other

Definition: Schema.cc:56

◆ 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:60

other

ItemVariant const * other

Definition: Schema.cc:56

◆ ~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; }

other

ItemVariant const * other

Definition: Schema.cc:56

◆ 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

Definition at line 219 of file BaseCore.cc.

                                                     {
     a *= a;
     b *= b;
     double c = std::cos(theta);
     double s = std::sin(theta);
     ixy = (a - b) * c * s;
     c *= c;
     s *= s;
     ixx = c * a + s * b;
     iyy = s * a + c * b;
 }

◆ _assignFromAxes()

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

overrideprotectedvirtual

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

Definition at line 112 of file Quadrupole.cc.

                                                                  {
     BaseCore::_assignAxesToQuadrupole(a, b, theta, _matrix(0, 0), _matrix(1, 1), _matrix(0, 1));
     _matrix(1, 0) = _matrix(0, 1);
 }

◆ _assignFromQuadrupole()

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

overrideprotectedvirtual

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

Definition at line 99 of file Quadrupole.cc.

                                                                          {
     setIxx(ixx);
     setIyy(iyy);
     setIxy(ixy);
 }

◆ _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.

                                                       {
     double xx_p_yy = ixx + iyy;
     double xx_m_yy = ixx - iyy;
     double t = std::sqrt(xx_m_yy * xx_m_yy + 4 * ixy * ixy);
     a = std::sqrt(0.5 * (xx_p_yy + t));
     b = std::sqrt(0.5 * (xx_p_yy - t));
     theta = 0.5 * std::atan2(2.0 * ixy, xx_m_yy);
 }

◆ _assignToAxes()

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

overrideprotectedvirtual

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

Definition at line 91 of file Quadrupole.cc.

                                                                         {
     BaseCore::_assignQuadrupoleToAxes(getIxx(), getIyy(), getIxy(), a, b, theta);
 }

◆ _assignToQuadrupole()

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

overrideprotectedvirtual

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

Definition at line 78 of file Quadrupole.cc.

                                                                                 {
     ixx = getIxx();
     iyy = getIyy();
     ixy = getIxy();
 }

◆ _clone()

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

inlineoverrideprotectedvirtual

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

Definition at line 232 of file BaseCore.cc.

                                                                                 {
     Jacobian m;
     m.col(0).setConstant(2 * a);
     m.col(1).setConstant(2 * b);
     a *= a;
     b *= b;
     m.col(2).setConstant(a - b);
     double c = std::cos(theta);
     double s = std::sin(theta);
     double cs = c * s;
     ixy = (a - b) * c * s;
     c *= c;
     s *= s;
     ixx = c * a + s * b;
     iyy = s * a + c * b;
     m(0, 0) *= c;
     m(0, 1) *= s;
     m(0, 2) *= -2.0 * cs;
     m(1, 0) *= s;
     m(1, 1) *= c;
     m(1, 2) *= 2.0 * cs;
     m(2, 0) *= cs;
     m(2, 1) *= -cs;
     m(2, 2) *= (c - s);
     return m;
 }

◆ _dAssignFromAxes()

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

overrideprotectedvirtual

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

Definition at line 117 of file Quadrupole.cc.

                                                                               {
     Jacobian r = BaseCore::_dAssignAxesToQuadrupole(a, b, theta, _matrix(0, 0), _matrix(1, 1), _matrix(0, 1));
     _matrix(1, 0) = _matrix(0, 1);
     return r;
 }

◆ _dAssignFromQuadrupole()

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

overrideprotectedvirtual

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

Definition at line 105 of file Quadrupole.cc.

                                                                                       {
     setIxx(ixx);
     setIyy(iyy);
     setIxy(ixy);
     return Jacobian::Identity();
 }

◆ _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.

                                                                                 {
     double xx_p_yy = ixx + iyy;
     double xx_m_yy = ixx - iyy;
     double t2 = xx_m_yy * xx_m_yy + 4.0 * ixy * ixy;
     Eigen::Vector3d dt2(2.0 * xx_m_yy, -2.0 * xx_m_yy, 8.0 * ixy);
     double t = std::sqrt(t2);
     a = std::sqrt(0.5 * (xx_p_yy + t));
     b = std::sqrt(0.5 * (xx_p_yy - t));
     theta = 0.5 * std::atan2(2.0 * ixy, xx_m_yy);
     Jacobian m = Jacobian::Zero();
     m(0, 0) = 0.25 * (1.0 + 0.5 * dt2[0] / t) / a;
     m(0, 1) = 0.25 * (1.0 + 0.5 * dt2[1] / t) / a;
     m(0, 2) = 0.25 * (0.5 * dt2[2] / t) / a;
     m(1, 0) = 0.25 * (1.0 - 0.5 * dt2[0] / t) / b;
     m(1, 1) = 0.25 * (1.0 - 0.5 * dt2[1] / t) / b;
     m(1, 2) = 0.25 * (-0.5 * dt2[2] / t) / b;
 
     m.row(2).setConstant(1.0 / (t * t));
     m(2, 0) *= -ixy;
     m(2, 1) *= ixy;
     m(2, 2) *= xx_m_yy;
     return m;
 }

◆ _dAssignToAxes()

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

overrideprotectedvirtual

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

Definition at line 95 of file Quadrupole.cc.

                                                                                      {
     return BaseCore::_dAssignQuadrupoleToAxes(getIxx(), getIyy(), getIxy(), a, b, theta);
 }

◆ _dAssignToQuadrupole()

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

overrideprotectedvirtual

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

Definition at line 84 of file Quadrupole.cc.

                                                                                              {
     ixx = getIxx();
     iyy = getIyy();
     ixy = getIxy();
     return Jacobian::Identity();
 }

◆ 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 238 of file BaseCore.h.

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

◆ 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::Quadrupole

Quadrupole(double ixx=1.0, double iyy=1.0, double ixy=0.0, bool normalize=false)

Construct from parameter values.

Definition: Quadrupole.cc:60

lsst::afw::geom::ellipses::Quadrupole::_clone

std::shared_ptr< BaseCore > _clone() const override

Definition: Quadrupole.h:127

std::static_pointer_cast

T static_pointer_cast(T... args)

◆ 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.

                                                    {
     double a, b, theta;
     _assignToAxes(a, b, theta);
     double c = std::cos(theta);
     double s = std::sin(theta);
     c *= c;
     s *= s;
     b *= b;
     a *= a;
     lsst::geom::Extent2D dimensions(std::sqrt(b * s + a * c), std::sqrt(a * s + b * c));
     dimensions *= 2;
     return dimensions;
 }

◆ convolve() [1/2]

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

inlineinherited

Definition at line 93 of file Convolution.h.

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

◆ 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.

                                                                                {
     return BaseCore::Convolution(const_cast<BaseCore &>(*this), other);
 }

◆ 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.

                                                         {
     if (getName() == other.getName()) {
         this->operator=(other);
         return Jacobian::Identity();
     }
     // We use Quadrupole instead of Axes here because the ambiguity of the position angle
     // in the circular case causes some of the Jacobians to/from Axes to be undefined for
     // exact circles.  Quadrupoles don't have that problem, and the Axes-to-Axes case is
     // handled by the above if block.
     double ixx, iyy, ixy;
     Jacobian rhs = other._dAssignToQuadrupole(ixx, iyy, ixy);
     Jacobian lhs = _dAssignFromQuadrupole(ixx, iyy, ixy);
     return lhs * rhs;
 }

◆ 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.

                                {
     double a, b, theta;
     _assignToAxes(a, b, theta);
     return a * b * lsst::geom::PI;
 }

◆ 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(); }

lsst::afw::geom::ellipses::Quadrupole::getIxy

double const getIxy() const

Definition: Quadrupole.h:60

lsst::afw::geom::ellipses::Quadrupole::getIyy

double const getIyy() const

Definition: Quadrupole.h:57

lsst::afw::geom::ellipses::Quadrupole::getIxx

double const getIxx() const

Definition: Quadrupole.h:54

◆ 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.

                                             {
     double a, b, theta;
     _assignToAxes(a, b, theta);
     return std::sqrt(a * b);
 }

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

                                                                     {
     return BaseCore::GridTransform(*this);
 }

◆ 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 34 of file Quadrupole.cc.

34 { return "Quadrupole"; }

◆ 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.

                                                                  {
     ParameterVector r;
     writeParameters(r.data());
     return r;
 }

◆ 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.

                                       {
     double ixx, iyy, ixy;
     _assignToQuadrupole(ixx, iyy, ixy);
     return std::sqrt(0.5 * (ixx + iyy));
 }

◆ 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.

                                  {
     double a, b, theta;
     _assignToAxes(a, b, theta);
     a += buffer;
     b += buffer;
     _assignFromAxes(a, b, theta);
 }

◆ 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.

                                                             {
     std::shared_ptr<BaseCore> result = getRegistryCopy(name);
     *result = Quadrupole();
     return result;
 }

◆ 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.

                                                                                                {
     std::shared_ptr<BaseCore> result = getRegistryCopy(name);
     result->setParameterVector(parameters);
     return result;
 }

◆ 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.

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

◆ 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.

                                                                                    {
     std::shared_ptr<BaseCore> result = getRegistryCopy(name);
     *result = other;
     return result;
 }

◆ 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.

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

◆ 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.

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

◆ 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 36 of file Quadrupole.cc.

                            {
     if (_matrix(0, 1) != _matrix(1, 0))
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                           "Quadrupole matrix must be symmetric.");
     if (getIxx() < 0 || getIyy() < 0)
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                           "Quadrupole matrix cannot have negative diagonal elements.");
     if (getDeterminant() < 0)
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                           "Quadrupole matrix cannot have negative determinant.");
 }

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

other

ItemVariant const * other

Definition: Schema.cc:56

lsst::afw::geom::ellipses::BaseCore::operator==

bool operator==(BaseCore const &other) const

Compare two ellipse cores for equality.

Definition: BaseCore.cc:152

◆ operator=() [1/3]

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

inline

Standard assignment.

Definition at line 86 of file Quadrupole.h.

                                                    {
         _matrix = other._matrix;
         return *this;
     }

◆ 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; }

other

ItemVariant const * other

Definition: Schema.cc:56

◆ operator=() [3/3]

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

inline

Converting assignment.

Definition at line 95 of file Quadrupole.h.

                                                  {
         BaseCore::operator=(other);
         return *this;
     }

◆ 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.

                                                      {
     return getParameterVector() == other.getParameterVector() && getName() == other.getName();
 }

◆ readParameters()

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

overridevirtual

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

Definition at line 48 of file Quadrupole.cc.

                                                   {
     setIxx(*iter++);
     setIyy(*iter++);
     setIxy(*iter++);
 }

◆ registerSubclass()

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

staticprotectedinherited

Definition at line 92 of file BaseCore.cc.

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

◆ 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.

                                   {
     double a, b, theta;
     _assignToAxes(a, b, theta);
     a *= factor;
     b *= factor;
     _assignFromAxes(a, b, theta);
 }

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

150 { readParameters(p.data()); }

lsst::afw::geom::ellipses::BaseCore::readParameters

virtual void readParameters(double const *iter)=0

◆ 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.

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

◆ 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.

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

◆ writeParameters()

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

overridevirtual

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

Definition at line 54 of file Quadrupole.cc.

                                                    {
     *iter++ = getIxx();
     *iter++ = getIyy();
     *iter++ = getIxy();
 }

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

/j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/geom/ellipses/Quadrupole.h
/j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/geom/ellipses/Quadrupole.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Jacobian

◆ Matrix

◆ ParameterVector

Member Enumeration Documentation

◆ ParameterEnum

Constructor & Destructor Documentation

◆ Quadrupole() [1/8]

◆ Quadrupole() [2/8]

◆ Quadrupole() [3/8]

◆ Quadrupole() [4/8]

◆ Quadrupole() [5/8]

◆ ~Quadrupole()

◆ Quadrupole() [6/8]

◆ Quadrupole() [7/8]

◆ Quadrupole() [8/8]

Member Function Documentation

◆ _assignAxesToQuadrupole()

◆ _assignFromAxes()

◆ _assignFromQuadrupole()

◆ _assignQuadrupoleToAxes()

◆ _assignToAxes()

◆ _assignToQuadrupole()

◆ _clone()

◆ _dAssignAxesToQuadrupole()

◆ _dAssignFromAxes()

◆ _dAssignFromQuadrupole()

◆ _dAssignQuadrupoleToAxes()

◆ _dAssignToAxes()

◆ _dAssignToQuadrupole()

◆ as()

◆ clone()

◆ computeDimensions()

◆ convolve() [1/2]

◆ convolve() [2/2]

◆ dAssign()

◆ getArea()

◆ getDeterminant()

◆ getDeterminantRadius()

◆ getGridTransform()

◆ getIxx()

◆ getIxy()

◆ getIyy()

◆ getMatrix()

◆ getName()

◆ getParameterVector()

◆ getTraceRadius()

◆ grow()

◆ make() [1/6]

◆ make() [2/6]

◆ make() [3/6]

◆ make() [4/6]

◆ make() [5/6]

◆ make() [6/6]

◆ normalize()

◆ operator!=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ readParameters()

◆ registerSubclass()

◆ scale()

◆ setIxx()

◆ setIxy()

◆ setIyy()

◆ setParameterVector()

◆ transform() [1/2]

◆ transform() [2/2]

◆ writeParameters()