Coverage for python / lsst / afw / image / _image / _fitsIoWithOptions.py: 18%

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 

22__all__ = ["imageReadFitsWithOptions",] 

23 

24import logging 

25import lsst.geom 

26from lsst.afw.fits import CompressionOptions 

27from ._imageLib import ImageOrigin 

28 

29_LOG = logging.getLogger("lsst.afw.image") 

30 

31 

32# This must be added to a class as a *classmethod*, for example: 

33# 

34# @continueclass 

35# class MaskX: 

36# readFitsWithOptions = classmethod(imageReadFitsWithOptions) 

37def imageReadFitsWithOptions(cls, source, options): 

38 """Read an Image, Mask, MaskedImage or Exposure from a FITS file, 

39 with options. 

40 

41 Parameters 

42 ---------- 

43 source : `str` 

44 Fits file path from which to read image, mask, masked image 

45 or exposure. 

46 options : `lsst.daf.base.PropertySet` or `dict` 

47 Read options: 

48 

49 - llcX: bbox minimum x (int) 

50 - llcY: bbox minimum y (int, must be present if llcX is present) 

51 - width: bbox width (int, must be present if llcX is present) 

52 - height: bbox height (int, must be present if llcX is present) 

53 - imageOrigin: one of "LOCAL" or "PARENT" (has no effect unless 

54 a bbox is specified by llcX, etc.) 

55 

56 Alternatively, a bounding box () can be passed on with the 

57 ``"bbox"'' (`lsst.geom.Box2I`) key. 

58 

59 Raises 

60 ------ 

61 RuntimeError 

62 If options contains an unknown value for "imageOrigin" 

63 lsst.pex.exceptions.NotFoundError 

64 If options contains "llcX" and is missing any of 

65 "llcY", "width", or "height". 

66 """ 

67 origin = ImageOrigin.PARENT 

68 bbox = lsst.geom.Box2I() 

69 if "bbox" in options: 

70 bbox = options["bbox"] 

71 elif "llcX" in options: 

72 llcX = int(options["llcX"]) 

73 llcY = int(options["llcY"]) 

74 width = int(options["width"]) 

75 height = int(options["height"]) 

76 bbox = lsst.geom.Box2I(lsst.geom.Point2I(llcX, llcY), lsst.geom.Extent2I(width, height)) 

77 if "imageOrigin" in options: 

78 originStr = str(options["imageOrigin"]) 

79 if (originStr == "LOCAL"): 

80 origin = ImageOrigin.LOCAL 

81 elif (originStr == "PARENT"): 

82 origin = ImageOrigin.PARENT 

83 else: 

84 raise RuntimeError("Unknown ImageOrigin type {}".format(originStr)) 

85 

86 return cls(source, bbox=bbox, origin=origin) 

87 

88 

89def imageWriteFitsWithOptions(self, dest, options, item="image"): 

90 """Write an Image or Mask to FITS, with options 

91 

92 Parameters 

93 ---------- 

94 dest : `str` 

95 Fits file path to which to write the image or mask. 

96 options : `~collections.abc.Mapping` 

97 Write options. The item ``item`` is accessed (which defaults to 

98 "image"). It must contain a mapping with data for 

99 `lsst.afw.fits.CompressionOptions.from_mapping`, or `None` for no 

100 compression. 

101 item : `str`, optional 

102 Item to read from the ``options`` parameter. 

103 """ 

104 if options is not None: 

105 writeOptions = CompressionOptions.from_mapping(options[item]) 

106 self.writeFits(dest, writeOptions) 

107 else: 

108 self.writeFits(dest) 

109 

110 

111def exposureWriteFitsWithOptions(self, dest, options): 

112 """Write an Exposure or MaskedImage to FITS, with options 

113 

114 Parameters 

115 ---------- 

116 dest : `str` 

117 Fits file path to which to write the exposure or masked image. 

118 options : `~collections.abc.Mapping` 

119 Write options. The items "image", "mask" and "variance" are read. 

120 Each must contain a mapping with data for 

121 `lsst.afw.fits.CompressionOptions.from_mapping`, or `None` for no 

122 compression. 

123 """ 

124 if options is not None: 

125 writeOptionDict = {name + "Options": CompressionOptions.from_mapping(plane_options) 

126 for name in ("image", "mask", "variance") 

127 if (plane_options := options[name]) is not None} 

128 self.writeFits(dest, **writeOptionDict) 

129 else: 

130 self.writeFits(dest)