readFitsWithOptions

lsst.meas.algorithms.readFitsWithOptions(filename, stamp_factory, options)

Read stamps from FITS file, allowing for only a subregion of the stamps to be read.

Parameters:

filename : str

A string indicating the file to read

stamp_factory : classmethod

A factory function defined on a dataclass for constructing stamp objects a la lsst.meas.alrogithm.Stamp

options : PropertyList or dict

A collection of parameters. If it contains a bounding box (bbox key), or if certain other keys (llcX, llcY, width, height) are available for one to be constructed, the bounding box is passed to the FitsReader in order to return a sub-image.

Returns:

stamps : list of dataclass objects like Stamp, PropertyList

A tuple of a list of Stamp-like objects

metadata : PropertyList

The metadata