BrightStarStamps

class lsst.meas.algorithms.BrightStarStamps(brightStarStamps: Sequence[BrightStarStamp], metadata: PropertyList | None = None)

Bases: Sequence[BrightStarStamp]

A collection of bright star stamps.

Parameters

brightStarStampsIterable [BrightStarStamp]

Collection of BrightStarStamp instances.

metadataPropertyList, optional

Global metadata associated with the collection.

Attributes Summary

metadata

Return the collection's global metadata as a PropertyList.

Methods Summary

readFits(filename)	Make a BrightStarStamps object from a FITS file.
readFitsWithOptions(filename, options)	Make a BrightStarStamps object from a FITS file, with options.
writeFits(filename)	Write this BrightStarStamps object to a FITS file.

Attributes Documentation

metadata

Return the collection’s global metadata as a PropertyList.

Methods Documentation

classmethod readFits(filename: str) → BrightStarStamps

Make a BrightStarStamps object from a FITS file.

Parameters

filenamestr

Name of the FITS file to read.

Returns

brightStarStampsBrightStarStamps

The constructed BrightStarStamps instance.

classmethod readFitsWithOptions(filename: str, options: PropertyList | None) → BrightStarStamps

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

Parameters

filenamestr

Name of the FITS file to read.

optionsPropertyList, optional

Options for reading the FITS file. Not currently used.

Returns

brightStarStampsBrightStarStamps

The constructed BrightStarStamps instance.

writeFits(filename: str)

Write this BrightStarStamps object to a FITS file.

Parameters

filenamestr

Name of the FITS file to write.