ExtendedPsfCandidates#

class lsst.pipe.tasks.extended_psf.ExtendedPsfCandidates(candidates: Sequence[ExtendedPsfCandidate], metadata: dict[str, MetadataValue] | None = None)#

Bases: Sequence[ExtendedPsfCandidate]

A collection of star cutouts.

Parameters#

candidatesIterable [ExtendedPsfCandidate]: Collection of ExtendedPsfCandidate instances.
metadatadict [str, MetadataValue], optional: Global metadata associated with the collection.

Attributes#

metadatadict [str, MetadataValue]: Global metadata associated with the collection.
ref_id_mapdict [int, ExtendedPsfCandidate]: A mapping from reference IDs to ExtendedPsfCandidate objects. Only includes candidates with valid reference IDs.

Attributes Summary

`metadata`	Return the collection's global metadata as a dict.
`ref_id_map`	Map reference IDs to `ExtendedPsfCandidate` objects.

Methods Summary

`deserialize`(model, archive)
`read_fits`(url)	Read a collection from a FITS file.
`serialize`(archive)
`write_fits`(filename)	Write the collection to a FITS file.

Attributes Documentation

metadata#: Return the collection’s global metadata as a dict.

ref_id_map#: Map reference IDs to ExtendedPsfCandidate objects.

Methods Documentation

static deserialize(model: ExtendedPsfCandidatesSerializationModel[Any], archive: InputArchive[Any]) → ExtendedPsfCandidates#

classmethod read_fits(url: str | ParseResult | ResourcePath | Path) → ExtendedPsfCandidates#

Read a collection from a FITS file.

Parameters#

url: URL of the file to read; may be any type supported by lsst.resources.ResourcePath.

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

write_fits(filename: str) → None#

Write the collection to a FITS file.

Parameters#

filename: Name of the file to write to. Must not already exist.