LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Namespaces | Classes | Typedefs | Functions | Variables
lsst.afw.geom.ellipses Namespace Reference

Namespaces

 detail
 

Classes

class  EllipseMatplotlibInterface
 
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
 
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...
 

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
 

Variables

dictionary Separable
 
 matplotlib
 

Typedef Documentation

Definition at line 55 of file ellipses.h.

Definition at line 57 of file ellipses.h.

Definition at line 58 of file ellipses.h.

Definition at line 56 of file ellipses.h.

Definition at line 50 of file ellipses.h.

Definition at line 52 of file ellipses.h.

Definition at line 53 of file ellipses.h.

Definition at line 51 of file ellipses.h.

Definition at line 60 of file ellipses.h.

Definition at line 62 of file ellipses.h.

Definition at line 63 of file ellipses.h.

Definition at line 61 of file ellipses.h.

Function Documentation

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.)

Arguments:
axes -------- A matplotlib.axes.Axes object, or None to use
matplotlib.pyplot.gca().
scale ------- Scale the displayed ellipse by this factor.
show -------- If True, update the figure automatically.  Set
to False for batch processing.
rescale ----- If True, rescale the axes.

Definition at line 85 of file __init__.py.

85 
86 def Ellipse_plot(self, axes=None, scale=1.0, show=True, rescale=True, **kwds):
87  """Plot the ellipse in matplotlib, adding a MatplotlibInterface
88  object as the 'matplotlib' attribute of the ellipse.
89 
90  Aside from those below, keyword arguments for the
91  matplotlib.patches.Patch constructor are also accepted
92  ('facecolor', 'linestyle', etc.)
93 
94  Arguments:
95  axes -------- A matplotlib.axes.Axes object, or None to use
96  matplotlib.pyplot.gca().
97  scale ------- Scale the displayed ellipse by this factor.
98  show -------- If True, update the figure automatically. Set
99  to False for batch processing.
100  rescale ----- If True, rescale the axes.
101  """
102  import matplotlib.pyplot
103  self.matplotlib = self.MatplotlibInterface(self, scale, **kwds)
104  if axes is None:
105  axes = matplotlib.pyplot.gca()
106  axes.add_patch(self.matplotlib.patch)
107  if rescale: axes.autoscale_view()
108  if show: axes.figure.canvas.draw()
109  return self.matplotlib.patch
110 
111 
112 Ellipse.MatplotlibInterface = EllipseMatplotlibInterface
113 Ellipse.plot = Ellipse_plot

Variable Documentation

lsst.afw.geom.ellipses.matplotlib

Definition at line 102 of file __init__.py.

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