Coverage for python/lsst/ip/isr/masking.py: 90%

10 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-02-09 03:43 -0800

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__ = ["MaskingConfig", "MaskingTask"] 

24 

25from lsst.pex.config import Config, Field 

26from lsst.pipe.base import Task 

27 

28 

29class MaskingConfig(Config): 

30 doSpecificMasking = Field( 

31 dtype=bool, 

32 doc="", 

33 default=False, 

34 ) 

35 

36 

37class MaskingTask(Task): 

38 """Perform extra masking for detector issues such as ghosts and glints. 

39 """ 

40 ConfigClass = MaskingConfig 

41 _DefaultName = "isrMasking" 

42 

43 def run(self, exposure): 

44 """Mask a known bad region of an exposure. 

45 

46 Parameters 

47 ---------- 

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

49 Exposure to construct detector-specific masks for. 

50 

51 Returns 

52 ------- 

53 status : scalar 

54 This task is currently not implemented, and should be 

55 retargeted by a camera specific version. 

56 """ 

57 return