lsst::afw::geom::ellipses::Ellipse Class Reference

An ellipse defined by an arbitrary BaseCore and a center point. More...

#include <Ellipse.h>

Classes
class	GridTransform
	A temporary-only expression object representing an lsst::geom::AffineTransform that maps the Ellipse to a unit circle at the origin. More...
class	Transformer
	A temporary-only expression object for ellipse transformations. More...

Public Types
enum	ParameterEnum { X = 3 , Y = 4 }
using	ParameterVector = Eigen::Matrix< double, 5, 1 >
	Parameter vector type. More...

Public Member Functions
lsst::geom::Point2D const &	getCenter () const
	Return the center point. More...
lsst::geom::Point2D &	getCenter ()
	Return the center point. More...
void	setCenter (lsst::geom::Point2D const &center)
	Set the center point. More...
BaseCore const &	getCore () const
	Return the ellipse core. More...
BaseCore &	getCore ()
	Return the ellipse core. More...
std::shared_ptr< BaseCore const >	getCorePtr () const
	Return the ellipse core. More...
std::shared_ptr< BaseCore >	getCorePtr ()
	Return the ellipse core. More...
void	setCore (BaseCore const &core)
	Set the ellipse core; the type of the core is not changed. More...
void	normalize ()
	Put the parameters in a standard form. More...
void	grow (double buffer)
	Increase the major and minor radii of the ellipse by the given buffer. More...
void	scale (double factor)
	Scale the size of the ellipse by the given factor. More...
void	shift (lsst::geom::Extent2D const &offset)
	Move the ellipse center by the given offset. More...
ParameterVector const	getParameterVector () const
	Return the ellipse parameters as a vector. More...
void	setParameterVector (ParameterVector const &vector)
	Set the ellipse parameters from a vector. More...
void	readParameters (double const *iter)
void	writeParameters (double *iter) const
Coordinate transforms
These member functions transform the ellipse by the given lsst::geom::AffineTransform. 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::AffineTransform const &transform)
Transformer const	transform (lsst::geom::AffineTransform const &transform) const

Convolve two bivariate Gaussians defined by their 1-sigma ellipses.
Convolution	convolve (Ellipse const &other)
	Return the transform that maps the ellipse to the unit circle. More...
Convolution const	convolve (Ellipse const &other) 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...
lsst::geom::Box2D	computeBBox () const
	Return the bounding box of the ellipse. More...
Ellipse &	operator= (Ellipse const &other)
	Set the parameters of this ellipse from another. More...
Ellipse &	operator= (Ellipse &&other)
	Return the transform that maps the ellipse to the unit circle. More...
bool	operator== (Ellipse const &other) const
	Compare two ellipses for equality. More...
bool	operator!= (Ellipse const &other) const
	Compare two ellipses for inequality. More...
virtual	~Ellipse ()=default
	Return the transform that maps the ellipse to the unit circle. More...
	Ellipse (BaseCore const &core, lsst::geom::Point2D const &center=lsst::geom::Point2D())
	Return the transform that maps the ellipse to the unit circle. More...
	Ellipse (std::shared_ptr< BaseCore const > const &core, lsst::geom::Point2D const &center=lsst::geom::Point2D())
	Return the transform that maps the ellipse to the unit circle. More...
	Ellipse (Transformer const &other)
	Return the transform that maps the ellipse to the unit circle. More...
	Ellipse (Convolution const &other)
	Return the transform that maps the ellipse to the unit circle. More...
	Ellipse (Ellipse const &other)
	Return the transform that maps the ellipse to the unit circle. More...
	Ellipse (Ellipse &&other)
	Return the transform that maps the ellipse to the unit circle. More...

Detailed Description

An ellipse defined by an arbitrary BaseCore and a center point.

An ellipse is composed of its center coordinate and its Core - a parametrization of the ellipticity and size of the ellipse. Setting the core of an ellipse never changes the type of the contained core, it merely sets the parameters of that core by converting the parameters.

Definition at line 51 of file Ellipse.h.

Member Typedef Documentation

ParameterVector

using lsst::afw::geom::ellipses::Ellipse::ParameterVector = Eigen::Matrix<double, 5, 1>

Parameter vector type.

Definition at line 57 of file Ellipse.h.

Member Enumeration Documentation

ParameterEnum

enum lsst::afw::geom::ellipses::Ellipse::ParameterEnum

