lsst.afw  21.0.0-39-g68de21fec+f88c352dc9
Namespaces | Classes | Typedefs | Functions | Variables
lsst::afw::geom::ellipses Namespace Reference

Namespaces

 _axes
 
 _ellipse
 
 _quadrupole
 
 detail
 

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  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  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  Separable
 An ellipse core with a complex ellipticity and radius parameterization. More...
 
class  DeterminantRadius
 The radius defined as the 4th root of the determinant of the quadrupole matrix. More...
 
class  TraceRadius
 The radius defined as \(\sqrt{0.5(I_{xx} + I_{yy})}\). More...
 
class  LogDeterminantRadius
 The natural logarithm of the DeterminantRadius. More...
 
class  LogTraceRadius
 The natural logarithm of the TraceRadius. More...
 
class  ReducedShear
 A complex ellipticity with magnitude \(|e| = \frac{a-b}{a+b} \). More...
 
class  EllipseMatplotlibInterface
 
class  EllipseHorizontalLineIntersection
 

Typedefs

typedef Separable< Distortion, DeterminantRadiusSeparableDistortionDeterminantRadius
 
typedef Separable< Distortion, TraceRadiusSeparableDistortionTraceRadius
 
typedef Separable< Distortion, LogDeterminantRadiusSeparableDistortionLogDeterminantRadius
 
typedef Separable< Distortion, LogTraceRadiusSeparableDistortionLogTraceRadius
 
typedef Separable< ConformalShear, DeterminantRadiusSeparableConformalShearDeterminantRadius
 
typedef Separable< ConformalShear, TraceRadiusSeparableConformalShearTraceRadius
 
typedef Separable< ConformalShear, LogDeterminantRadiusSeparableConformalShearLogDeterminantRadius
 
typedef Separable< ConformalShear, LogTraceRadiusSeparableConformalShearLogTraceRadius
 
typedef Separable< ReducedShear, DeterminantRadiusSeparableReducedShearDeterminantRadius
 
typedef Separable< ReducedShear, TraceRadiusSeparableReducedShearTraceRadius
 
typedef Separable< ReducedShear, LogDeterminantRadiusSeparableReducedShearLogDeterminantRadius
 
typedef Separable< ReducedShear, LogTraceRadiusSeparableReducedShearLogTraceRadius
 

Functions

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

Variables

dictionary Separable
 

Typedef Documentation

◆ SeparableConformalShearDeterminantRadius

Definition at line 57 of file ellipses.h.

◆ SeparableConformalShearLogDeterminantRadius

Definition at line 59 of file ellipses.h.

◆ SeparableConformalShearLogTraceRadius

Definition at line 60 of file ellipses.h.

◆ SeparableConformalShearTraceRadius

Definition at line 58 of file ellipses.h.

◆ SeparableDistortionDeterminantRadius

Definition at line 52 of file ellipses.h.

◆ SeparableDistortionLogDeterminantRadius

Definition at line 54 of file ellipses.h.

◆ SeparableDistortionLogTraceRadius

Definition at line 55 of file ellipses.h.

◆ SeparableDistortionTraceRadius

Definition at line 53 of file ellipses.h.

◆ SeparableReducedShearDeterminantRadius

Definition at line 62 of file ellipses.h.

◆ SeparableReducedShearLogDeterminantRadius

Definition at line 64 of file ellipses.h.

◆ SeparableReducedShearLogTraceRadius

Definition at line 65 of file ellipses.h.

◆ 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 90 of file __init__.py.

Variable Documentation

◆ Separable

Initial value:
1 = {
2  (Distortion, DeterminantRadius): SeparableDistortionDeterminantRadius,
3  (Distortion, TraceRadius): SeparableDistortionTraceRadius,
4  (Distortion, LogDeterminantRadius): SeparableDistortionLogDeterminantRadius,
5  (Distortion, LogTraceRadius): SeparableDistortionLogTraceRadius,
6  (ConformalShear, DeterminantRadius): SeparableConformalShearDeterminantRadius,
7  (ConformalShear, TraceRadius): SeparableConformalShearTraceRadius,
8  (ConformalShear, LogDeterminantRadius): SeparableConformalShearLogDeterminantRadius,
9  (ConformalShear, LogTraceRadius): SeparableConformalShearLogTraceRadius
10 }

Definition at line 30 of file __init__.py.