lsst.afw  21.0.0-35-g4939cbb3d+fb0e51fe34
_exposureSummaryStats.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 # 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 from __future__ import annotations
22 
23 from dataclasses import dataclass, asdict, field
24 import yaml
25 
26 from ..typehandling import Storable, StorableHelperFactory
27 
28 
29 __all__ = ("ExposureSummaryStats", )
30 
31 
32 def _default_corners():
33  return [float('nan')]*4
34 
35 
36 @dataclass
38  _persistence_name = 'ExposureSummaryStats'
39 
40  _factory = StorableHelperFactory(__name__, _persistence_name)
41 
42  version: int = 0
43  # PSF determinant radius (pixels)
44  psfSigma: float = float('nan')
45  # PSF effective area (pixels**2)
46  psfArea: float = float('nan')
47  # PSF shape Ixx (pixels**2)
48  psfIxx: float = float('nan')
49  # PSF shape Iyy (pixels**2)
50  psfIyy: float = float('nan')
51  # PSF shape Ixy (pixels**2)
52  psfIxy: float = float('nan')
53  # Bounding box center Right Ascension (degrees)
54  ra: float = float('nan')
55  # Bounding box center Declination (degrees)
56  decl: float = float('nan')
57  # Bounding box center zenith distance (degrees)
58  zenithDistance: float = float('nan')
59  # Mean zeropoint in detector (mag)
60  zeroPoint: float = float('nan')
61  # Average sky background (ADU)
62  skyBg: float = float('nan')
63  # Average sky noise (ADU)
64  skyNoise: float = float('nan')
65  # Mean variance of the weight plane (ADU**2)
66  meanVar: float = float('nan')
67  # Right Ascension of bounding box corners (degrees)
68  raCorners: list[float] = field(default_factory=_default_corners)
69  # Declination of bounding box corners (degrees)
70  decCorners: list[float] = field(default_factory=_default_corners)
71 
72  def __post_init__(self):
73  Storable.__init__(self)
74 
75  def isPersistable(self):
76  return True
77 
78  def _getPersistenceName(self):
79  return self._persistence_name_persistence_name
80 
81  def _getPythonModule(self):
82  return __name__
83 
84  def _write(self):
85  return yaml.dump(asdict(self), encoding='utf-8')
86 
87  @staticmethod
88  def _read(bytes):
89  return ExposureSummaryStats(**yaml.load(bytes, Loader=yaml.SafeLoader))
table::Key< int > field
Definition: ApCorrMap.cc:77
virtual bool isPersistable() const noexcept
Return true if this particular object can be persisted using afw::table::io.
Definition: Persistable.h:102
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58