lsst.meas.algorithms.stamps.Stamp Class Reference

Inheritance diagram for lsst.meas.algorithms.stamps.Stamp:

Public Member Functions
def	factory (cls, stamp_im, metadata, index, archive_element=None)

Detailed Description

Single stamp

Parameters
----------
stamp_im : `lsst.afw.image.MaskedImageF`
    The actual pixel values for the postage stamp
position : `lsst.geom.SpherePoint`, optional
    Position of the center of the stamp.  Note the user
    must keep track of the coordinate system

Definition at line 219 of file stamps.py.

Member Function Documentation

factory()

def lsst.meas.algorithms.stamps.Stamp.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.  If lists of values are passed with the following
keys, they will be passed to the constructor, otherwise dummy
values will be passed: RA_DEG, DEC_DEG.  They should
each point to lists of values.

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 : `afwTable.io.Persistable`, optional
    Archive element (e.g. Transform or WCS) associated with this stamp.

Returns
-------
stamp : `Stamp`
    An instance of this class

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

Definition at line 235 of file stamps.py.

    def 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.  If lists of values are passed with the following
        keys, they will be passed to the constructor, otherwise dummy
        values will be passed: RA_DEG, DEC_DEG.  They should
        each point to lists of values.
 
        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 : `afwTable.io.Persistable`, optional
            Archive element (e.g. Transform or WCS) associated with this stamp.
 
        Returns
        -------
        stamp : `Stamp`
            An instance of this class
        """
        if 'RA_DEG' in metadata and 'DEC_DEG' in metadata:
            return cls(stamp_im=stamp_im, archive_element=archive_element,
                       position=SpherePoint(Angle(metadata.getArray('RA_DEG')[index], degrees),
                                            Angle(metadata.getArray('DEC_DEG')[index], degrees)))
        else:
            return cls(stamp_im=stamp_im, archive_element=archive_element,
                       position=SpherePoint(Angle(numpy.nan), Angle(numpy.nan)))
 
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/stamps.py