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

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

Public Member Functions
	__init__ (self, Sequence[ExtendedPsfCandidate] candidates, dict[str, MetadataValue]|None metadata=None)
	__len__ (self)
	__getitem__ (self, index)
	__iter__ (self)
str	__str__ (self)
	metadata (self)
	ref_id_map (self)
ExtendedPsfCandidates	read_fits (cls, ResourcePathExpression url)
None	write_fits (self, str filename)
ExtendedPsfCandidatesSerializationModel	serialize (self, OutputArchive[Any] archive)

Static Protected Member Functions
type[ExtendedPsfCandidatesSerializationModel[P]]	_get_archive_tree_type (type[P] pointer_type)

Protected Attributes
	_candidates = list(candidates)
dict	_metadata = {} if metadata is None else dict(metadata)
dict	_ref_id_map

Detailed Description

A collection of star cutouts.

Parameters
----------
candidates : `Iterable` [`ExtendedPsfCandidate`]
    Collection of `ExtendedPsfCandidate` instances.
metadata : `dict` [`str`, `MetadataValue`], optional
    Global metadata associated with the collection.

Attributes
----------
metadata : `dict` [`str`, `MetadataValue`]
    Global metadata associated with the collection.
ref_id_map : `dict` [`int`, `ExtendedPsfCandidate`]
    A mapping from reference IDs to `ExtendedPsfCandidate` objects.
    Only includes candidates with valid reference IDs.

Definition at line 252 of file extended_psf_candidates.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.__init__	(		self,
		Sequence[ExtendedPsfCandidate]	candidates,
		dict[str, MetadataValue] | None	metadata = None )

Definition at line 271 of file extended_psf_candidates.py.

Member Function Documentation

__getitem__()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.__getitem__	(		self,
			index )

Definition at line 287 of file extended_psf_candidates.py.

__iter__()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.__iter__

(

self

)

Definition at line 292 of file extended_psf_candidates.py.

__len__()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.__len__

(

self

)

Definition at line 284 of file extended_psf_candidates.py.

__str__()

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

(

self

)

Definition at line 295 of file extended_psf_candidates.py.

_get_archive_tree_type()

type[ExtendedPsfCandidatesSerializationModel[P]] lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates._get_archive_tree_type ( type[P] pointer_type )

staticprotected

Definition at line 342 of file extended_psf_candidates.py.

metadata()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.metadata

(

self

)

Return the collection's global metadata as a dict.

Definition at line 301 of file extended_psf_candidates.py.

read_fits()

ExtendedPsfCandidates lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.read_fits	(		cls,
		ResourcePathExpression	url )

Read a collection from a FITS file.

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

Definition at line 311 of file extended_psf_candidates.py.

ref_id_map()

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.ref_id_map

(

self

)

Map reference IDs to `ExtendedPsfCandidate` objects.

Definition at line 306 of file extended_psf_candidates.py.

serialize()

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

Definition at line 332 of file extended_psf_candidates.py.

write_fits()

None lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates.write_fits	(		self,
		str	filename )

Write the collection to a FITS file.

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

Definition at line 322 of file extended_psf_candidates.py.

Member Data Documentation

_candidates

lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates._candidates = list(candidates)

protected

Definition at line 276 of file extended_psf_candidates.py.

_metadata

dict lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates._metadata = {} if metadata is None else dict(metadata)

protected

Definition at line 277 of file extended_psf_candidates.py.

_ref_id_map

dict lsst.pipe.tasks.extended_psf.extended_psf_candidates.ExtendedPsfCandidates._ref_id_map

protected

Initial value:

=  {
            candidate.star_info.ref_id: candidate
            for candidate in self
            if candidate.star_info.ref_id is not None
        }

Definition at line 278 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