lsst.meas.algorithms.stamps.Stamp Class Reference

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

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

Static Public Attributes
Persistable	archive_element = None
SpherePoint	position = field(default_factory=_default_position)
PropertyList	metadata = None

Detailed Description

Single stamp.

Parameters
----------
stamp_im : `~lsst.afw.image.MaskedImageF`
    The actual pixel values for the postage stamp.
archive_element : `~lsst.afw.table.io.Persistable` or `None`, optional
    Archive element (e.g. Transform or WCS) associated with this stamp.
position : `~lsst.geom.SpherePoint` or `None`, optional
    Position of the center of the stamp. Note the user must keep track of
    the coordinate system.

Definition at line 258 of file stamps.py.

Member Function Documentation

factory()

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 : `PropertyList`
    A collection of key, value metadata pairs 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 : `Stamp`
    An instance of this class

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

Definition at line 278 of file stamps.py.

Member Data Documentation

archive_element

Persistable lsst.meas.algorithms.stamps.Stamp.archive_element = None

static

Definition at line 273 of file stamps.py.

metadata

PropertyList lsst.meas.algorithms.stamps.Stamp.metadata = None

static

Definition at line 275 of file stamps.py.

position

SpherePoint lsst.meas.algorithms.stamps.Stamp.position = field(default_factory=_default_position)

static

Definition at line 274 of file stamps.py.

---

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

• python/lsst/meas/algorithms/stamps.py