lsst.meas.algorithms  21.0.0-6-g2b8c1f54+e7fb5877da
Public Member Functions | List of all members
lsst.meas.algorithms.brightStarStamps.BrightStarStamp Class Reference
Inheritance diagram for lsst.meas.algorithms.brightStarStamps.BrightStarStamp:
lsst.meas.algorithms.stamps.AbstractStamp

Public Member Functions

def factory (cls, stamp_im, metadata, idx)
 

Detailed Description

Single stamp centered on a bright star, normalized by its
annularFlux.

Parameters
----------
stamp_im : `lsst.afw.image.MaskedImage`
    Pixel data for this postage stamp
gaiaGMag : `float`
    Gaia G magnitude for the object in this stamp
gaiaId : `int`
    Gaia object identifier
annularFlux : `float`
    Flux in an annulus around the object

Definition at line 43 of file brightStarStamps.py.

Member Function Documentation

◆ factory()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamp.factory (   cls,
  stamp_im,
  metadata,
  idx 
)
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.  This particular factory method requires keys:
G_MAGS, GAIA_IDS, and ANNULAR_FLUXES.  They should each
point to lists of values.

Parameters
----------
stamp_im : `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``

Returns
-------
brightstarstamp : `BrightStarStamp`
    An instance of this class

Reimplemented from lsst.meas.algorithms.stamps.AbstractStamp.

Definition at line 64 of file brightStarStamps.py.


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