Namespaces
	axes

	detail

	ellipse

	ellipsesLib

	quadrupole

Classes
class	Axes
	An ellipse core for the semimajor/semiminor axis and position angle parametrization (a,b,theta). More...

class	BaseCore
	A base class for parametrizations of the "core" of an ellipse - the ellipticity and size. More...

class	ConformalShear
	A logarithmic complex ellipticity with magnitude \(\|e\| = \ln (a/b) \). More...

class	DeterminantRadius
	The radius defined as the 4th root of the determinant of the quadrupole matrix. More...

class	Distortion
	A complex ellipticity with magnitude \(\|e\| = \frac{a^2 - b^2}{a^2 + b^2}\). More...

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

class	EllipseHorizontalLineIntersection

class	EllipseMatplotlibInterface

class	LogDeterminantRadius
	The natural logarithm of the DeterminantRadius. More...

class	LogTraceRadius
	The natural logarithm of the TraceRadius. More...

class	Parametric
	A functor that returns points on the boundary of the ellipse as a function of a parameter that runs between 0 and 2 pi (but is not angle). More...

class	PixelRegion
	A pixelized region containing all pixels whose centers are within an Ellipse. More...

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

class	ReducedShear
	A complex ellipticity with magnitude \(\|e\| = \frac{a-b}{a+b} \). More...

class	Separable
	An ellipse core with a complex ellipticity and radius parameterization. More...

class	TraceRadius
	The radius defined as \(\sqrt{0.5(I_{xx} + I_{yy})}\). More...

Typedefs
typedef Separable< Distortion, DeterminantRadius >	SeparableDistortionDeterminantRadius

typedef Separable< Distortion, TraceRadius >	SeparableDistortionTraceRadius

typedef Separable< Distortion, LogDeterminantRadius >	SeparableDistortionLogDeterminantRadius

typedef Separable< Distortion, LogTraceRadius >	SeparableDistortionLogTraceRadius

typedef Separable< ConformalShear, DeterminantRadius >	SeparableConformalShearDeterminantRadius

typedef Separable< ConformalShear, TraceRadius >	SeparableConformalShearTraceRadius

typedef Separable< ConformalShear, LogDeterminantRadius >	SeparableConformalShearLogDeterminantRadius

typedef Separable< ConformalShear, LogTraceRadius >	SeparableConformalShearLogTraceRadius

typedef Separable< ReducedShear, DeterminantRadius >	SeparableReducedShearDeterminantRadius

typedef Separable< ReducedShear, TraceRadius >	SeparableReducedShearTraceRadius

typedef Separable< ReducedShear, LogDeterminantRadius >	SeparableReducedShearLogDeterminantRadius

typedef Separable< ReducedShear, LogTraceRadius >	SeparableReducedShearLogTraceRadius

Functions
def	Ellipse_plot (self, axes=None, scale=1.0, show=True, rescale=True, kwds)

Variables
dictionary	Separable

Typedef Documentation

◆ SeparableConformalShearDeterminantRadius

typedef Separable<ConformalShear, DeterminantRadius> lsst::afw::geom::ellipses::SeparableConformalShearDeterminantRadius

Definition at line 57 of file ellipses.h.

◆ SeparableConformalShearLogDeterminantRadius

typedef Separable<ConformalShear, LogDeterminantRadius> lsst::afw::geom::ellipses::SeparableConformalShearLogDeterminantRadius

Definition at line 59 of file ellipses.h.

◆ SeparableConformalShearLogTraceRadius

typedef Separable<ConformalShear, LogTraceRadius> lsst::afw::geom::ellipses::SeparableConformalShearLogTraceRadius

Definition at line 60 of file ellipses.h.

◆ SeparableConformalShearTraceRadius

typedef Separable<ConformalShear, TraceRadius> lsst::afw::geom::ellipses::SeparableConformalShearTraceRadius

Definition at line 58 of file ellipses.h.

◆ SeparableDistortionDeterminantRadius

typedef Separable<Distortion, DeterminantRadius> lsst::afw::geom::ellipses::SeparableDistortionDeterminantRadius

Definition at line 52 of file ellipses.h.

◆ SeparableDistortionLogDeterminantRadius

