lsst.afw  20.0.0-17-g80088cf60+109ac6652c
Functions
lsst.afw.fits.pickleFits Namespace Reference

Functions

def reduceToFits (obj)
 
def unreduceFromFits (cls, data, size)
 

Function Documentation

◆ reduceToFits()

def lsst.afw.fits.pickleFits.reduceToFits (   obj)
Pickle to FITS

Intended to be used by the ``__reduce__`` method of a class.

Parameters
----------
obj
    any object with a ``writeFits`` method taking a
    `~lsst.afw.fits.MemFileManager` and possibly an
    `~lsst.afw.fits.ImageWriteOptions`.

Returns
-------
reduced : `tuple` [callable, `tuple`]
    a tuple in the format returned by `~object.__reduce__`

Definition at line 7 of file pickleFits.py.

◆ unreduceFromFits()

def lsst.afw.fits.pickleFits.unreduceFromFits (   cls,
  data,
  size 
)
Unpickle from FITS

Unpack data produced by `reduceToFits`. This method is used by the
pickling framework and should not need to be called from user code.

Parameters
----------
cls : `type`
    the class of object to unpickle. Must have a class-level ``readFits``
    method taking a `~lsst.afw.fits.MemFileManager`.
data : `bytes`
    an in-memory representation of the object, compatible with
    `~lsst.afw.fits.MemFileManager`
size : `int`
    the length of `data`

Returns
-------
unpickled : ``cls``
    the object represented by ``data``

Definition at line 41 of file pickleFits.py.