lsst.meas.algorithms  22.0.1-23-gc2439a9a+fb094c5b8f
Classes | Functions
lsst.meas.algorithms.stamps Namespace Reference

Classes

class  AbstractStamp
 
class  Stamp
 
class  StampsBase
 
class  Stamps
 

Functions

def writeFits (filename, stamps, metadata, type_name, write_mask, write_variance, write_archive=False)
 
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` or `dict`
    A collection of parameters. If it contains a bounding box
    (``bbox`` key), or if certain other keys (``llcX``, ``llcY``,
    ``width``, ``height``) are available for one to be  constructed,
    the bounding box is 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 101 of file stamps.py.

◆ writeFits()

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

Parameters
----------
filename : `str`
    A string indicating the output filename
stamps : iterable of `BaseStamp`
    An iterable of Stamp objects
metadata : `PropertyList`
    A collection of key, value metadata pairs to be
    written to the primary header
type_name : `str`
    Python type name of the StampsBase subclass to use
write_mask : `bool`
    Write the mask data to the output file?
write_variance : `bool`
    Write the variance data to the output file?
write_archive : `bool`, optional
    Write an archive to store Persistables along with each stamp?
    Default: ``False``.

Definition at line 42 of file stamps.py.