lsst.afw g3a5ebb7d8a+28b83bf6a5
Loading...
Searching...
No Matches
lsst::afw::geom::ellipses Namespace Reference

Namespaces

namespace  _axes
namespace  _ellipse
namespace  _quadrupole
namespace  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  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

using SeparableDistortionDeterminantRadius = Separable<Distortion, DeterminantRadius>
using SeparableDistortionTraceRadius = Separable<Distortion, TraceRadius>
using SeparableDistortionLogDeterminantRadius = Separable<Distortion, LogDeterminantRadius>
using SeparableDistortionLogTraceRadius = Separable<Distortion, LogTraceRadius>
using SeparableConformalShearDeterminantRadius = Separable<ConformalShear, DeterminantRadius>
using SeparableConformalShearTraceRadius = Separable<ConformalShear, TraceRadius>
using SeparableConformalShearLogDeterminantRadius = Separable<ConformalShear, LogDeterminantRadius>
using SeparableConformalShearLogTraceRadius = Separable<ConformalShear, LogTraceRadius>
using SeparableReducedShearDeterminantRadius = Separable<ReducedShear, DeterminantRadius>
using SeparableReducedShearTraceRadius = Separable<ReducedShear, TraceRadius>
using SeparableReducedShearLogDeterminantRadius = Separable<ReducedShear, LogDeterminantRadius>
using SeparableReducedShearLogTraceRadius = Separable<ReducedShear, LogTraceRadius>

Functions

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

Variables

dict Separable
 MatplotlibInterface
 plot
template<typename Ellipticity_, typename Radius_>
BaseCore::Registrar< Separable< Ellipticity_, Radius_ > > Separable< Ellipticity_, Radius_ >::registrar

Detailed Description

lsst.afw.geom.ellipses

Typedef Documentation

◆ SeparableConformalShearDeterminantRadius

◆ SeparableConformalShearLogDeterminantRadius

◆ SeparableConformalShearLogTraceRadius

◆ SeparableConformalShearTraceRadius

◆ SeparableDistortionDeterminantRadius

◆ SeparableDistortionLogDeterminantRadius

◆ SeparableDistortionLogTraceRadius

◆ SeparableDistortionTraceRadius

◆ SeparableReducedShearDeterminantRadius

◆ SeparableReducedShearLogDeterminantRadius

◆ SeparableReducedShearLogTraceRadius

◆ SeparableReducedShearTraceRadius

Function Documentation

◆ Ellipse_plot()

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

◆ MatplotlibInterface

lsst.afw.geom.ellipses.MatplotlibInterface

Definition at line 128 of file __init__.py.

◆ plot

lsst.afw.geom.ellipses.plot

Definition at line 129 of file __init__.py.

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

◆ Separable< Ellipticity_, Radius_ >::registrar

template<typename Ellipticity_, typename Radius_>
BaseCore::Registrar<Separable<Ellipticity_, Radius_> > lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::registrar

Definition at line 36 of file Separable.cc.