Enumerator
X
Y

Definition at line 59 of file Ellipse.h.

{ X = 3, Y = 4 };  

Constructor & Destructor Documentation

~Ellipse()

virtual lsst::afw::geom::ellipses::Ellipse::~Ellipse ( )

virtualdefault

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

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

Ellipse() [1/6]

lsst::afw::geom::ellipses::Ellipse::Ellipse ( BaseCore const &  core, lsst::geom::Point2D const &  center = lsst::geom::Point2D()  )

inlineexplicit

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

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

Definition at line 164 of file Ellipse.h.

            : _core(core.clone()), _center(center) {}

Ellipse() [2/6]

lsst::afw::geom::ellipses::Ellipse::Ellipse ( std::shared_ptr< BaseCore const > const &  core, lsst::geom::Point2D const &  center = lsst::geom::Point2D()  )

inlineexplicit

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

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

Definition at line 167 of file Ellipse.h.

            : _core(core->clone()), _center(center) {}

Ellipse() [3/6]

lsst::afw::geom::ellipses::Ellipse::Ellipse ( Ellipse::Transformer const &  other )

inline

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

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

Definition at line 132 of file Transformer.h.

        : _core(other.input.getCore().transform(other.transform.getLinear()).copy()),
          _center(other.transform(other.input.getCenter())) {}

Ellipse() [4/6]

lsst::afw::geom::ellipses::Ellipse::Ellipse

(

Convolution const &

other

)

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

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

Definition at line 75 of file Convolution.cc.

        : _core(convolution.self.getCore().convolve(convolution.other.getCore()).copy()),
          _center(convolution.self.getCenter() + lsst::geom::Extent2D(convolution.other.getCenter())) {}

Ellipse() [5/6]

lsst::afw::geom::ellipses::Ellipse::Ellipse ( Ellipse const &  other )

inline

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

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

Definition at line 174 of file Ellipse.h.

: _core(other.getCore().clone()), _center(other.getCenter()) {}

Ellipse() [6/6]

lsst::afw::geom::ellipses::Ellipse::Ellipse ( Ellipse &&  other )

inline

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

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

Definition at line 176 of file Ellipse.h.

: Ellipse(other) {}

Member Function Documentation

computeBBox()

lsst::geom::Box2D lsst::afw::geom::ellipses::Ellipse::computeBBox

(

)

const

Return the bounding box of the ellipse.

Definition at line 55 of file Ellipse.cc.

                                         {
    lsst::geom::Extent2D dimensions = getCore().computeDimensions();
    return lsst::geom::Box2D(getCenter() - dimensions * 0.5, dimensions);
}

convolve() [1/2]

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

inline

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

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

Definition at line 99 of file Convolution.h.

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

convolve() [2/2]

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

inline

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

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

Definition at line 103 of file Convolution.h.

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

getCenter() [1/2]

lsst::geom::Point2D& lsst::afw::geom::ellipses::Ellipse::getCenter ( )

inline

Return the center point.

Definition at line 65 of file Ellipse.h.

{ return _center; }

getCenter() [2/2]

lsst::geom::Point2D const& lsst::afw::geom::ellipses::Ellipse::getCenter ( ) const

inline

Return the center point.

Definition at line 62 of file Ellipse.h.

{ return _center; }

getCore() [1/2]

BaseCore& lsst::afw::geom::ellipses::Ellipse::getCore ( )

inline

Return the ellipse core.

Definition at line 74 of file Ellipse.h.

{ return *_core; }

getCore() [2/2]

BaseCore const& lsst::afw::geom::ellipses::Ellipse::getCore ( ) const

inline

Return the ellipse core.

Definition at line 71 of file Ellipse.h.

{ return *_core; }

getCorePtr() [1/2]

std::shared_ptr<BaseCore> lsst::afw::geom::ellipses::Ellipse::getCorePtr ( )

inline

Return the ellipse core.

Definition at line 80 of file Ellipse.h.

{ return _core; }

getCorePtr() [2/2]

std::shared_ptr<BaseCore const> lsst::afw::geom::ellipses::Ellipse::getCorePtr ( ) const

inline

Return the ellipse core.

Definition at line 77 of file Ellipse.h.

{ return _core; }

getGridTransform()

Ellipse::GridTransform const lsst::afw::geom::ellipses::Ellipse::getGridTransform ( ) const

