Coverage for python/lsst/ip/isr/ampOffset.py: 73%

24 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2022-10-01 02:13 -0700

1# This file is part of ip_isr. 

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# import os 

22 

23__all__ = ["AmpOffsetConfig", "AmpOffsetTask"] 

24 

25import lsst.pex.config as pexConfig 

26import lsst.pipe.base as pipeBase 

27from lsst.meas.algorithms import (SubtractBackgroundTask, SourceDetectionTask) 

28 

29 

30class AmpOffsetConfig(pexConfig.Config): 

31 """Configuration parameters for AmpOffsetTask. 

32 """ 

33 ampEdgeInset = pexConfig.Field( 

34 doc="Number of pixels the amp edge strip is inset from the amp edge. A thin strip of pixels running " 

35 "parallel to the edge of the amp is used to characterize the average flux level at the amp edge.", 

36 dtype=int, 

37 default=5, 

38 ) 

39 ampEdgeWidth = pexConfig.Field( 

40 doc="Pixel width of the amp edge strip, starting at ampEdgeInset and extending inwards.", 

41 dtype=int, 

42 default=64, 

43 ) 

44 ampEdgeMinFrac = pexConfig.Field( 

45 doc="Minimum allowed fraction of viable pixel rows along an amp edge. No amp offset estimate will be " 

46 "generated for amp edges that do not have at least this fraction of unmasked pixel rows.", 

47 dtype=float, 

48 default=0.5, 

49 ) 

50 ampEdgeMaxOffset = pexConfig.Field( 

51 doc="Maximum allowed amp offset ADU value. If a measured amp offset value is larger than this, the " 

52 "result will be discarded and therefore not used to determine amp pedestal corrections.", 

53 dtype=float, 

54 default=5.0, 

55 ) 

56 ampEdgeWindow = pexConfig.Field( 

57 doc="Pixel size of the sliding window used to generate rolling average amp offset values.", 

58 dtype=int, 

59 default=512, 

60 ) 

61 doBackground = pexConfig.Field( 

62 doc="Estimate and subtract background prior to amp offset estimation?", 

63 dtype=bool, 

64 default=True, 

65 ) 

66 background = pexConfig.ConfigurableField( 

67 doc="An initial background estimation step run prior to amp offset calculation.", 

68 target=SubtractBackgroundTask, 

69 ) 

70 doDetection = pexConfig.Field( 

71 doc="Detect sources and update cloned exposure prior to amp offset estimation?", 

72 dtype=bool, 

73 default=True, 

74 ) 

75 detection = pexConfig.ConfigurableField( 

76 doc="Source detection to add temporary detection footprints prior to amp offset calculation.", 

77 target=SourceDetectionTask, 

78 ) 

79 

80 

81class AmpOffsetTask(pipeBase.Task): 

82 """Calculate and apply amp offset corrections to an exposure. 

83 """ 

84 ConfigClass = AmpOffsetConfig 

85 _DefaultName = "isrAmpOffset" 

86 

87 def __init__(self, *args, **kwargs): 

88 super().__init__(**kwargs) 

89 # always load background subtask, even if doBackground=False; 

90 # this allows for default plane bit masks to be defined 

91 self.makeSubtask("background") 

92 if self.config.doDetection: 

93 self.makeSubtask("detection") 

94 

95 def run(self, exposure): 

96 """Calculate amp offset values, determine corrective pedestals for each 

97 amp, and update the input exposure in-place. This task is currently not 

98 implemented, and should be retargeted by a camera specific version. 

99 

100 Parameters 

101 ---------- 

102 exposure : `lsst.afw.image.Exposure` 

103 Exposure to be corrected for any amp offsets. 

104 """ 

105 raise NotImplementedError("Amp offset task should be retargeted by a camera specific version.")