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:

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

using	Jacobian = Eigen::Matrix3d
	Parameter Jacobian matrix type. More...

Public Member Functions
virtual std::string	getName () const =0
	Return a string that identifies this parametrization. More...

std::shared_ptr< BaseCore >	clone () const
	Deep-copy the Core. More...

virtual void	normalize ()=0
	Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normalized. 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)

Convolve two bivariate Gaussians defined by their 1-sigma ellipses.
class	Parametric
	Return the size of the bounding box for the ellipse core. More...

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

virtual void	readParameters (double const *iter)=0
	Return the size of the bounding box for the ellipse core. More...

virtual void	writeParameters (double *iter) const =0
	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...

BaseCore &	operator= (BaseCore const &other)
	Set the parameters of this ellipse core from another. More...

BaseCore &	operator= (BaseCore &&other)
	Return the size of the bounding box for the ellipse core. 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...

virtual	~BaseCore ()=default
	Return the size of the bounding box for the ellipse core. More...

	BaseCore ()=default
	Return the size of the bounding box for the ellipse core. More...

virtual std::shared_ptr< BaseCore >	_clone () const =0
	Return the size of the bounding box for the ellipse core. More...

virtual void	_assignToQuadrupole (double &ixx, double &iyy, double &ixy) const =0
	Return the size of the bounding box for the ellipse core. More...

virtual void	_assignFromQuadrupole (double ixx, double iyy, double ixy)=0
	Return the size of the bounding box for the ellipse core. More...

virtual void	_assignToAxes (double &a, double &b, double &theta) const =0
	Return the size of the bounding box for the ellipse core. More...

virtual void	_assignFromAxes (double a, double b, double theta)=0
	Return the size of the bounding box for the ellipse core. More...

virtual Jacobian	_dAssignToQuadrupole (double &ixx, double &iyy, double &ixy) const =0
	Return the size of the bounding box for the ellipse core. More...

virtual Jacobian	_dAssignFromQuadrupole (double ixx, double iyy, double ixy)=0
	Return the size of the bounding box for the ellipse core. More...

virtual Jacobian	_dAssignToAxes (double &a, double &b, double &theta) const =0
	Return the size of the bounding box for the ellipse core. More...

virtual Jacobian	_dAssignFromAxes (double a, double b, double theta)=0
	Return the size of the bounding box for the ellipse core. 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

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

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

Parameter Jacobian matrix type.

Definition at line 64 of file BaseCore.h.

◆ ParameterVector

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

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.

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

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

protectedpure virtual

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

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

◆ _assignFromQuadrupole()

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

protectedpure virtual

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

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

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

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

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

protectedpure virtual

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

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

◆ _assignToQuadrupole()

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

protectedpure virtual

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

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

◆ _clone()

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

protectedpure virtual

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

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

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

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

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

protectedpure virtual

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

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

◆ _dAssignFromQuadrupole()

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

protectedpure virtual

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

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

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

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

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

protectedpure virtual

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

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

◆ _dAssignToQuadrupole()

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

protectedpure virtual

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

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

◆ as()

template<typename Output >

BaseCore::Converter< Output > lsst::afw::geom::ellipses::BaseCore::as

inline

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

inline

Deep-copy the Core.

Definition at line 82 of file BaseCore.h.

82 { return _clone(); }

lsst::afw::geom::ellipses::BaseCore::_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.

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

inline

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

Definition at line 91 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

inline

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

Definition at line 95 of file Convolution.h.

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

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

                                                         {
     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

Return the area of the ellipse core.

Definition at line 111 of file BaseCore.cc.

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

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

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

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

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

◆ getName()

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

pure virtual

Return a string that identifies this parametrization.

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

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

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

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

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

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

Definition at line 95 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 )

static

Definition at line 55 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,
		BaseCore const &	other
	)

static

Definition at line 73 of file BaseCore.cc.

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

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

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

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

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

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

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

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

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

◆ 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::Separable< Ellipticity_, Radius_ >, lsst::afw::geom::ellipses::Quadrupole, and lsst::afw::geom::ellipses::Axes.

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

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

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.

                                                    {
     if (&other != this) {
         // We use Axes instead of Quadrupole here because it allows us to copy Axes without
         // implicitly normalizing them.
         double a, b, theta;
         other._assignToAxes(a, b, theta);
         _assignFromAxes(a, b, theta);
     }
     return *this;
 }

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

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

◆ readParameters()

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

pure virtual

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

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

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

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

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

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

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

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 )

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.

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

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

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

◆ writeParameters()

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

pure virtual

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

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

Friends And Related Function 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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/geom/ellipses/BaseCore.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/geom/ellipses/Convolution.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/geom/ellipses/GridTransform.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/geom/ellipses/Transformer.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/geom/ellipses/BaseCore.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

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

Detailed Description

Member Typedef Documentation

◆ Jacobian

◆ ParameterVector

Constructor & Destructor Documentation

◆ ~BaseCore()

◆ BaseCore()

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

◆ getDeterminantRadius()

◆ getGridTransform()

◆ 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/2]

◆ operator=() [2/2]

◆ operator==()

◆ readParameters()

◆ registerSubclass()

◆ scale()

◆ setParameterVector()

◆ transform() [1/2]

◆ transform() [2/2]

◆ writeParameters()

Friends And Related Function Documentation

◆ Parametric