Footprint#

class lsst.afw.detection.Footprint#

Bases: pybind11_object

Attributes Summary

`peaks`
`spans`

Methods Summary

`addPeak`(self, arg0, arg1, arg2)
`assign`(self, arg0)
`clipTo`(self, arg0)
`computeFluxFromArray`(image, xy0)	Calculate the total flux in the region of an image array contained in this Footprint.
`computeFluxFromImage`(image)	Calculate the total flux in the region of an Image contained in this Footprint.
`contains`(self, arg0)
`dilate`(args, *kwargs)	Overloaded function.
`erode`(args, *kwargs)	Overloaded function.
`getArea`(self)
`getBBox`(self)
`getCentroid`(self)
`getPeaks`(self)
`getRegion`(self)
`getShape`(self)
`getSpans`(self)
`intersect`(other[, copyPeaks])	Calculate the intersection of this Footprint with another Footprint.
`isContiguous`(self)
`isHeavy`(self)
`isPersistable`(self)
`readFits`(args, *kwargs)	Overloaded function.
`removeOrphanPeaks`(self)
`setPeakCatalog`(self, otherPeaks)
`setPeakSchema`(self, arg0)
`setRegion`(self, arg0)
`setSpans`(self, arg0)
`shift`(args, *kwargs)	Overloaded function.
`sortPeaks`(self, key)
`split`(self)
`transform`(args, *kwargs)	Overloaded function.
`updatePeakSignificance`(args, *kwargs)	Overloaded function.
`writeFits`(args, *kwargs)	Overloaded function.

Attributes Documentation

peaks#

spans#

Methods Documentation

addPeak(self: lsst.afw.detection.Footprint, arg0: SupportsFloat, arg1: SupportsFloat, arg2: SupportsFloat) → lsst.afw.detection.PeakRecord#

assign(self: lsst.afw.detection.Footprint, arg0: lsst.afw.detection.Footprint) → lsst.afw.detection.Footprint#

clipTo(self: lsst.afw.detection.Footprint, arg0: lsst.geom.Box2I) → None#

computeFluxFromArray(image: ndarray, xy0: Point2I) → float#

Calculate the total flux in the region of an image array contained in this Footprint.

Parameters#

image:: Array containing the pixels to extract.
xy0:: The origin of the image array.

Returns flux:

Flux from the image in pixels contained in the footprint.

computeFluxFromImage(image: Image) → float#

Calculate the total flux in the region of an Image contained in this Footprint.

Parameters#

image:: Image to extract.

Returns#

flux:: Flux from the image pixels contained in the footprint.

contains(self: lsst.afw.detection.Footprint, arg0: lsst.geom.Point2I) → bool#

dilate(*args, **kwargs)#

Overloaded function.

dilate(self: lsst.afw.detection.Footprint, r: typing.SupportsInt, stencil: lsst.afw.geom.Stencil = <Stencil.CIRCLE: 0>) -> None
dilate(self: lsst.afw.detection.Footprint, arg0: lsst.afw.geom.SpanSet) -> None

erode(*args, **kwargs)#

Overloaded function.

erode(self: lsst.afw.detection.Footprint, r: typing.SupportsInt, stencil: lsst.afw.geom.Stencil = <Stencil.CIRCLE: 0>) -> None
erode(self: lsst.afw.detection.Footprint, arg0: lsst.afw.geom.SpanSet) -> None

getArea(self: lsst.afw.detection.Footprint) → int#

getBBox(self: lsst.afw.detection.Footprint) → lsst.geom.Box2I#

getCentroid(self: lsst.afw.detection.Footprint) → lsst.geom.Point2D#

getPeaks(self: lsst.afw.detection.Footprint) → lsst.afw.detection.PeakCatalog#

getRegion(self: lsst.afw.detection.Footprint) → lsst.geom.Box2I#

getShape(self: lsst.afw.detection.Footprint) → lsst.afw.geom.ellipses.Quadrupole#

getSpans(self: lsst.afw.detection.Footprint) → lsst.afw.geom.SpanSet#

intersect(other: Footprint, copyPeaks: bool = True) → Footprint#

Calculate the intersection of this Footprint with another Footprint.

Parameters#

other:: The other Footprint.
copyPeaks:: Whether or not to copy the peaks from this Footprint. Note: the peaks in other are always ignored.

Returns#

result:: The Footprint containing the intersection of the two footprints.

isContiguous(self: lsst.afw.detection.Footprint) → bool#

isHeavy(self: lsst.afw.detection.Footprint) → bool#

isPersistable(self: lsst.afw.detection.Footprint) → bool#

static readFits(*args, **kwargs)#

Overloaded function.

readFits(fileName: str, hdu: typing.SupportsInt = -2147483648) -> lsst.afw.detection.Footprint
readFits(manager: lsst.afw.fits._fits.MemFileManager, hdu: typing.SupportsInt = -2147483648) -> lsst.afw.detection.Footprint

removeOrphanPeaks(self: lsst.afw.detection.Footprint) → None#

setPeakCatalog(self: lsst.afw.detection.Footprint, otherPeaks: lsst.afw.detection.PeakCatalog) → None#

setPeakSchema(self: lsst.afw.detection.Footprint, arg0: lsst.afw.table.Schema) → None#

setRegion(self: lsst.afw.detection.Footprint, arg0: lsst.geom.Box2I) → None#

setSpans(self: lsst.afw.detection.Footprint, arg0: lsst.afw.geom.SpanSet) → None#

shift(*args, **kwargs)#

Overloaded function.

shift(self: lsst.afw.detection.Footprint, arg0: typing.SupportsInt, arg1: typing.SupportsInt) -> None
shift(self: lsst.afw.detection.Footprint, arg0: lsst.geom.Extent2I) -> None

sortPeaks(self: lsst.afw.detection.Footprint, key: lsst.afw.table.KeyF = Key<F>(offset=0, nElements=1)) → None#

split(self: lsst.afw.detection.Footprint) → list#

transform(*args, **kwargs)#

Overloaded function.

transform(self: lsst.afw.detection.Footprint, source: lsst.afw.geom.SkyWcs, target: lsst.afw.geom.SkyWcs, region: lsst.geom.Box2I, doClip: bool = True) -> lsst.afw.detection.Footprint
transform(self: lsst.afw.detection.Footprint, arg0: lsst.geom.LinearTransform, arg1: lsst.geom.Box2I, arg2: bool) -> lsst.afw.detection.Footprint
transform(self: lsst.afw.detection.Footprint, arg0: lsst.geom.AffineTransform, arg1: lsst.geom.Box2I, arg2: bool) -> lsst.afw.detection.Footprint
transform(self: lsst.afw.detection.Footprint, arg0: lsst.afw.geom.TransformPoint2ToPoint2, arg1: lsst.geom.Box2I, arg2: bool) -> lsst.afw.detection.Footprint

updatePeakSignificance(*args, **kwargs)#

Overloaded function.

updatePeakSignificance(self: lsst.afw.detection.Footprint, arg0: typing.SupportsFloat) -> None
updatePeakSignificance(self: lsst.afw.detection.Footprint, arg0: lsst.afw.image._image.ImageF, arg1: typing.SupportsInt) -> None

writeFits(*args, **kwargs)#

Overloaded function.

writeFits(self: lsst.afw.detection.Footprint, fileName: str, mode: str = ‘w’) -> None
writeFits(self: lsst.afw.detection.Footprint, manager: lsst.afw.fits._fits.MemFileManager, mode: str = ‘w’) -> None