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

9 statements  

« prev     ^ index     » next       coverage.py v6.4, created at 2022-05-24 03:05 -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 

23from lsst.pex.config import Config, Field 

24from lsst.pipe.base import Task 

25 

26 

27class MaskingConfig(Config): 

28 doSpecificMasking = Field( 

29 dtype=bool, 

30 doc="", 

31 default=False, 

32 ) 

33 

34 

35class MaskingTask(Task): 

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

37 """ 

38 ConfigClass = MaskingConfig 

39 _DefaultName = "isrMasking" 

40 

41 def run(self, exposure): 

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

43 

44 Parameters 

45 ---------- 

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

47 Exposure to construct detector-specific masks for. 

48 

49 Returns 

50 ------- 

51 status : scalar 

52 This task is currently not implemented, and should be 

53 retargeted by a camera specific version. 

54 """ 

55 return