LSST Applications g044012fb7c+304891ab8a,g04a91732dc+4e1b87f259,g07dc498a13+f701f15b83,g114c6a66ad+c7887c1284,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+6ebd102b59,g35bb328faa+0eb18584fe,g3bd4b5ce2c+e83bf4edc8,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+c7887c1284,g623d845a50+c7887c1284,g6f0c2978f1+98123c34b6,g71fabbc107+c7887c1284,g75b6c65c88+ce466f4385,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+cfe5cf5b7b,g89139ef638+f701f15b83,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g989de1cb63+f701f15b83,g9f33ca652e+b4908f5dcd,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gace736f484+07e57cea59,gb1101e3267+487fd1b06d,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+cfe5cf5b7b,gd0fa69b896+babbe6e5fe,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+e8379653a2,ge278dab8ac+ae64226a64,gfba249425e+0eb18584fe,w.2025.07
LSST Data Management Base Package
Loading...
Searching...
No Matches
_pickleFits.py
Go to the documentation of this file.
1# This file is part of afw.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21
22from lsst.afw.fits import MemFileManager, ImageWriteOptions, ImageCompressionOptions
23
24import lsst.afw.table
25import lsst.afw.image
26
27
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
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)
Lifetime-management for memory that goes into FITS memory files.
Definition fits.h:125
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 Statistics.h:42
Base class for all tables.
Definition BaseTable.h:61
unreduceFromFits(cls, data, size)
Options for tile compression of image pixels.
Options for writing an image to FITS.
Definition fits.h:223