Coverage for python/lsst/afw/image/_exposureInfoContinued.py: 82%

15 statements  

« prev     ^ index     » next       coverage.py v7.1.0, created at 2023-02-05 17:50 -0800

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# 

19from lsst.utils.deprecated import deprecate_pybind11 

20from lsst.utils import continueClass 

21 

22from ._imageLib import ExposureInfo 

23 

24__all__ = [] # import this module only for its side effects 

25 

26 

27ExposureInfo.getFilter = deprecate_pybind11( 

28 ExposureInfo.getFilter, 

29 reason="Replaced by getFilterLabel. Will be removed after v22.", 

30 version="v22.0") 

31 

32ExposureInfo.setFilter = deprecate_pybind11( 

33 ExposureInfo.setFilter, 

34 reason="Replaced by setFilterLabel. Will be removed after v22.", 

35 version="v22.0") 

36 

37 

38@continueClass 

39class ExposureInfo: # noqa: F811 

40 KEY_SUMMARY_STATS = 'SUMMARY_STATS' 

41 

42 def getSummaryStats(self): 

43 """Get exposure summary statistics component. 

44 

45 Returns 

46 ------- 

47 summaryStats : `lsst.afw.image.ExposureSummaryStats` 

48 """ 

49 return self.getComponent(self.KEY_SUMMARY_STATS) 

50 

51 def setSummaryStats(self, summaryStats): 

52 """Set exposure summary statistics component. 

53 

54 Parameters 

55 ---------- 

56 summaryStats : `lsst.afw.image.ExposureSummaryStats` 

57 """ 

58 self.setComponent(self.KEY_SUMMARY_STATS, summaryStats) 

59 

60 def hasSummaryStats(self): 

61 """Check if exposureInfo has a summary statistics component. 

62 

63 Returns 

64 ------- 

65 hasSummaryStats : `bool` 

66 True if exposureInfo has a summary statistics component. 

67 """ 

68 return self.hasComponent(self.KEY_SUMMARY_STATS)