ImagePlanes

class lsst.cell_coadds.ImagePlanes

Bases: ABC

Struct interface for the image-like planes we coadd.

Notes

The extends the set of planes in lsst.afw.image.MaskedImage by adding noise realizations and “mask fraction” images.

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(*[, noise_index])

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

Attributes Documentation

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 Documentation

asMaskedImage(*, noise_index: int | None = None) → MaskedImageF

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

Parameters

noise_indexint or None, optional

If None, return the masked image formed from the main image, mask, and variance planes. If an integer index is provided, return the masked image formed from the specified noise realization, along with the mask and variance planes.

Returns

masked_imagelsst.afw.image.MaskedImageF

The masked image formed from the specified planes.

Raises

ValueError

Raised if noise_index is out of range for the available noise realizations.