LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
Namespaces | Classes | Typedefs | Functions | Variables
lsst::afw::geom::ellipses Namespace Reference

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, 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 87 of file __init__.py.

87 def Ellipse_plot(self, axes=None, scale=1.0, show=True, rescale=True, **kwds):
88  """Plot the ellipse in matplotlib, adding a MatplotlibInterface
89  object as the 'matplotlib' attribute of the ellipse.
90 
91  Aside from those below, keyword arguments for the
92  matplotlib.patches.Patch constructor are also accepted
93  ('facecolor', 'linestyle', etc.)
94 
95  Parameters
96  ----------
97  axes : `matplotlib.axes.Axes`, optional
98  Axes to plot on. Defaults to matplotlib.pyplot.gca().
99  scale : `float`, optional
100  Scale the displayed ellipse by this factor.
101  show : `bool`, optional
102  If True, update the figure automatically. Set to False for batch
103  processing.
104  rescale : `bool`, optional
105  If True, rescale the axes.
106 
107  Returns
108  -------
109  interface : `EllipseMatplotlibInterface`
110  An object that allows the matplotlib patch to be updated when the
111  ellipse modified.
112  """
113  import matplotlib.pyplot
114  interface = self.MatplotlibInterface(self, scale, **kwds)
115  if axes is None:
116  axes = matplotlib.pyplot.gca()
117  axes.add_patch(interface.patch)
118  if rescale:
119  axes.autoscale_view()
120  if show:
121  axes.figure.canvas.draw()
122  return interface
123 
124 
125 Ellipse.MatplotlibInterface = EllipseMatplotlibInterface
126 Ellipse.plot = Ellipse_plot

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

lsst::afw::geom::ellipses.Ellipse_plot
def Ellipse_plot(self, axes=None, scale=1.0, show=True, rescale=True, **kwds)
Definition: __init__.py:87