lsst.meas.algorithms
22.0.1-18-g3db9cf4b+a8d4bd429d
|
Public Member Functions | |
def | __init__ (self, stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False) |
def | readFits (cls, filename) |
def | readFitsWithOptions (cls, filename, options) |
def | writeFits (self, filename) |
def | __len__ (self) |
def | __getitem__ (self, index) |
def | __iter__ (self) |
def | getMaskedImages (self) |
def | getArchiveElements (self) |
def | metadata (self) |
Public Attributes | |
use_mask | |
use_variance | |
use_archive | |
Collection of stamps and associated metadata. Parameters ---------- stamps : iterable This should be an iterable of dataclass objects a la ``lsst.meas.algorithms.Stamp``. metadata : `lsst.daf.base.PropertyList`, optional Metadata associated with the objects within the stamps. use_mask : `bool`, optional If ``True`` read and write the mask data. Default ``True``. use_variance : `bool`, optional If ``True`` read and write the variance data. Default ``True``. use_archive : `bool`, 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``. Notes ----- 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})
def lsst.meas.algorithms.stamps.StampsBase.__getitem__ | ( | self, | |
index | |||
) |
def lsst.meas.algorithms.stamps.StampsBase.__iter__ | ( | self | ) |
def lsst.meas.algorithms.stamps.StampsBase.__len__ | ( | self | ) |
def lsst.meas.algorithms.stamps.StampsBase.getArchiveElements | ( | self | ) |
def lsst.meas.algorithms.stamps.StampsBase.getMaskedImages | ( | self | ) |
def lsst.meas.algorithms.stamps.StampsBase.metadata | ( | self | ) |
def lsst.meas.algorithms.stamps.StampsBase.readFits | ( | cls, | |
filename | |||
) |
Build an instance of this class from a file. Parameters ---------- filename : `str` Name of the file to read
Reimplemented in lsst.meas.algorithms.stamps.Stamps, and lsst.meas.algorithms.brightStarStamps.BrightStarStamps.
def lsst.meas.algorithms.stamps.StampsBase.readFitsWithOptions | ( | cls, | |
filename, | |||
options | |||
) |
Build an instance of this class with options. Parameters ---------- filename : `str` Name of the file to read options : `PropertyList` Collection of metadata parameters
Reimplemented in lsst.meas.algorithms.stamps.Stamps, and lsst.meas.algorithms.brightStarStamps.BrightStarStamps.
def lsst.meas.algorithms.stamps.StampsBase.writeFits | ( | self, | |
filename | |||
) |