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

12 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-01-25 02: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# 

19 

20from lsst.utils import continueClass 

21 

22from ._imageLib import ExposureInfo 

23 

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

25 

26 

27@continueClass 

28class ExposureInfo: # noqa: F811 

29 KEY_SUMMARY_STATS = 'SUMMARY_STATS' 

30 

31 def getSummaryStats(self): 

32 """Get exposure summary statistics component. 

33 

34 Returns 

35 ------- 

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

37 """ 

38 return self.getComponent(self.KEY_SUMMARY_STATS) 

39 

40 def setSummaryStats(self, summaryStats): 

41 """Set exposure summary statistics component. 

42 

43 Parameters 

44 ---------- 

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

46 """ 

47 self.setComponent(self.KEY_SUMMARY_STATS, summaryStats) 

48 

49 def hasSummaryStats(self): 

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

51 

52 Returns 

53 ------- 

54 hasSummaryStats : `bool` 

55 True if exposureInfo has a summary statistics component. 

56 """ 

57 return self.hasComponent(self.KEY_SUMMARY_STATS)