ExtendedPsfImage#

class lsst.pipe.tasks.extended_psf.ExtendedPsfImage(image: Image, *, variance: Image | None = None, info: ExtendedPsfImageInfo | None = None, fit: ExtendedPsfFit | None = None, metadata: dict[str, MetadataValue] | None = None)#

Bases: GeneralizedImage

A multi-plane image with data (image) and variance planes, and the results of a profile fit to the image.

Parameters#

imageImage: The main image plane.
varianceImage, optional: The per-pixel uncertainty of the main image as an image of variance values. Must have the same bounding box as image if provided, and its units must be the square of image.unit or None. Values default to 1.0. Any attached projection is replaced (possibly by None).
infoExtendedPsfImageInfo, optional: Additional information about how the extended PSF image was constructed.
fitExtendedPsfFit, optional: The results of a profile fit to the image.
metadatadict [str, MetadataValue], optional: Arbitrary flexible metadata to associate with the image.

Attributes#

imageImage: The main image plane.
varianceImage: The per-pixel uncertainty of the main image as an image of variance values.
bboxBox: The bounding box shared by both image planes.
unitastropy.units.Unit or None: The units of the image plane, or None if the image is dimensionless.
projectionNone: The projection that maps the pixel grid to the sky. Always None for ExtendedPsfImage.
infoExtendedPsfImageInfo: Additional information about how the extended PSF image was constructed.
fitExtendedPsfFit: The results of a profile fit to the image.

Attributes Summary

`bbox`	The bounding box shared by both image planes (`Box`).
`fit`	The results of a profile fit to the image.
`image`	The main image plane (`Image`).
`info`	Additional information about the image (`ExtendedPsfImageInfo`).
`projection`	The projection that maps the pixel grid to the sky.
`unit`	The units of the image plane (`astropy.units.Unit` \| `None`).
`variance`	The variance plane (`Image`).

Methods Summary

`copy`()	Deep-copy the profile image and metadata.
`deserialize`(model, archive, *[, bbox])	Deserialize an image from an input archive.
`serialize`(archive)	Serialize the Extended PSF image to an output archive.

Attributes Documentation

bbox#: The bounding box shared by both image planes (Box).

fit#: The results of a profile fit to the image.

image#: The main image plane (Image).

info#: Additional information about the image (ExtendedPsfImageInfo).

projection#

The projection that maps the pixel grid to the sky.

ExtendedPsfImage does not support attached projections, so this always returns None.

unit#: The units of the image plane (astropy.units.Unit | None).

variance#: The variance plane (Image).

Methods Documentation

copy() → ExtendedPsfImage#: Deep-copy the profile image and metadata.

static deserialize(model: ExtendedPsfImageSerializationModel[Any], archive: InputArchive[Any], *, bbox: Box | None = None) → ExtendedPsfImage#

Deserialize an image from an input archive.

Parameters#

model: A Pydantic model representation of the image, holding references to data stored in the archive.
archive: Archive to read from.
bbox: Bounding box of a subimage to read instead.

serialize(archive: OutputArchive[Any]) → ExtendedPsfImageSerializationModel#

Serialize the Extended PSF image to an output archive.

Parameters#

archive: Archive to write to.