OwnedImagePlanes

class lsst.cell_coadds.OwnedImagePlanes(*, image: ImageLike, mask: Mask, variance: ImageLike, mask_fractions: ImageLike | None = None, noise_realizations: Sequence[ImageLike] = ())

Bases: ImagePlanes

An implementation of the ImagePlanes interface backed by actual afw objects.

Attributes Summary

bbox	The bounding box common to all image planes.
image	The data image itself.
mask	An integer bitmask.
mask_fractions	The (weighted) fraction of masked pixels that contribute to each pixel.
noise_realizations	A sequence of noise realizations that were coadded with the same operations that were appled to the data image.
variance	Per-pixel variances for the image.

Methods Summary

asMaskedImage()	Return an lsst.afw.image.MaskedImage view of the image, mask, and variance planes.
from_masked_image(masked_image[, ...])	Construct from an lsst.afw.image.MaskedImage.

Attributes Documentation

bbox

image

mask

mask_fractions

noise_realizations

variance

Methods Documentation

asMaskedImage() → MaskedImageF

Return an lsst.afw.image.MaskedImage view of the image, mask, and variance planes.

classmethod from_masked_image(masked_image: MaskedImage, mask_fractions: ImageLike | None = None, noise_realizations: Sequence[ImageLike] = ()) → Self

Construct from an lsst.afw.image.MaskedImage.

Parameters:

masked_imageMaskedImage

The image to construct from. The image, mask and variance planes of masked_image will be used as the image, mask and variance planes of the constructed object.

mask_fractionsImageLike, optional

The mask fractions image.

noise_realizationsSequence [ImageLike], optional

The noise realizations.

Returns:

selfOwnedImagePlanes

An instance of OwnedImagePlanes.