lsst.meas.algorithms  20.0.0-16-g760a3dc6+7dead9ab29
Classes | Functions
lsst.meas.algorithms.stamps Namespace Reference

Classes

class  AbstractStamp
 
class  Stamp
 
class  Stamps
 
class  StampsBase
 

Functions

def writeFits (filename, stamp_ims, metadata, write_mask, write_variance)
 
def readFitsWithOptions (filename, stamp_factory, options)
 

Function Documentation

◆ readFitsWithOptions()

def lsst.meas.algorithms.stamps.readFitsWithOptions (   filename,
  stamp_factory,
  options 
)
Read stamps from FITS file, allowing for only a
subregion of the stamps to be read.

Parameters
----------
filename : `str`
    A string indicating the file to read
stamp_factory : classmethod
    A factory function defined on a dataclass for constructing
    stamp objects a la `lsst.meas.alrogithm.Stamp`
options : `PropertyList`
    A collection of parameters.  If certain keys are available
    (``llcX``, ``llcY``, ``width``, ``height``), a bounding box
    is constructed and passed to the ``FitsReader`` in order
    to return a sub-image.

Returns
-------
stamps : `list` of dataclass objects like `Stamp`, PropertyList
    A tuple of a list of `Stamp`-like objects
metadata : `PropertyList`
    The metadata

Definition at line 81 of file stamps.py.

◆ writeFits()

def lsst.meas.algorithms.stamps.writeFits (   filename,
  stamp_ims,
  metadata,
  write_mask,
  write_variance 
)
Write a single FITS file containing all stamps.

Parameters
----------
filename : `str`
    A string indicating the output filename
stamps_ims : iterable of `lsst.afw.image.MaskedImageF`
    An iterable of masked images
metadata : `PropertyList`
    A collection of key, value metadata pairs to be
    written to the primary header
write_mask : `bool`
    Write the mask data to the output file?
write_variance : `bool`
    Write the variance data to the output file?

Definition at line 38 of file stamps.py.