LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.stamps.Stamp Class Reference
Inheritance diagram for lsst.meas.algorithms.stamps.Stamp:
lsst.meas.algorithms.stamps.AbstractStamp

Public Member Functions

 factory (cls, stamp_im, metadata, index, archive_element=None)
 

Static Public Attributes

MaskedImageF stamp_im
 
Persistable archive_element = None
 
SpherePoint position = field(default_factory=_default_position)
 

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 249 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 : `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 : `Stamp`
    An instance of this class

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

Definition at line 268 of file stamps.py.

268 def factory(cls, stamp_im, metadata, index, archive_element=None):
269 """This method is needed to service the FITS reader. We need a standard
270 interface to construct objects like this. Parameters needed to
271 construct this object are passed in via a metadata dictionary and then
272 passed to the constructor of this class. If lists of values are passed
273 with the following keys, they will be passed to the constructor,
274 otherwise dummy values will be passed: RA_DEG, DEC_DEG. They should
275 each point to lists of values.
276
277 Parameters
278 ----------
279 stamp : `~lsst.afw.image.MaskedImage`
280 Pixel data to pass to the constructor
281 metadata : `dict`
282 Dictionary containing the information
283 needed by the constructor.
284 idx : `int`
285 Index into the lists in ``metadata``
286 archive_element : `~lsst.afw.table.io.Persistable`, optional
287 Archive element (e.g. Transform or WCS) associated with this stamp.
288
289 Returns
290 -------
291 stamp : `Stamp`
292 An instance of this class
293 """
294 if "RA_DEG" in metadata and "DEC_DEG" in metadata:
295 return cls(
296 stamp_im=stamp_im,
297 archive_element=archive_element,
298 position=SpherePoint(
299 Angle(metadata.getArray("RA_DEG")[index], degrees),
300 Angle(metadata.getArray("DEC_DEG")[index], degrees),
301 ),
302 )
303 else:
304 return cls(
305 stamp_im=stamp_im,
306 archive_element=archive_element,
307 position=SpherePoint(Angle(np.nan), Angle(np.nan)),
308 )
309
310

Member Data Documentation

◆ archive_element

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

Definition at line 264 of file stamps.py.

◆ position

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

Definition at line 265 of file stamps.py.

◆ stamp_im

MaskedImageF lsst.meas.algorithms.stamps.Stamp.stamp_im
static

Definition at line 263 of file stamps.py.


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