LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | List of all members
lsst.meas.algorithms.stamps.AbstractStamp Class Reference
Inheritance diagram for lsst.meas.algorithms.stamps.AbstractStamp:
lsst.meas.algorithms.brightStarStamps.BrightStarStamp lsst.meas.algorithms.stamps.Stamp

Public Member Functions

def 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

Definition at line 181 of file stamps.py.

Member Function Documentation

◆ factory()

def 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.afwTable.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.stamps.Stamp, and lsst.meas.algorithms.brightStarStamps.BrightStarStamp.

Definition at line 191 of file stamps.py.

191  def factory(cls, stamp_im, metadata, index, archive_element=None):
192  """This method is needed to service the FITS reader.
193  We need a standard interface to construct objects like this.
194  Parameters needed to construct this object are passed in via
195  a metadata dictionary and then passed to the constructor of
196  this class.
197 
198  Parameters
199  ----------
200  stamp : `lsst.afw.image.MaskedImage`
201  Pixel data to pass to the constructor
202  metadata : `dict`
203  Dictionary containing the information
204  needed by the constructor.
205  idx : `int`
206  Index into the lists in ``metadata``
207  archive_element : `lsst.afwTable.io.Persistable`, optional
208  Archive element (e.g. Transform or WCS) associated with this stamp.
209 
210  Returns
211  -------
212  stamp : `AbstractStamp`
213  An instance of this class
214  """
215  raise NotImplementedError
216 
217 
218 @dataclass

The documentation for this class was generated from the following file: