Inheritance diagram for lsst.meas.algorithms.brightStarStamps.BrightStarStamps:

Public Member Functions
	__init__ (self, Sequence[BrightStarStamp] brightStarStamps, PropertyList\|None metadata=None)
	__len__ (self)
	__getitem__ (self, index)
	__iter__ (self)
	metadata (self)
BrightStarStamps	readFits (cls, str filename)
BrightStarStamps	readFitsWithOptions (cls, str filename, PropertyList\|None options)
	writeFits (self, str filename)

Public Attributes
dict	by_ref_id = {stamp.ref_id: stamp for stamp in self}

Protected Attributes
	_stamps = list(brightStarStamps)
	_metadata = PropertyList() if metadata is None else metadata.deepCopy()

Detailed Description

A collection of bright star stamps.

Parameters
----------
brightStarStamps : `Iterable` [`BrightStarStamp`]
    Collection of `BrightStarStamp` instances.
metadata : `~lsst.daf.base.PropertyList`, optional
    Global metadata associated with the collection.

Definition at line 230 of file brightStarStamps.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__init__	(		self,
		Sequence[BrightStarStamp]	brightStarStamps,
		PropertyList \| None	metadata = None )

Definition at line 241 of file brightStarStamps.py.

Member Function Documentation

◆ getitem()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__getitem__	(		self,
			index )

Definition at line 253 of file brightStarStamps.py.

◆ iter()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__iter__ ( self )

Definition at line 258 of file brightStarStamps.py.

◆ len()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__len__ ( self )

Definition at line 250 of file brightStarStamps.py.

◆ metadata()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.metadata ( self )

Return the collection's global metadata as a PropertyList.

Definition at line 262 of file brightStarStamps.py.

◆ readFits()

BrightStarStamps lsst.meas.algorithms.brightStarStamps.BrightStarStamps.readFits	(		cls,
		str	filename )

Make a `BrightStarStamps` object from a FITS file.

Parameters
----------
filename : `str`
    Name of the FITS file to read.

Returns
-------
brightStarStamps : `BrightStarStamps`
    The constructed `BrightStarStamps` instance.

Definition at line 267 of file brightStarStamps.py.

◆ readFitsWithOptions()

BrightStarStamps lsst.meas.algorithms.brightStarStamps.BrightStarStamps.readFitsWithOptions	(		cls,
		str	filename,
		PropertyList \| None	options )

Make a `BrightStarStamps` object from a FITS file, with options.

Parameters
----------
filename : `str`
    Name of the FITS file to read.
options : `~lsst.daf.base.PropertyList`, optional
    Options for reading the FITS file. Not currently used.

Returns
-------
brightStarStamps : `BrightStarStamps`
    The constructed `BrightStarStamps` instance.

Definition at line 283 of file brightStarStamps.py.

◆ writeFits()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.writeFits	(		self,
		str	filename )

Write this `BrightStarStamps` object to a FITS file.

Parameters
----------
filename : `str`
    Name of the FITS file to write.

Definition at line 362 of file brightStarStamps.py.

Member Data Documentation

◆ _metadata

lsst.meas.algorithms.brightStarStamps.BrightStarStamps._metadata = PropertyList() if metadata is None else metadata.deepCopy()

protected

Definition at line 247 of file brightStarStamps.py.

◆ _stamps

lsst.meas.algorithms.brightStarStamps.BrightStarStamps._stamps = list(brightStarStamps)

protected

Definition at line 246 of file brightStarStamps.py.

◆ by_ref_id

dict lsst.meas.algorithms.brightStarStamps.BrightStarStamps.by_ref_id = {stamp.ref_id: stamp for stamp in self}

Definition at line 248 of file brightStarStamps.py.

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

python/lsst/meas/algorithms/brightStarStamps.py

Public Member Functions

Public Attributes

Protected Attributes