Inheritance diagram for lsst.meas.algorithms.stamps.AbstractStamp:
Public Member Functions | |
| factory (cls, stamp_im, metadata, index, archive_element=None) | |
Detailed Description
Single abstract stamp. Parameters ---------- Inherit from this class to add metadata to the stamp.
Member Function Documentation
◆ factory()
| lsst.meas.algorithms.stamps.AbstractStamp.factory | ( | cls, | |
| stamp_im, | |||
| metadata, | |||
| index, | |||
| archive_element = None ) |
This method is needed to service the FITS reader. We need a standard
interface to construct objects like this. Parameters needed to
construct this object are passed in via a metadata dictionary and then
passed to the constructor of this class.
Parameters
----------
stamp : `~lsst.afw.image.MaskedImage`
Pixel data to pass to the constructor
metadata : `dict`
Dictionary containing the information
needed by the constructor.
idx : `int`
Index into the lists in ``metadata``
archive_element : `~lsst.afw.table.io.Persistable`, optional
Archive element (e.g. Transform or WCS) associated with this stamp.
Returns
-------
stamp : `AbstractStamp`
An instance of this class
Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamp, and lsst.meas.algorithms.stamps.Stamp.
Definition at line 216 of file stamps.py.
216 def factory(cls, stamp_im, metadata, index, archive_element=None):
217 """This method is needed to service the FITS reader. We need a standard
218 interface to construct objects like this. Parameters needed to
219 construct this object are passed in via a metadata dictionary and then
220 passed to the constructor of this class.
221
222 Parameters
223 ----------
224 stamp : `~lsst.afw.image.MaskedImage`
225 Pixel data to pass to the constructor
226 metadata : `dict`
227 Dictionary containing the information
228 needed by the constructor.
229 idx : `int`
230 Index into the lists in ``metadata``
231 archive_element : `~lsst.afw.table.io.Persistable`, optional
232 Archive element (e.g. Transform or WCS) associated with this stamp.
233
234 Returns
235 -------
236 stamp : `AbstractStamp`
237 An instance of this class
238 """
239 raise NotImplementedError
240
241
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+0433e6603d/python/lsst/meas/algorithms/stamps.py