typedef Separable<Distortion, LogDeterminantRadius> lsst::afw::geom::ellipses::SeparableDistortionLogDeterminantRadius

Definition at line 54 of file ellipses.h.

◆ SeparableDistortionLogTraceRadius

typedef Separable<Distortion, LogTraceRadius> lsst::afw::geom::ellipses::SeparableDistortionLogTraceRadius

Definition at line 55 of file ellipses.h.

◆ SeparableDistortionTraceRadius

typedef Separable<Distortion, TraceRadius> lsst::afw::geom::ellipses::SeparableDistortionTraceRadius

Definition at line 53 of file ellipses.h.

◆ SeparableReducedShearDeterminantRadius

typedef Separable<ReducedShear, DeterminantRadius> lsst::afw::geom::ellipses::SeparableReducedShearDeterminantRadius

Definition at line 62 of file ellipses.h.

◆ SeparableReducedShearLogDeterminantRadius

typedef Separable<ReducedShear, LogDeterminantRadius> lsst::afw::geom::ellipses::SeparableReducedShearLogDeterminantRadius

Definition at line 64 of file ellipses.h.

◆ SeparableReducedShearLogTraceRadius

typedef Separable<ReducedShear, LogTraceRadius> lsst::afw::geom::ellipses::SeparableReducedShearLogTraceRadius

Definition at line 65 of file ellipses.h.

◆ SeparableReducedShearTraceRadius

typedef Separable<ReducedShear, TraceRadius> lsst::afw::geom::ellipses::SeparableReducedShearTraceRadius

Definition at line 63 of file ellipses.h.

Function Documentation

◆ Ellipse_plot()

def lsst.afw.geom.ellipses.Ellipse_plot	(	self,
		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
----------
axes : `matplotlib.axes.Axes`, optional
    Axes to plot on.  Defaults to matplotlib.pyplot.gca().
scale : `float`, optional
    Scale the displayed ellipse by this factor.
show : `bool`, optional
    If True, update the figure automatically.  Set to False for batch
    processing.
rescale : `bool`, optional
    If True, rescale the axes.

Returns
-------
interface : `EllipseMatplotlibInterface`
    An object that allows the matplotlib patch to be updated when the
    ellipse modified.

Definition at line 87 of file __init__.py.

 def Ellipse_plot(self, 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
     ----------
     axes : `matplotlib.axes.Axes`, optional
         Axes to plot on.  Defaults to matplotlib.pyplot.gca().
     scale : `float`, optional
         Scale the displayed ellipse by this factor.
     show : `bool`, optional
         If True, update the figure automatically.  Set to False for batch
         processing.
     rescale : `bool`, optional
         If True, rescale the axes.
 
     Returns
     -------
     interface : `EllipseMatplotlibInterface`
         An object that allows the matplotlib patch to be updated when the
         ellipse modified.
     """
     import matplotlib.pyplot
     interface = self.MatplotlibInterface(self, scale, **kwds)
     if axes is None:
         axes = matplotlib.pyplot.gca()
     axes.add_patch(interface.patch)
     if rescale:
         axes.autoscale_view()
     if show:
         axes.figure.canvas.draw()
     return interface
 
 
 Ellipse.MatplotlibInterface = EllipseMatplotlibInterface
 Ellipse.plot = Ellipse_plot

Variable Documentation

◆ Separable

dictionary lsst.afw.geom.ellipses.Separable

Initial value:

 =  {
     (Distortion, DeterminantRadius): SeparableDistortionDeterminantRadius,
     (Distortion, TraceRadius): SeparableDistortionTraceRadius,
     (Distortion, LogDeterminantRadius): SeparableDistortionLogDeterminantRadius,
     (Distortion, LogTraceRadius): SeparableDistortionLogTraceRadius,
     (ConformalShear, DeterminantRadius): SeparableConformalShearDeterminantRadius,
     (ConformalShear, TraceRadius): SeparableConformalShearTraceRadius,
     (ConformalShear, LogDeterminantRadius): SeparableConformalShearLogDeterminantRadius,
     (ConformalShear, LogTraceRadius): SeparableConformalShearLogTraceRadius
 }

Definition at line 27 of file __init__.py.

Namespaces

Classes

Typedefs

Functions

Variables