Extraction

class lsst.dax.images.cutout.Extraction(cutout: Image | Mask | MaskedImage | Exposure | HDUList, 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[, logger])	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:

namestr, optional

Name of the mask plane to add and set.

Notes

This method modifies cutout in place if it is a Mask, MaskedImage, or Exposure. It does nothing if cutout is an Image.

write_fits(path: str, logger: Logger | None = None) → None

Write the cutout to a FITS file.

Parameters:

pathstr

Local path to the file.

loggerlogging.Logger, optional

Logger to use for timing messages. If None, a default logger will be used.

Notes

If cutout is an Exposure, this will merge metadata into the cutout’s attached metadata. In other cases, metadata is written to the primary header without modifying cutout.