lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate Class Reference

Inheritance diagram for lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate:

Public Member Functions
	__init__ (self, Image image, *, Mask|None mask=None, Image|None variance=None, MaskSchema|None mask_schema=None, Projection|None projection=None, ObservationInfo|None obs_info=None, dict[str, MetadataValue]|None metadata=None, Image|None psf_kernel_image=None, ExtendedPsfCandidateInfo|None star_info=None)
ExtendedPsfCandidate	__getitem__ (self, Box|EllipsisType bbox)
str	__str__ (self)
str	__repr__ (self)
Image	psf_kernel_image (self)
ExtendedPsfCandidateInfo	star_info (self)
ExtendedPsfCandidate	copy (self)
ExtendedPsfCandidateSerializationModel	serialize (self, OutputArchive[Any] archive)

Static Public Member Functions
ExtendedPsfCandidate	deserialize (ExtendedPsfCandidateSerializationModel[Any] model, InputArchive[Any] archive, *, Box|None bbox=None)

Static Protected Member Functions
	P

Protected Attributes
Image	_psf_kernel_image = psf_kernel_image
ExtendedPsfCandidateInfo	_star_info = star_info or ExtendedPsfCandidateInfo()

Detailed Description

A cutout centered on a star, with associated metadata.

Parameters
----------
image : `~lsst.images.Image`
    The main data image for this star cutout.
mask : `~lsst.images.Mask`, optional
    Bitmask that annotates the main image's pixels.
variance : `~lsst.images.Image`, optional
    Per-pixel variance estimates for the image.
mask_schema : `~lsst.images.MaskSchema`, optional
    Schema for the mask, required if a mask is provided.
projection : `~lsst.images.Projection`, optional
    Projection to map pixels to the sky.
obs_info : `~astro_metadata_translator.ObservationInfo`, optional
    Standardized description of visit metadata.
metadata : `dict` [`str`, `MetadataValue`], optional
    Additional metadata to associate with this cutout.
psf_kernel_image : `~lsst.images.Image`, optional
    Kernel image of the PSF at the cutout center.
star_info : `ExtendedPsfCandidateInfo`, optional
    Information about the star in the cutout.

Attributes
----------
psf_kernel_image : `~lsst.images.Image`
    Kernel image of the PSF at the cutout center.
star_info : `ExtendedPsfCandidateInfo`
    Information about the star in this cutout.

Definition at line 115 of file extended_psf_candidates.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 147 of file extended_psf_candidates.py.

Member Function Documentation

__getitem__()

ExtendedPsfCandidate lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.__getitem__	(		self,
		Box | EllipsisType	bbox )

Definition at line 173 of file extended_psf_candidates.py.

__repr__()

str lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.__repr__

(

self

)

Definition at line 192 of file extended_psf_candidates.py.

__str__()

str lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.__str__

(

self

)

Definition at line 189 of file extended_psf_candidates.py.

copy()

ExtendedPsfCandidate lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.copy

(

self

)

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

Definition at line 210 of file extended_psf_candidates.py.

deserialize()

ExtendedPsfCandidate lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.deserialize ( ExtendedPsfCandidateSerializationModel[Any] model, InputArchive[Any] archive, * , Box | None bbox = None )

static

Reimplemented in lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.

Definition at line 246 of file extended_psf_candidates.py.

P()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.P

staticprotected

Reimplemented in lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.

Definition at line 240 of file extended_psf_candidates.py.

psf_kernel_image()

Image lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.psf_kernel_image

(

self

)

Kernel image of the PSF at the cutout center.

Definition at line 199 of file extended_psf_candidates.py.

serialize()

ExtendedPsfCandidateSerializationModel lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.serialize	(		self,
		OutputArchive[Any]	archive )

Reimplemented in lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.

Definition at line 223 of file extended_psf_candidates.py.

star_info()

ExtendedPsfCandidateInfo lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate.star_info

(

self

)

Return the ExtendedPsfCandidateInfo associated with this star.

Definition at line 206 of file extended_psf_candidates.py.

Member Data Documentation

_psf_kernel_image

Image lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate._psf_kernel_image = psf_kernel_image

protected

Definition at line 170 of file extended_psf_candidates.py.

_star_info

ExtendedPsfCandidateInfo lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidate._star_info = star_info or ExtendedPsfCandidateInfo()

protected

Definition at line 171 of file extended_psf_candidates.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/extended_psf/extended_psf_candidates.py