HeavyFootprintF

class lsst.afw.detection.HeavyFootprintF

Bases: Footprint

Attributes Summary

peaks

spans

Methods Summary

addPeak(self, arg0, arg1, arg2)

addTo(image)

Add this heavy footprint to an image.

assign(self, arg0)

clipTo(self, arg0)

contains(self, arg0)

dilate(*args, **kwargs)

Overloaded function.

dot(self, arg0)

erode(*args, **kwargs)

Overloaded function.

extractImage([fill, bbox, imageType])

Create a 2D image of a HeavyFootprint

getArea(self)

getBBox(self)

getCentroid(self)

getImageArray(self)

getMaskArray(self)

getMaskBitsSet(self)

getPeaks(self)

getRegion(self)

getShape(self)

getSpans(self)

getVarianceArray(self)

insert(*args, **kwargs)

Overloaded function.

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)

subtractFrom(image)

Subtract this heavy footprint from an image.

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: float, arg1: float, arg2: float) lsst.afw.detection.PeakRecord
addTo(image)

Add this heavy footprint to an image.

Parameters:
imagelsst.afw.image
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
contains(self: lsst.afw.detection.Footprint, arg0: lsst.geom.Point2I) bool
dilate(*args, **kwargs)

Overloaded function.

  1. dilate(self: lsst.afw.detection.Footprint, r: int, stencil: lsst.afw.geom.Stencil = <Stencil.CIRCLE: 0>) -> None

  2. dilate(self: lsst.afw.detection.Footprint, arg0: lsst.afw.geom.SpanSet) -> None

dot(self: lsst.afw.detection.HeavyFootprintF, arg0: lsst.afw.detection.HeavyFootprintF) float
erode(*args, **kwargs)

Overloaded function.

  1. erode(self: lsst.afw.detection.Footprint, r: int, stencil: lsst.afw.geom.Stencil = <Stencil.CIRCLE: 0>) -> None

  2. erode(self: lsst.afw.detection.Footprint, arg0: lsst.afw.geom.SpanSet) -> None

extractImage(fill=nan, bbox=None, imageType=None)

Create a 2D image of a HeavyFootprint

Parameters:
fill: number

Number to fill the pixels in the image that are not contained in heavy.

bboxBox2I

Bounding box of the output image.

imageTypetype

This should be either a MaskedImage or Image and describes the type of the output image. If imageType is None then Image will be used.

Returns:
imagelsst.afw.image.MaskedImage or lsst.afw.image.Image

An image defined by bbox and padded with fill that contains the projected flux in heavy.

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
getImageArray(self: lsst.afw.detection.HeavyFootprintF) numpy.ndarray
getMaskArray(self: lsst.afw.detection.HeavyFootprintF) numpy.ndarray
getMaskBitsSet(self: lsst.afw.detection.HeavyFootprintF) int
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
getVarianceArray(self: lsst.afw.detection.HeavyFootprintF) numpy.ndarray
insert(*args, **kwargs)

Overloaded function.

  1. insert(self: lsst.afw.detection.HeavyFootprintF, arg0: lsst::afw::image::MaskedImage<float, int, float>) -> None

  2. insert(self: lsst.afw.detection.HeavyFootprintF, arg0: lsst::afw::image::Image<float>) -> None

isContiguous(self: lsst.afw.detection.Footprint) bool
isHeavy(self: lsst.afw.detection.HeavyFootprintF) bool
isPersistable(self: lsst.afw.detection.Footprint) bool
static readFits(*args, **kwargs)

Overloaded function.

  1. readFits(fileName: str, hdu: int = -2147483648) -> lsst.afw.detection.Footprint

  2. readFits(manager: lsst.afw.fits._fits.MemFileManager, hdu: int = -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.

  1. shift(self: lsst.afw.detection.Footprint, arg0: int, arg1: int) -> None

  2. 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
subtractFrom(image)

Subtract this heavy footprint from an image.

Parameters:
imagelsst.afw.image
transform(*args, **kwargs)

Overloaded function.

  1. 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

  2. transform(self: lsst.afw.detection.Footprint, arg0: lsst.geom.LinearTransform, arg1: lsst.geom.Box2I, arg2: bool) -> lsst.afw.detection.Footprint

  3. transform(self: lsst.afw.detection.Footprint, arg0: lsst.geom.AffineTransform, arg1: lsst.geom.Box2I, arg2: bool) -> lsst.afw.detection.Footprint

  4. 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.

  1. updatePeakSignificance(self: lsst.afw.detection.Footprint, arg0: float) -> None

  2. updatePeakSignificance(self: lsst.afw.detection.Footprint, arg0: lsst::afw::image::Image<float>, arg1: int) -> None

writeFits(*args, **kwargs)

Overloaded function.

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

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