Polygon

class lsst.afw.geom.Polygon

Bases: pybind11_builtins.pybind11_object

Methods Summary

calculateArea(self)
calculateCenter(self)
calculatePerimeter(self)
contains(self, arg0)
convexHull(self)
createImage(*args, **kwargs) Overloaded function.
display([xy0, frame, ctype]) Display polygon on existing frame in ds9
getBBox(self)
getEdges(self)
getNumEdges(self)
getVertices(self)
intersection(*args, **kwargs) Overloaded function.
intersectionSingle(*args, **kwargs) Overloaded function.
isPersistable(self)
overlaps(*args, **kwargs) Overloaded function.
plot([axes]) Plot polygon with matplotlib
readFits(*args, **kwargs) Overloaded function.
subSample(*args, **kwargs) Overloaded function.
symDifference(*args, **kwargs) Overloaded function.
transform(*args, **kwargs) Overloaded function.
union(*args, **kwargs) Overloaded function.
unionSingle(*args, **kwargs) Overloaded function.
writeFits(*args, **kwargs) Overloaded function.

Methods Documentation

calculateArea(self: lsst.afw.geom.polygon.polygon.Polygon) → float
calculateCenter(self: lsst.afw.geom.polygon.polygon.Polygon) → lsst.geom.Point2D
calculatePerimeter(self: lsst.afw.geom.polygon.polygon.Polygon) → float
contains(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Point2D) → bool
convexHull(self: lsst.afw.geom.polygon.polygon.Polygon) → lsst.afw.geom.polygon.polygon.Polygon
createImage(*args, **kwargs)

Overloaded function.

  1. createImage(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2I) -> lsst::afw::image::Image<float>
  2. createImage(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Extent2I) -> lsst::afw::image::Image<float>
display(xy0=None, frame=1, ctype=None)

Display polygon on existing frame in ds9

getBBox(self: lsst.afw.geom.polygon.polygon.Polygon) → lsst.geom.Box2D
getEdges(self: lsst.afw.geom.polygon.polygon.Polygon) → List[Tuple[lsst.geom.Point2D, lsst.geom.Point2D]]
getNumEdges(self: lsst.afw.geom.polygon.polygon.Polygon) → int
getVertices(self: lsst.afw.geom.polygon.polygon.Polygon) → List[lsst.geom.Point2D]
intersection(*args, **kwargs)

Overloaded function.

  1. intersection(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.afw.geom.polygon.polygon.Polygon) -> List[lsst.afw.geom.polygon.polygon.Polygon]
  2. intersection(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2D) -> List[lsst.afw.geom.polygon.polygon.Polygon]
intersectionSingle(*args, **kwargs)

Overloaded function.

  1. intersectionSingle(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.afw.geom.polygon.polygon.Polygon) -> lsst.afw.geom.polygon.polygon.Polygon
  2. intersectionSingle(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2D) -> lsst.afw.geom.polygon.polygon.Polygon
isPersistable(self: lsst.afw.geom.polygon.polygon.Polygon) → bool
overlaps(*args, **kwargs)

Overloaded function.

  1. overlaps(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.afw.geom.polygon.polygon.Polygon) -> bool
  2. overlaps(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2D) -> bool
plot(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).

readFits(*args, **kwargs)

Overloaded function.

  1. readFits(fileName: str, hdu: int=-2147483648) -> lsst.afw.geom.polygon.polygon.Polygon
  2. readFits(manager: lsst::afw::fits::MemFileManager, hdu: int=-2147483648) -> lsst.afw.geom.polygon.polygon.Polygon
subSample(*args, **kwargs)

Overloaded function.

  1. subSample(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: int) -> lsst.afw.geom.polygon.polygon.Polygon
  2. subSample(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: float) -> lsst.afw.geom.polygon.polygon.Polygon
symDifference(*args, **kwargs)

Overloaded function.

  1. symDifference(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.afw.geom.polygon.polygon.Polygon) -> List[lsst.afw.geom.polygon.polygon.Polygon]
  2. symDifference(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2D) -> List[lsst.afw.geom.polygon.polygon.Polygon]
transform(*args, **kwargs)

Overloaded function.

  1. transform(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst::afw::geom::Transform<lsst::afw::geom::Point2Endpoint, lsst::afw::geom::Point2Endpoint>) -> lsst.afw.geom.polygon.polygon.Polygon
  2. transform(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.AffineTransform) -> lsst.afw.geom.polygon.polygon.Polygon
union(*args, **kwargs)

Overloaded function.

  1. union(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.afw.geom.polygon.polygon.Polygon) -> List[lsst.afw.geom.polygon.polygon.Polygon]
  2. union(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2D) -> List[lsst.afw.geom.polygon.polygon.Polygon]
unionSingle(*args, **kwargs)

Overloaded function.

  1. unionSingle(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.afw.geom.polygon.polygon.Polygon) -> lsst.afw.geom.polygon.polygon.Polygon
  2. unionSingle(self: lsst.afw.geom.polygon.polygon.Polygon, arg0: lsst.geom.Box2D) -> lsst.afw.geom.polygon.polygon.Polygon
writeFits(*args, **kwargs)

Overloaded function.

  1. writeFits(self: lsst.afw.geom.polygon.polygon.Polygon, fileName: str, mode: str=’w’) -> None
  2. writeFits(self: lsst.afw.geom.polygon.polygon.Polygon, manager: lsst::afw::fits::MemFileManager, mode: str=’w’) -> None