LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+4b710797af,21.0.0-1-gfc31b0f+3b24369756,21.0.0-10-g2408eff+50e97f2f47,21.0.0-10-g560fb7b+0803ad37c5,21.0.0-10-g5daeb2b+f9b8dc6d5a,21.0.0-10-g8d1d15d+77a6b82ebf,21.0.0-10-gcf60f90+c961be884d,21.0.0-11-g25eff31+7692554667,21.0.0-17-g6590b197+a14a01c114,21.0.0-2-g103fe59+b79afc2051,21.0.0-2-g1367e85+1003a3501c,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+1003a3501c,21.0.0-2-g7f82c8f+c2a1919b98,21.0.0-2-g8f08a60+fd0b970de5,21.0.0-2-ga326454+c2a1919b98,21.0.0-2-gde069b7+ca45a81b40,21.0.0-2-gecfae73+afcaaec585,21.0.0-2-gfc62afb+1003a3501c,21.0.0-21-g5d80ea29e+5e3c9a3766,21.0.0-3-g357aad2+c67f36f878,21.0.0-3-g4be5c26+1003a3501c,21.0.0-3-g65f322c+02b1f88459,21.0.0-3-g7d9da8d+3b24369756,21.0.0-3-ge02ed75+a423c2ae7a,21.0.0-4-g591bb35+a423c2ae7a,21.0.0-4-g65b4814+0803ad37c5,21.0.0-4-g88306b8+199c7497e5,21.0.0-4-gccdca77+a631590478,21.0.0-4-ge8a399c+b923ff878e,21.0.0-5-gd00fb1e+d8b1e95daa,21.0.0-53-ge728e5d5+3cb64fea8e,21.0.0-6-g2d4f3f3+04719a4bac,21.0.0-7-g04766d7+8d320c19d5,21.0.0-7-g98eecf7+205433fbda,21.0.0-9-g39e06b5+a423c2ae7a,master-gac4afde19b+a423c2ae7a,w.2021.11
LSST Data Management Base Package
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 from lsst.utils.deprecated import deprecate_pybind11
20 from lsst.utils import continueClass
21 
22 from . import ExposureInfo
23 
24 __all__ = [] # import this module only for its side effects
25 
26 
27 ExposureInfo.getFilter = deprecate_pybind11(
28  ExposureInfo.getFilter,
29  reason="Replaced by getFilterLabel. Will be removed after v22.",
30  version="v22.0")
31 
32 ExposureInfo.setFilter = deprecate_pybind11(
33  ExposureInfo.setFilter,
34  reason="Replaced by setFilterLabel. Will be removed after v22.",
35  version="v22.0")
36 
37 
38 @continueClass
39 class 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_STATSKEY_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_STATSKEY_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_STATSKEY_SUMMARY_STATS)
def deprecate_pybind11(obj, reason, version=None, category=FutureWarning)
Definition: deprecated.py:32