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

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 "imageWriteFitsWithOptions", "exposureWriteFitsWithOptions"] 

24 

25import logging 

26import lsst.geom 

27from lsst.afw.fits import ImageWriteOptions 

28from ._imageLib import ImageOrigin 

29 

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

31 

32 

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

34# 

35# @continueclass 

36# class MaskX: 

37# readFitsWithOptions = classmethod(imageReadFitsWithOptions) 

38def imageReadFitsWithOptions(cls, source, options): 

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

40 with options. 

41 

42 Parameters 

43 ---------- 

44 source : `str` 

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

46 or exposure. 

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

48 Read options: 

49 

50 - llcX: bbox minimum x (int) 

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

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

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

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

55 a bbox is specified by llcX, etc.) 

56 

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

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

59 

60 Raises 

61 ------ 

62 RuntimeError 

63 If options contains an unknown value for "imageOrigin" 

64 lsst.pex.exceptions.NotFoundError 

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

66 "llcY", "width", or "height". 

67 """ 

68 origin = ImageOrigin.PARENT 

69 bbox = lsst.geom.Box2I() 

70 if "bbox" in options: 

71 bbox = options["bbox"] 

72 elif "llcX" in options: 

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

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

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

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

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

78 if "imageOrigin" in options: 

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

80 if (originStr == "LOCAL"): 

81 origin = ImageOrigin.LOCAL 

82 elif (originStr == "PARENT"): 

83 origin = ImageOrigin.PARENT 

84 else: 

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

86 

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

88 

89 

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

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

92 

93 Parameters 

94 ---------- 

95 dest : `str` 

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

97 options : `lsst.daf.base.PropertySet` 

98 Write options. The item ``item`` is read (which defaults to "image"). 

99 It must contain an `lsst.daf.base.PropertySet` with data for 

100 ``lsst.afw.fits.ImageWriteOptions``. 

101 item : `str`, optional 

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

103 """ 

104 if options is not None: 

105 try: 

106 writeOptions = ImageWriteOptions(options.getPropertySet(item)) 

107 except Exception: 

108 _LOG.exception("Could not parse item %s from options; writing with defaults.", item) 

109 else: 

110 self.writeFits(dest, writeOptions) 

111 return 

112 self.writeFits(dest) 

113 

114 

115def exposureWriteFitsWithOptions(self, dest, options): 

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

117 

118 Parameters 

119 ---------- 

120 dest : `str` 

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

122 options : `lsst.daf.base.PropertySet` 

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

124 Each must be an `lsst.daf.base.PropertySet` with data for 

125 ``lsst.afw.fits.ImageWriteOptions``. 

126 """ 

127 if options is not None: 

128 try: 

129 writeOptionDict = {name + "Options": ImageWriteOptions(options.getPropertySet(name)) 

130 for name in ("image", "mask", "variance")} 

131 except Exception: 

132 _LOG.exception("Could not parse options; writing with defaults.") 

133 else: 

134 self.writeFits(dest, **writeOptionDict) 

135 return 

136 self.writeFits(dest)