Polygon

class lsst.afw.geom.Polygon

Bases: Storable

Methods Summary

calculateArea(self)

calculateCenter(self)

calculatePerimeter(self)

contains(*args, **kwargs)

Overloaded function.

convexHull(self)

createImage(*args, **kwargs)

Overloaded function.

display([xy0, frame, ctype])

Display polygon on existing frame

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) → float
calculateCenter(self: lsst.afw.geom.Polygon) → lsst.geom.Point2D
calculatePerimeter(self: lsst.afw.geom.Polygon) → float
contains(*args, **kwargs)

Overloaded function.

  1. contains(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Point2D) -> bool

  2. contains(self: lsst.afw.geom.Polygon, arg0: collections.abc.Sequence[lsst.geom.Point2D]) -> list[bool]

  3. contains(self: lsst.afw.geom.Polygon, arg0: collections.abc.Sequence[lsst.geom.Point2I]) -> list[bool]

  4. contains(self: lsst.afw.geom.Polygon, arg0: typing.Annotated[numpy.typing.ArrayLike, numpy.float64], arg1: typing.Annotated[numpy.typing.ArrayLike, numpy.float64]) -> object

  5. contains(self: lsst.afw.geom.Polygon, arg0: typing.Annotated[numpy.typing.ArrayLike, numpy.float32], arg1: typing.Annotated[numpy.typing.ArrayLike, numpy.float32]) -> object

  6. contains(self: lsst.afw.geom.Polygon, arg0: typing.Annotated[numpy.typing.ArrayLike, numpy.int32], arg1: typing.Annotated[numpy.typing.ArrayLike, numpy.int32]) -> object

convexHull(self: lsst.afw.geom.Polygon) → lsst.afw.geom.Polygon
createImage(*args, **kwargs)

Overloaded function.

  1. createImage(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2I) -> lsst::afw::image::Image<float>

  2. createImage(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Extent2I) -> lsst::afw::image::Image<float>

display(xy0=None, frame=1, ctype=None)

Display polygon on existing frame

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

Overloaded function.

  1. intersection(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.Polygon) -> list[lsst.afw.geom.Polygon]

  2. intersection(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2D) -> list[lsst.afw.geom.Polygon]

intersectionSingle(*args, **kwargs)

Overloaded function.

  1. intersectionSingle(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.Polygon) -> lsst.afw.geom.Polygon

  2. intersectionSingle(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2D) -> lsst.afw.geom.Polygon

isPersistable(self: lsst.afw.geom.Polygon) → bool
overlaps(*args, **kwargs)

Overloaded function.

  1. overlaps(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.Polygon) -> bool

  2. overlaps(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2D) -> bool

plot(axes=None, **kwargs)

Plot polygon with matplotlib

Parameters:
axesmatplotlib.axes.Axes

Matplotlib axes to use, or None

kwargsany

Additional arguments to matplotlib.axes.Axes.plot or matplotlib.axes.Axes.scatter.

Returns:
axesmatplotlib.axes.Axes

The axes used to make the plot (same as axes, if provided).

static readFits(*args, **kwargs)

Overloaded function.

  1. readFits(fileName: str, hdu: typing.SupportsInt = -2147483648) -> lsst.afw.geom.Polygon

  2. readFits(manager: lsst.afw.fits._fits.MemFileManager, hdu: typing.SupportsInt = -2147483648) -> lsst.afw.geom.Polygon

subSample(*args, **kwargs)

Overloaded function.

  1. subSample(self: lsst.afw.geom.Polygon, arg0: typing.SupportsInt) -> lsst.afw.geom.Polygon

  2. subSample(self: lsst.afw.geom.Polygon, arg0: typing.SupportsFloat) -> lsst.afw.geom.Polygon

symDifference(*args, **kwargs)

Overloaded function.

  1. symDifference(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.Polygon) -> list[lsst.afw.geom.Polygon]

  2. symDifference(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2D) -> list[lsst.afw.geom.Polygon]

transform(*args, **kwargs)

Overloaded function.

  1. transform(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.TransformPoint2ToPoint2) -> lsst.afw.geom.Polygon

  2. transform(self: lsst.afw.geom.Polygon, arg0: lsst.geom.AffineTransform) -> lsst.afw.geom.Polygon

union(*args, **kwargs)

Overloaded function.

  1. union(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.Polygon) -> list[lsst.afw.geom.Polygon]

  2. union(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2D) -> list[lsst.afw.geom.Polygon]

unionSingle(*args, **kwargs)

Overloaded function.

  1. unionSingle(self: lsst.afw.geom.Polygon, arg0: lsst.afw.geom.Polygon) -> lsst.afw.geom.Polygon

  2. unionSingle(self: lsst.afw.geom.Polygon, arg0: lsst.geom.Box2D) -> lsst.afw.geom.Polygon

writeFits(*args, **kwargs)

Overloaded function.

  1. writeFits(self: lsst.afw.geom.Polygon, fileName: str, mode: str = ‘w’) -> None

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