ExtendedPsfCandidate#

class lsst.pipe.tasks.extended_psf.ExtendedPsfCandidate(image: Image, *, mask: Mask | None = None, variance: Image | None = None, mask_schema: MaskSchema | None = None, projection: Projection | None = None, obs_info: ObservationInfo | None = None, metadata: dict[str, MetadataValue] | None = None, psf_kernel_image: Image | None = None, star_info: ExtendedPsfCandidateInfo | None = None)#

Bases: MaskedImage

A cutout centered on a star, with associated metadata.

Parameters#

imageImage

The main data image for this star cutout.

maskMask, optional

Bitmask that annotates the main image’s pixels.

varianceImage, optional

Per-pixel variance estimates for the image.

mask_schemaMaskSchema, optional

Schema for the mask, required if a mask is provided.

projectionProjection, optional

Projection to map pixels to the sky.

obs_infoObservationInfo, optional

Standardized description of visit metadata.

metadatadict [str, MetadataValue], optional

Additional metadata to associate with this cutout.

psf_kernel_imageImage, optional

Kernel image of the PSF at the cutout center.

star_infoExtendedPsfCandidateInfo, optional

Information about the star in the cutout.

Attributes#

psf_kernel_imageImage

Kernel image of the PSF at the cutout center.

star_infoExtendedPsfCandidateInfo

Information about the star in this cutout.

Attributes Summary

psf_kernel_image

Kernel image of the PSF at the cutout center.

star_info

Return the ExtendedPsfCandidateInfo associated with this star.

Methods Summary

copy()

Deep-copy the star cutout, metadata, and star info.

deserialize(model, archive, *[, bbox])

Deserialize an image from an input archive.

serialize(archive)

Serialize the masked image to an output archive.

Attributes Documentation

psf_kernel_image#

Kernel image of the PSF at the cutout center.

star_info#

Return the ExtendedPsfCandidateInfo associated with this star.

Methods Documentation

copy() → ExtendedPsfCandidate#

Deep-copy the star cutout, metadata, and star info.

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

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]) → ExtendedPsfCandidateSerializationModel#

Serialize the masked image to an output archive.

Parameters#

archive

Archive to write to.