LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, filters, singles) | |
getSpans (self) | |
footprint (self) | |
mMaskedImage (self) | |
spans (self) | |
getPeaks (self) | |
peaks (self) | |
getImage (self, bbox=None, fill=np.nan, imageType=MultibandMaskedImage) | |
clone (self, deep=True) | |
Static Public Member Functions | |
fromArrays (filters, image, mask=None, variance=None, footprint=None, xy0=None, thresh=0, peaks=None) | |
fromImages (filters, image, mask=None, variance=None, footprint=None, thresh=0, peaks=None) | |
fromMaskedImages (filters, maskedImages, footprint=None, thresh=0, peaks=None) | |
Protected Member Functions | |
_slice (self, filters, filterIndex, indices) | |
Protected Attributes | |
_footprint | |
Multiband Footprint class A `MultibandFootprint` is a collection of HeavyFootprints that have the same `SpanSet` and `peakCatalog` but different flux in each band. Parameters ---------- filters : `list` List of filter names. singles : `list` A list of single band `HeavyFootprint` objects. Each `HeavyFootprint` should have the same `PeakCatalog` and the same `SpanSet`, however to save CPU cycles there is no internal check for consistency of the peak catalog.
Definition at line 83 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.__init__ | ( | self, | |
filters, | |||
singles ) |
Reimplemented from lsst.afw.multiband.MultibandBase.
Definition at line 99 of file multiband.py.
|
protected |
Slice the current object and return the result `MultibandFootprint` objects cannot be sliced along the image dimension, so an error is thrown if `indices` has any elements. See `Multiband._slice` for a list of the parameters.
Reimplemented from lsst.afw.multiband.MultibandBase.
Definition at line 255 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.clone | ( | self, | |
deep = True ) |
Copy the current object Parameters ---------- deep : `bool` Whether or not to make a deep copy Returns ------- result : `MultibandFootprint` The cloned footprint.
Reimplemented from lsst.afw.multiband.MultibandBase.
Definition at line 312 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.footprint | ( | self | ) |
Common SpanSet and peak catalog for the single band footprints
Definition at line 232 of file multiband.py.
|
static |
Create a `MultibandFootprint` from an `image`, `mask`, `variance` Parameters ---------- filters : `list` List of filter names. image: array An array to convert into `lsst.afw.detection.HeavyFootprint` objects. Only pixels above the `thresh` value for at least one band will be included in the `SpanSet` and resulting footprints. mask : array Mask for the `image` array. variance : array Variance of the `image` array. footprint : `Footprint` `Footprint` that contains the `SpanSet` and `PeakCatalog` to use for the `HeavyFootprint` in each band. If `footprint` is `None` then the `thresh` is used to create a `Footprint` based on the pixels above the `thresh` value. xy0 : `Point2I` If `image` is an array and `footprint` is `None` then specifying `xy0` gives the location of the minimum `x` and `y` value of the `images`. thresh : `float` or list of floats Threshold in each band (or the same threshold to be used in all bands) to include a pixel in the `SpanSet` of the `MultibandFootprint`. If `Footprint` is not `None` then `thresh` is ignored. peaks : `PeakCatalog` Catalog containing information about the peaks located in the footprints. Returns ------- result : `MultibandFootprint` MultibandFootprint created from the arrays
Definition at line 112 of file multiband.py.
|
static |
Create a `MultibandFootprint` from an `image`, `mask`, `variance` Parameters ---------- filters : `list` List of filter names. image : `lsst.afw.image.MultibandImage`, or list of `lsst.afw.image.Image` A `lsst.afw.image.MultibandImage` (or collection of images in each band) to convert into `HeavyFootprint` objects. Only pixels above the `thresh` value for at least one band will be included in the `SpanSet` and resulting footprints. mask : `MultibandMask` or list of `Mask` Mask for the `image`. variance : `lsst.afw.image.MultibandImage`, or list of `lsst.afw.image.Image` Variance of the `image`. thresh : `float` or `list` of floats Threshold in each band (or the same threshold to be used in all bands) to include a pixel in the `SpanSet` of the `MultibandFootprint`. If `Footprint` is not `None` then `thresh` is ignored. peaks : `PeakCatalog` Catalog containing information about the peaks located in the footprints. Returns ------- result : `MultibandFootprint` MultibandFootprint created from the image, mask, and variance
Definition at line 163 of file multiband.py.
|
static |
Create a `MultibandFootprint` from a list of `MaskedImage` See `fromImages` for a description of the parameters not listed below Parameters ---------- maskedImages : `list` of `lsst.afw.image.MaskedImage` MaskedImages to extract the single band heavy footprints from. Like `fromImages`, if a `footprint` is not specified then all pixels above `thresh` will be used, and `peaks` will be added to the `PeakCatalog`. Returns ------- result : `MultibandFootprint` MultibandFootprint created from the image, mask, and variance
Definition at line 204 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.getImage | ( | self, | |
bbox = None, | |||
fill = np.nan, | |||
imageType = MultibandMaskedImage ) |
Convert a `MultibandFootprint` to a `MultibandImage` This returns the heavy footprints converted into an `MultibandImage` or `MultibandMaskedImage` (depending on `imageType`). This might be different than the internal `mMaskedImage` property of the `MultibandFootprint`, as the `mMaskedImage` might contain some non-zero pixels not contained in the footprint but present in the images. Parameters ---------- bbox : `Box2I` Bounding box of the resulting image. If no bounding box is specified, then the bounding box of the footprint is used. fill : `float` Value to use for any pixel in the resulting image outside of the `SpanSet`. imageType : `type` This should be either a `MultibandMaskedImage` or `MultibandImage` and describes the type of the output image. Returns ------- result : `MultibandBase` The resulting `MultibandImage` or `MultibandMaskedImage` created from the `MultibandHeavyFootprint`.
Definition at line 273 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.getPeaks | ( | self | ) |
Get the `PeakCatalog`
Definition at line 246 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.getSpans | ( | self | ) |
Get the full `SpanSet`
Definition at line 227 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.mMaskedImage | ( | self | ) |
MultibandMaskedImage that the footprints present a view into
Definition at line 237 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.peaks | ( | self | ) |
`PeakCatalog` of the `MultibandFootprint`
Definition at line 251 of file multiband.py.
lsst.afw.detection.multiband.MultibandFootprint.spans | ( | self | ) |
`SpanSet` of the `MultibandFootprint`
Definition at line 242 of file multiband.py.
|
protected |
Definition at line 109 of file multiband.py.