LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False) | |
readFits (cls, filename) | |
readFitsWithOptions (cls, filename, options) | |
writeFits (self, filename) | |
__len__ (self) | |
__getitem__ (self, index) | |
__iter__ (self) | |
getMaskedImages (self) | |
getArchiveElements (self) | |
metadata (self) | |
Public Attributes | |
use_mask | |
use_variance | |
use_archive | |
Protected Member Functions | |
_refresh_metadata (self) | |
Protected Attributes | |
_stamps | |
_metadata | |
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} )
lsst.meas.algorithms.stamps.StampsBase.__init__ | ( | self, | |
stamps, | |||
metadata = None, | |||
use_mask = True, | |||
use_variance = True, | |||
use_archive = False ) |
Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.
Definition at line 342 of file stamps.py.
lsst.meas.algorithms.stamps.StampsBase.__getitem__ | ( | self, | |
index ) |
lsst.meas.algorithms.stamps.StampsBase.__iter__ | ( | self | ) |
lsst.meas.algorithms.stamps.StampsBase.__len__ | ( | self | ) |
|
protected |
Make sure metadata is up to date, as this object can be extended.
Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps, and lsst.meas.algorithms.stamps.Stamps.
Definition at line 399 of file stamps.py.
lsst.meas.algorithms.stamps.StampsBase.getArchiveElements | ( | self | ) |
Retrieve archive elements associated with each stamp. Returns ------- archiveElements : `list` [`~lsst.afw.table.io.Persistable`]
Definition at line 442 of file stamps.py.
lsst.meas.algorithms.stamps.StampsBase.getMaskedImages | ( | self | ) |
Retrieve star images. Returns ------- maskedImages : `list` [`~lsst.afw.image.MaskedImageF`]
Definition at line 432 of file stamps.py.
lsst.meas.algorithms.stamps.StampsBase.metadata | ( | self | ) |
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.brightStarStamps.BrightStarStamps, and lsst.meas.algorithms.stamps.Stamps.
Definition at line 353 of file stamps.py.
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.brightStarStamps.BrightStarStamps, and lsst.meas.algorithms.stamps.Stamps.
Definition at line 365 of file stamps.py.
lsst.meas.algorithms.stamps.StampsBase.writeFits | ( | self, | |
filename ) |
Write this object to a file. Parameters ---------- filename : `str` Name of file to write.
Definition at line 403 of file stamps.py.
|
protected |