lsst.afw.fits._pickleFits Namespace Reference
Functions | |
| reduceToFits (obj) | |
| unreduceFromFits (cls, data, size) | |
Function Documentation
◆ reduceToFits()
| 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.CompressionOptions`.
Returns
-------
reduced : `tuple` [callable, `tuple`]
a tuple in the format returned by `~object.__reduce__`
Definition at line 28 of file _pickleFits.py.
28def 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.CompressionOptions`.
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 = CompressionOptions()
47 table = getattr(obj, 'table', None)
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:74
◆ unreduceFromFits()
| 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.
62def 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)
Generated on Thu Nov 27 2025 09:15:05 for LSST Applications by
1.13.2