StampsBase#

class lsst.meas.algorithms.StampsBase(stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False)#

Bases: ABC, Sequence

Collection of stamps and associated metadata.

Parameters#

stampsiterable: This should be an iterable of dataclass objects a la ~lsst.meas.algorithms.Stamp.
metadataPropertyList, optional: Metadata associated with the objects within the stamps.
use_maskbool, optional: If True read and write the mask data. Default True.
use_variancebool, optional: If True read and write the variance data. Default True.
use_archivebool, optional: If True, read and write an Archive that contains a Persistable associated with each stamp, for example a Transform or a WCS. Default False.

A butler can be used to read only a part of the stamps, specified by a bbox:

>>> starSubregions = butler.get(
        "brightStarStamps",
        dataId,
        parameters={"bbox": bbox}
    )

Attributes Summary

Methods Summary

`getArchiveElements`()	Retrieve archive elements associated with each stamp.
`getMaskedImages`()	Retrieve star images.
`readFits`(filename)	Build an instance of this class from a file.
`readFitsWithOptions`(filename, options)	Build an instance of this class with options.
`writeFits`(filename)	Write this object to a file.

Attributes Documentation

Methods Documentation

getArchiveElements()#

Retrieve archive elements associated with each stamp.

getMaskedImages()#

Retrieve star images.

classmethod readFits(filename)#

Build an instance of this class from a file.

classmethod readFitsWithOptions(filename, options)#

Build an instance of this class with options.

writeFits(filename)#

Write this object to a file.