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

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

#include <Ellipse.h>

Classes
class	Convolution
	A temporary-only expression object for ellipse convolution. More...
class	GridTransform
	A temporary-only expression object representing an 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 }
typedef Eigen::Matrix< double, 5, 1 >	ParameterVector
	Proxy return type for Ellipse::convolve(). More...
typedef boost::shared_ptr < Ellipse >	Ptr
typedef boost::shared_ptr < Ellipse const >	ConstPtr

Public Member Functions
Point2D const &	getCenter () const
	Return the center point. More...
Point2D &	getCenter ()
	Return the center point. More...
void	setCenter (Point2D const &center)
	Set the center point. More...
BaseCore const &	getCore () const
	Return the ellipse core. More...
BaseCore &	getCore ()
	Return the ellipse core. More...
BaseCore::ConstPtr	getCorePtr () const
	Return the ellipse core. More...
BaseCore::Ptr	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 (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
GridTransform const	getGridTransform () const
	Return the transform that maps the ellipse to the unit circle. More...
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...
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 ()
	Ellipse (BaseCore const &core, Point2D const &center=Point2D())
	Ellipse (BaseCore::ConstPtr const &core, Point2D const &center=Point2D())
	Ellipse (Transformer const &other)
	Ellipse (Convolution const &other)
	Ellipse (Ellipse const &other)
Coordinate transforms
These member functions transform the ellipse by the given 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 (AffineTransform const &transform)
Transformer const	transform (AffineTransform const &transform) const
Convolve two bivariate Gaussians defined by their 1-sigma ellipses.
Convolution	convolve (Ellipse const &other)
Convolution const	convolve (Ellipse const &other) const

Private Attributes
BaseCore::Ptr	_core
Point2D	_center

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 50 of file Ellipse.h.

Member Typedef Documentation

typedef boost::shared_ptr<Ellipse const> lsst::afw::geom::ellipses::Ellipse::ConstPtr

Definition at line 61 of file Ellipse.h.

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

Proxy return type for Ellipse::convolve().

Parameter vector type.

Definition at line 55 of file Ellipse.h.

typedef boost::shared_ptr<Ellipse> lsst::afw::geom::ellipses::Ellipse::Ptr

Definition at line 60 of file Ellipse.h.

Member Enumeration Documentation

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

Enumerator
X
Y

Definition at line 63 of file Ellipse.h.

{ X=3, Y=4 }; 

Constructor & Destructor Documentation

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

inlinevirtual

Definition at line 165 of file Ellipse.h.

{}

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

inlineexplicit

Definition at line 167 of file Ellipse.h.

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

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

inlineexplicit

Definition at line 170 of file Ellipse.h.

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

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

inline

Definition at line 133 of file Transformer.h.

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

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

(

Convolution const &

other

)

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

inline

Definition at line 178 of file Ellipse.h.

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

Member Function Documentation

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

(

)

const

Return the bounding box of the ellipse.

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

inline

Definition at line 105 of file Convolution.h.

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

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

inline

Definition at line 109 of file Convolution.h.

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

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

inline

Return the center point.

Definition at line 66 of file Ellipse.h.

{ return _center; }

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

inline

Return the center point.

Definition at line 69 of file Ellipse.h.

{ return _center; }

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

inline

Return the ellipse core.

Definition at line 75 of file Ellipse.h.

{ return *_core; }

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

inline

Return the ellipse core.

Definition at line 78 of file Ellipse.h.

{ return *_core; }

BaseCore::ConstPtr lsst::afw::geom::ellipses::Ellipse::getCorePtr ( ) const

inline

Return the ellipse core.

Definition at line 81 of file Ellipse.h.

{ return _core; }

BaseCore::Ptr lsst::afw::geom::ellipses::Ellipse::getCorePtr ( )

inline

Return the ellipse core.

Definition at line 84 of file Ellipse.h.

{ return _core; }

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 AffineTransform and also supports differentiation.

Definition at line 114 of file GridTransform.h.

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

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

(

)

const

Return the ellipse parameters as a vector.

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 93 of file Ellipse.h.

{ _core->grow(buffer); }

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

inline

Put the parameters in a standard form.

Definition at line 90 of file Ellipse.h.

{ _core->normalize(); }

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 163 of file Ellipse.h.

{ return !operator==(other); }

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.

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 154 of file Ellipse.h.

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

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

(

double const *

iter

)

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

inline

Scale the size of the ellipse by the given factor.

Definition at line 96 of file Ellipse.h.

{ _core->scale(factor); }

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

inline

Set the center point.

Definition at line 72 of file Ellipse.h.

{ _center = center; }

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 87 of file Ellipse.h.

{ *_core = core; }

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

(

ParameterVector const &

vector

)

Set the ellipse parameters from a vector.

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

inline

Move the ellipse center by the given offset.

Definition at line 99 of file Ellipse.h.

{ _center += offset; }

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

inline

Definition at line 125 of file Transformer.h.

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

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

inline

Definition at line 129 of file Transformer.h.

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

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

(

double *

iter

)

const

Member Data Documentation

Point2D lsst::afw::geom::ellipses::Ellipse::_center

private

Definition at line 183 of file Ellipse.h.

BaseCore::Ptr lsst::afw::geom::ellipses::Ellipse::_core

private

Definition at line 182 of file Ellipse.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/ellipses/Ellipse.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/ellipses/Convolution.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/ellipses/GridTransform.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/ellipses/Transformer.h