LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
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 28 of file _pickleFits.py.

28 def reduceToFits(obj):
29  """Pickle to FITS
30 
31  Intended to be used by the ``__reduce__`` method of a class.
32 
33  Parameters
34  ----------
35  obj
36  any object with a ``writeFits`` method taking a
37  `~lsst.afw.fits.MemFileManager` and possibly an
38  `~lsst.afw.fits.ImageWriteOptions`.
39 
40  Returns
41  -------
42  reduced : `tuple` [callable, `tuple`]
43  a tuple in the format returned by `~object.__reduce__`
44  """
45  manager = MemFileManager()
46  options = ImageWriteOptions(ImageCompressionOptions(ImageCompressionOptions.NONE))
47  table = getattr(obj, 'table', None)
48  if isinstance(table, lsst.afw.table.BaseTable):
49  # table objects don't take `options`
50  obj.writeFits(manager)
51  else:
52  # MaskedImage and Exposure both require options for each plane (image, mask, variance)
54  obj.writeFits(manager, options, options, options)
55  else:
56  obj.writeFits(manager, options)
57  size = manager.getLength()
58  data = manager.getData()
59  return (unreduceFromFits, (obj.__class__, data, size))
60 
61 
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 62 of file _pickleFits.py.

62 def unreduceFromFits(cls, data, size):
63  """Unpickle from FITS
64 
65  Unpack data produced by `reduceToFits`. This method is used by the
66  pickling framework and should not need to be called from user code.
67 
68  Parameters
69  ----------
70  cls : `type`
71  the class of object to unpickle. Must have a class-level ``readFits``
72  method taking a `~lsst.afw.fits.MemFileManager`.
73  data : `bytes`
74  an in-memory representation of the object, compatible with
75  `~lsst.afw.fits.MemFileManager`
76  size : `int`
77  the length of `data`
78 
79  Returns
80  -------
81  unpickled : ``cls``
82  the object represented by ``data``
83  """
84  manager = MemFileManager(size)
85  manager.setData(data, size)
86  return cls.readFits(manager)
def unreduceFromFits(cls, data, size)
Definition: _pickleFits.py:62