Ellipse#

class lsst.afw.geom.Ellipse#

Bases: pybind11_object

Methods Summary

computeBBox(self)

getCenter(self)

getCore(self)

getGridTransform(self)

getParameterVector(self)

grow(self, arg0)

normalize(self)

plot([axes, scale, show, rescale])

Plot the ellipse in matplotlib, adding a MatplotlibInterface object as the 'matplotlib' attribute of the ellipse.

scale(self, arg0)

setCenter(self, arg0)

setCore(self, arg0)

setParameterVector(self, arg0)

shift(self, arg0)

transform(self, transform)

Methods Documentation

computeBBox(self: lsst.afw.geom.ellipses.Ellipse) → lsst.geom.Box2D#
getCenter(self: lsst.afw.geom.ellipses.Ellipse) → lsst.geom.Point2D#
getCore(self: lsst.afw.geom.ellipses.Ellipse) → lsst.afw.geom.ellipses.BaseCore#
getGridTransform(self: lsst.afw.geom.ellipses.Ellipse) → lsst.geom.AffineTransform#
getParameterVector(self: lsst.afw.geom.ellipses.Ellipse) → Annotated[numpy.typing.NDArray[numpy.float64], '[5, 1]']#
grow(self: lsst.afw.geom.ellipses.Ellipse, arg0: SupportsFloat) → None#
normalize(self: lsst.afw.geom.ellipses.Ellipse) → None#
plot(axes=None, scale=1.0, show=True, rescale=True, **kwds)#

Plot the ellipse in matplotlib, adding a MatplotlibInterface object as the ‘matplotlib’ attribute of the ellipse.

Aside from those below, keyword arguments for the matplotlib.patches.Patch constructor are also accepted (‘facecolor’, ‘linestyle’, etc.)

Parameters#

axesmatplotlib.axes.Axes, optional

Axes to plot on. Defaults to matplotlib.pyplot.gca().

scalefloat, optional

Scale the displayed ellipse by this factor.

showbool, optional

If True, update the figure automatically. Set to False for batch processing.

rescalebool, optional

If True, rescale the axes.

Returns#

interfaceEllipseMatplotlibInterface

An object that allows the matplotlib patch to be updated when the ellipse modified.

scale(self: lsst.afw.geom.ellipses.Ellipse, arg0: SupportsFloat) → None#
setCenter(self: lsst.afw.geom.ellipses.Ellipse, arg0: lsst.geom.Point2D) → None#
setCore(self: lsst.afw.geom.ellipses.Ellipse, arg0: lsst.afw.geom.ellipses.BaseCore) → None#
setParameterVector(self: lsst.afw.geom.ellipses.Ellipse, arg0: Annotated[numpy.typing.ArrayLike, numpy.float64, '[5, 1]']) → None#
shift(self: lsst.afw.geom.ellipses.Ellipse, arg0: lsst.geom.Extent2D) → None#
transform(self: lsst.afw.geom.ellipses.Ellipse, transform: lsst.geom.AffineTransform) → lsst.afw.geom.ellipses.Ellipse#