|
lsst.meas.algorithms g33a09d4741+106f42d13d
|
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.
| lsst.meas.algorithms.stamps.StampsBase.__getitem__ | ( | self, | |
| index | |||
| ) |
|
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.
| lsst.meas.algorithms.stamps.StampsBase.getArchiveElements | ( | self | ) |
| lsst.meas.algorithms.stamps.StampsBase.getMaskedImages | ( | 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.
| 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.
| lsst.meas.algorithms.stamps.StampsBase.writeFits | ( | self, | |
| filename | |||
| ) |
|
protected |