lsst.afw.geom.polygon.polygonContinued.Polygon Class Reference

Public Member Functions
def	__repr__ (self)
def	__reduce__ (self)
def	__iter__ (self)
def	__getitem__ (self, i)
def	__len__ (self)
def	__contains__ (self, point)
def	display (self, xy0=None, frame=1, ctype=None)
def	plot (self, axes=None, **kwargs)

Detailed Description

Definition at line 29 of file polygonContinued.py.

Member Function Documentation

__contains__()

def lsst.afw.geom.polygon.polygonContinued.Polygon.__contains__	(		self,
			point
	)

point in polygon?

Definition at line 47 of file polygonContinued.py.

    def __contains__(self, point):
        """point in polygon?"""
        return self.contains(point)
 

__getitem__()

def lsst.afw.geom.polygon.polygonContinued.Polygon.__getitem__	(		self,
			i
	)

Definition at line 41 of file polygonContinued.py.

    def __getitem__(self, i):
        return [pt for pt in self][i]
 

__iter__()

def lsst.afw.geom.polygon.polygonContinued.Polygon.__iter__

(

self

)

Iterator over vertices

Definition at line 36 of file polygonContinued.py.

    def __iter__(self):
        """Iterator over vertices"""
        vertices = self.getVertices()
        return iter(vertices)
 

__len__()

def lsst.afw.geom.polygon.polygonContinued.Polygon.__len__

(

self

)

Definition at line 44 of file polygonContinued.py.

    def __len__(self):
        return self.getNumEdges()
 

__reduce__()

def lsst.afw.geom.polygon.polygonContinued.Polygon.__reduce__

(

self

)

Definition at line 33 of file polygonContinued.py.

    def __reduce__(self):
        return self.__class__, (self.getVertices(),)
 

__repr__()

def lsst.afw.geom.polygon.polygonContinued.Polygon.__repr__

(

self

)

Definition at line 30 of file polygonContinued.py.

    def __repr__(self):
        return f"{self.__class__.__name__}({[p for p in self.getVertices()]})"
 

display()

def lsst.afw.geom.polygon.polygonContinued.Polygon.display	(		self,
			xy0 = None,
			frame = 1,
			ctype = None
	)

Display polygon on existing frame

Definition at line 51 of file polygonContinued.py.

    def display(self, xy0=None, frame=1, ctype=None):
        """Display polygon on existing frame"""
        import lsst.geom
        import lsst.afw.display as afwDisplay
        xy0 = lsst.geom.Extent2D(0, 0) if xy0 is None else lsst.geom.Extent2D(xy0)
        disp = afwDisplay.Display(frame=frame)
        with disp.Buffering():
            for p1, p2 in self.getEdges():
                disp.line((p1 - xy0, p2 - xy0), ctype=ctype)
 

plot()

def lsst.afw.geom.polygon.polygonContinued.Polygon.plot	(		self,
			axes = None,
		**	kwargs
	)

Plot polygon with matplotlib

Parameters
----------
axes : `matplotlib.axes.Axes`
    Matplotlib axes to use, or None
kwargs : any
    Additional arguments to `matplotlib.axes.Axes.plot`
    or `matplotlib.axes.Axes.scatter`.

Returns
-------
axes : `matplotlib.axes.Axes`
    The axes used to make the plot (same as ``axes``, if provided).

Definition at line 61 of file polygonContinued.py.

    def plot(self, axes=None, **kwargs):
        """Plot polygon with matplotlib
 
        Parameters
        ----------
        axes : `matplotlib.axes.Axes`
            Matplotlib axes to use, or None
        kwargs : any
            Additional arguments to `matplotlib.axes.Axes.plot`
            or `matplotlib.axes.Axes.scatter`.
 
        Returns
        -------
        axes : `matplotlib.axes.Axes`
            The axes used to make the plot (same as ``axes``, if provided).
        """
        import numpy
        if axes is None:
            import matplotlib.pyplot as plt
            plt.figure()
            axes = plt.axes()
        for p1, p2 in self.getEdges():
            x = (p1.getX(), p2.getX())
            y = (p1.getY(), p2.getY())
            axes.plot(x, y, **kwargs)
        vertices = self.getVertices()
        x = numpy.array([p[0] for p in vertices])
        y = numpy.array([p[1] for p in vertices])
        axes.scatter(x, y, **kwargs)
        return axes

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/0.4.1/Linux64/afw/21.0.0-16-g7a993c7b9+1041c3824f/python/lsst/afw/geom/polygon/polygonContinued.py