inline

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

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

Definition at line 114 of file GridTransform.h.

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

getParameterVector()

Ellipse::ParameterVector const lsst::afw::geom::ellipses::Ellipse::getParameterVector

(

)

const

Return the ellipse parameters as a vector.

Definition at line 31 of file Ellipse.cc.

                                                               {
    ParameterVector r;
    r.head<3>() = _core->getParameterVector();
    r.tail<2>() = _center.asEigen();
    return r;
}

grow()

void lsst::afw::geom::ellipses::Ellipse::grow ( double  buffer )

inline

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

Definition at line 89 of file Ellipse.h.

{ _core->grow(buffer); }

normalize()

void lsst::afw::geom::ellipses::Ellipse::normalize ( )

inline

Put the parameters in a standard form.

Definition at line 86 of file Ellipse.h.

{ _core->normalize(); }

operator!=()

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

inline

Compare two ellipses for inequality.

Ellipses are only equal if they have the same Core types.

Definition at line 160 of file Ellipse.h.

{ return !operator==(other); }

operator=() [1/2]

Ellipse & lsst::afw::geom::ellipses::Ellipse::operator=

(

Ellipse &&

other

)

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

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

Definition at line 66 of file Ellipse.cc.

{ return *this = other; }

operator=() [2/2]

Ellipse & lsst::afw::geom::ellipses::Ellipse::operator=

(

Ellipse const &

other

)

Set the parameters of this ellipse from another.

This does not change the parametrization of the ellipse.

Definition at line 60 of file Ellipse.cc.

                                                {
    _center = other.getCenter();
    *_core = other.getCore();
    return *this;
}

operator==()

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

inline

Compare two ellipses for equality.

Ellipses are only equal if they have the same Core types.

Definition at line 151 of file Ellipse.h.

                                                {
        return getCenter() == other.getCenter() && getCore() == other.getCore();
    }

readParameters()

void lsst::afw::geom::ellipses::Ellipse::readParameters

(

double const *

iter

)

Definition at line 43 of file Ellipse.cc.

                                               {
    _core->readParameters(iter);
    _center.setX(iter[3]);
    _center.setY(iter[4]);
}

scale()

void lsst::afw::geom::ellipses::Ellipse::scale ( double  factor )

inline

Scale the size of the ellipse by the given factor.

Definition at line 92 of file Ellipse.h.

{ _core->scale(factor); }

setCenter()

void lsst::afw::geom::ellipses::Ellipse::setCenter ( lsst::geom::Point2D const &  center )

inline

Set the center point.

Definition at line 68 of file Ellipse.h.

{ _center = center; }

setCore()

void lsst::afw::geom::ellipses::Ellipse::setCore ( BaseCore const &  core )

inline

Set the ellipse core; the type of the core is not changed.

Definition at line 83 of file Ellipse.h.

{ *_core = core; }

setParameterVector()

void lsst::afw::geom::ellipses::Ellipse::setParameterVector

(

Ellipse::ParameterVector const &

vector

)

Set the ellipse parameters from a vector.

Definition at line 38 of file Ellipse.cc.

                                                                     {
    _core->setParameterVector(vector.head<3>());
    _center = lsst::geom::Point2D(vector.tail<2>());
}

shift()

void lsst::afw::geom::ellipses::Ellipse::shift ( lsst::geom::Extent2D const &  offset )

inline

Move the ellipse center by the given offset.

Definition at line 95 of file Ellipse.h.

{ _center += offset; }

transform() [1/2]

Ellipse::Transformer lsst::afw::geom::ellipses::Ellipse::transform ( lsst::geom::AffineTransform const &  transform )

inline

Definition at line 124 of file Transformer.h.

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

transform() [2/2]

Ellipse::Transformer const lsst::afw::geom::ellipses::Ellipse::transform ( lsst::geom::AffineTransform const &  transform ) const

inline

Definition at line 128 of file Transformer.h.

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

writeParameters()

void lsst::afw::geom::ellipses::Ellipse::writeParameters

(

double *

iter

)

const

Definition at line 49 of file Ellipse.cc.

                                                {
    _core->writeParameters(iter);
    iter[3] = _center.getX();
    iter[4] = _center.getY();
}

---

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/Ellipse.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/Convolution.cc
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/geom/ellipses/Ellipse.cc