lsst.afw g9029821c7d+1f5ff3162d
_exposureInfoContinued.py
Go to the documentation of this file.
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
21from lsst.utils.deprecated import deprecate_pybind11
22
23from ._imageLib import ExposureInfo
24
25__all__ = [] # import this module only for its side effects
26
27
28@continueClass
29class ExposureInfo: # noqa: F811
30 KEY_SUMMARY_STATS = 'SUMMARY_STATS'
31
32 def getSummaryStats(self):
33 """Get exposure summary statistics component.
34
35 Returns
36 -------
38 """
39 return self.getComponent(self.KEY_SUMMARY_STATS)
40
41 def setSummaryStats(self, summaryStats):
42 """Set exposure summary statistics component.
43
44 Parameters
45 ----------
47 """
48 self.setComponent(self.KEY_SUMMARY_STATS, summaryStats)
49
50 def hasSummaryStats(self):
51 """Check if exposureInfo has a summary statistics component.
52
53 Returns
54 -------
55 hasSummaryStats : `bool`
56 True if exposureInfo has a summary statistics component.
57 """
58 return self.hasComponent(self.KEY_SUMMARY_STATS)
59
60
61ExposureInfo.hasFilterLabel = deprecate_pybind11(
62 ExposureInfo.hasFilterLabel,
63 reason="Replaced by hasFilter. Will be removed after v24.",
64 version="v24.0")
65ExposureInfo.getFilterLabel = deprecate_pybind11(
66 ExposureInfo.getFilterLabel,
67 reason="Replaced by getFilter. Will be removed after v24.",
68 version="v24.0")
69ExposureInfo.setFilterLabel = deprecate_pybind11(
70 ExposureInfo.setFilterLabel,
71 reason="Replaced by setFilter. Will be removed after v24.",
72 version="v24.0")