LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+b203dec576,g18429d2f64+358861cd2c,g199a45376c+0ba108daf9,g1fd858c14a+dd066899e3,g262e1987ae+ebfced1d55,g29ae962dfc+72fd90588e,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+b668f15bc5,g4595892280+3897dae354,g47891489e3+abcf9c3559,g4d44eb3520+fb4ddce128,g53246c7159+8c5ae1fdc5,g67b6fd64d1+abcf9c3559,g67fd3c3899+1f72b5a9f7,g74acd417e5+cb6b47f07b,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+abcf9c3559,g8d7436a09f+bcf525d20c,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+6054cc57f1,g97be763408+06f794da49,g9dd6db0277+1f72b5a9f7,ga681d05dcb+7e36ad54cd,gabf8522325+735880ea63,gac2eed3f23+abcf9c3559,gb89ab40317+abcf9c3559,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+1f72b5a9f7,gdab6d2f7ff+cb6b47f07b,gdc713202bf+1f72b5a9f7,gdfd2d52018+8225f2b331,ge365c994fd+375fc21c71,ge410e46f29+abcf9c3559,geaed405ab2+562b3308c0,gf9a733ac38+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.ImageWriteOptions`.

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.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:74
Base class for all tables.
Definition BaseTable.h:61

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