LSST Applications  21.0.0+c4f5df5339,21.0.0+e70536a077,21.0.0-1-ga51b5d4+7c60f8a6ea,21.0.0-10-g560fb7b+411cd868f8,21.0.0-10-gcf60f90+8c49d86aa0,21.0.0-13-gc485e61d+38156233bf,21.0.0-16-g7a993c7b9+1041c3824f,21.0.0-2-g103fe59+d9ceee3e5a,21.0.0-2-g1367e85+0b2f7db15a,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g5242d73+0b2f7db15a,21.0.0-2-g7f82c8f+feb9862f5e,21.0.0-2-g8f08a60+9c9a9cfcc8,21.0.0-2-ga326454+feb9862f5e,21.0.0-2-gde069b7+bedfc5e1fb,21.0.0-2-gecfae73+417509110f,21.0.0-2-gfc62afb+0b2f7db15a,21.0.0-3-g21c7a62+a91f7c0b59,21.0.0-3-g357aad2+062581ff1a,21.0.0-3-g4be5c26+0b2f7db15a,21.0.0-3-g65f322c+85aa0ead76,21.0.0-3-g7d9da8d+c4f5df5339,21.0.0-3-gaa929c8+411cd868f8,21.0.0-3-gc44e71e+fd4029fd48,21.0.0-3-ge02ed75+5d9b90b8aa,21.0.0-38-g070523fc+44fda2b515,21.0.0-4-g591bb35+5d9b90b8aa,21.0.0-4-g88306b8+3cdc83ea97,21.0.0-4-gc004bbf+d52368b591,21.0.0-4-gccdca77+a5c54364a0,21.0.0-5-g7ebb681+81e2098694,21.0.0-5-gdf36809+87b8d260e6,21.0.0-6-g2d4f3f3+e70536a077,21.0.0-6-g4e60332+5d9b90b8aa,21.0.0-6-g5ef7dad+3f4e29eeae,21.0.0-7-gc8ca178+0f5e56d48f,21.0.0-9-g9eb8d17+cc2c7a81aa,master-gac4afde19b+5d9b90b8aa,w.2021.07
LSST Data Management Base Package
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.

7 def reduceToFits(obj):
8  """Pickle to FITS
9 
10  Intended to be used by the ``__reduce__`` method of a class.
11 
12  Parameters
13  ----------
14  obj
15  any object with a ``writeFits`` method taking a
16  `~lsst.afw.fits.MemFileManager` and possibly an
17  `~lsst.afw.fits.ImageWriteOptions`.
18 
19  Returns
20  -------
21  reduced : `tuple` [callable, `tuple`]
22  a tuple in the format returned by `~object.__reduce__`
23  """
24  manager = MemFileManager()
25  options = ImageWriteOptions(ImageCompressionOptions(ImageCompressionOptions.NONE))
26  table = getattr(obj, 'table', None)
27  if isinstance(table, lsst.afw.table.BaseTable):
28  # table objects don't take `options`
29  obj.writeFits(manager)
30  else:
31  # MaskedImage and Exposure both require options for each plane (image, mask, variance)
33  obj.writeFits(manager, options, options, options)
34  else:
35  obj.writeFits(manager, options)
36  size = manager.getLength()
37  data = manager.getData()
38  return (unreduceFromFits, (obj.__class__, data, size))
39 
40 
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition: Exposure.h:72
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
Base class for all tables.
Definition: BaseTable.h:61

◆ 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.

41 def unreduceFromFits(cls, data, size):
42  """Unpickle from FITS
43 
44  Unpack data produced by `reduceToFits`. This method is used by the
45  pickling framework and should not need to be called from user code.
46 
47  Parameters
48  ----------
49  cls : `type`
50  the class of object to unpickle. Must have a class-level ``readFits``
51  method taking a `~lsst.afw.fits.MemFileManager`.
52  data : `bytes`
53  an in-memory representation of the object, compatible with
54  `~lsst.afw.fits.MemFileManager`
55  size : `int`
56  the length of `data`
57 
58  Returns
59  -------
60  unpickled : ``cls``
61  the object represented by ``data``
62  """
63  manager = MemFileManager(size)
64  manager.setData(data, size)
65  return cls.readFits(manager)
def unreduceFromFits(cls, data, size)
Definition: pickleFits.py:41