|
lsst.afw g712618294e+4813a5392e
|
Public Member Functions | |
| def | __init__ (self, filters, singles) |
| def | getSpans (self) |
| def | footprint (self) |
| def | mMaskedImage (self) |
| def | spans (self) |
| def | getPeaks (self) |
| def | peaks (self) |
| def | getImage (self, bbox=None, fill=np.nan, imageType=MultibandMaskedImage) |
| def | clone (self, deep=True) |
Static Public Member Functions | |
| def | fromArrays (filters, image, mask=None, variance=None, footprint=None, xy0=None, thresh=0, peaks=None) |
| def | fromImages (filters, image, mask=None, variance=None, footprint=None, thresh=0, peaks=None) |
| def | fromMaskedImages (filters, maskedImages, footprint=None, thresh=0, peaks=None) |
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 80 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.__init__ | ( | self, | |
| filters, | |||
| singles | |||
| ) |
Reimplemented from lsst.afw.multiband.MultibandBase.
Definition at line 96 of file multiband.py.
| def 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 309 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.footprint | ( | self | ) |
Common SpanSet and peak catalog for the single band footprints
Definition at line 229 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 109 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 160 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 201 of file multiband.py.
| def 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 270 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.getPeaks | ( | self | ) |
Get the `PeakCatalog`
Definition at line 243 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.getSpans | ( | self | ) |
Get the full `SpanSet`
Definition at line 224 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.mMaskedImage | ( | self | ) |
MultibandMaskedImage that the footprints present a view into
Definition at line 234 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.peaks | ( | self | ) |
`PeakCatalog` of the `MultibandFootprint`
Definition at line 248 of file multiband.py.
| def lsst.afw.detection.multiband.MultibandFootprint.spans | ( | self | ) |
`SpanSet` of the `MultibandFootprint`
Definition at line 239 of file multiband.py.