Extraction¶
- class lsst.dax.images.cutout.Extraction(cutout: Image | Mask | MaskedImage | Exposure, sky_stencil: SkyStencil, pixel_stencil: PixelStencil, metadata: PropertyList, origin_ref: DatasetRef)¶
Bases:
object
A struct that aggregates the results of extracting subimages in the image cutout backend.
Methods Summary
mask
([name])Set the bitmask to show the approximate coverage of nonrectangular stencils.
write_fits
(path)Write the cutout to a FITS file.
Methods Documentation
- mask(name: str = 'STENCIL') None ¶
Set the bitmask to show the approximate coverage of nonrectangular stencils.
- Parameters:
- name
str
, optional Name of the mask plane to add and set.
- name
Notes
This method modifies
cutout
in place if it is aMask
,MaskedImage
, orExposure
. It does nothing ifcutout
is anImage
.