Loading [MathJax]/extensions/tex2jax.js
LSST Applications 28.0.0,g1653933729+a8ce1bb630,g1a997c3884+a8ce1bb630,g28da252d5a+5bd70b7e6d,g2bbee38e9b+638fca75ac,g2bc492864f+638fca75ac,g3156d2b45e+07302053f8,g347aa1857d+638fca75ac,g35bb328faa+a8ce1bb630,g3a166c0a6a+638fca75ac,g3e281a1b8c+7bbb0b2507,g4005a62e65+17cd334064,g414038480c+5b5cd4fff3,g41af890bb2+4ffae9de63,g4e1a3235cc+0f1912dca3,g6249c6f860+3c3976f90c,g80478fca09+46aba80bd6,g82479be7b0+77990446f6,g858d7b2824+78ba4d1ce1,g89c8672015+f667a5183b,g9125e01d80+a8ce1bb630,ga5288a1d22+2a6264e9ca,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc22bb204ba+78ba4d1ce1,gc28159a63d+638fca75ac,gcf0d15dbbd+32ddb6096f,gd6b7c0dfd1+3e339405e9,gda3e153d99+78ba4d1ce1,gda6a2b7d83+32ddb6096f,gdaeeff99f8+1711a396fd,gdd5a9049c5+b18c39e5e3,ge2409df99d+a5e4577cdc,ge33fd446bb+78ba4d1ce1,ge79ae78c31+638fca75ac,gf0baf85859+64e8883e75,gf5289d68f6+e1b046a8d7,gfa443fc69c+91d9ed1ecf,gfda6b12a05+8419469a56
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
statistic.py
Go to the documentation of this file.
1# This file is part of pipe_tasks.
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
22__all__ = ['Statistic', 'Count', 'Median', 'Percentile', 'StandardDeviation', 'SigmaIQR', 'SigmaMAD',
23 'Statistics']
24
25from abc import ABCMeta, abstractmethod
26from astropy.stats import mad_std
27from dataclasses import dataclass
28import numpy as np
29from scipy.stats import iqr
30
31
32class Statistic(metaclass=ABCMeta):
33 """Compute a statistic from a list of values.
34 """
35 # TODO: Make this a property after upgrade to Python 3.9
36 @classmethod
37 @abstractmethod
38 def name(cls):
39 pass
40
41 @abstractmethod
42 def value(self, values):
43 """Return the value of the statistic given a set of values.
44
45 Parameters
46 ----------
47 values : `Collection` [`float`]
48 A set of values to compute the statistic for.
49 Returns
50 -------
51 statistic : `float`
52 The value of the statistic.
53 """
54 pass
55
56
57class Count(Statistic):
58 @classmethod
59 def name(cls):
60 return "count"
61
62 """The median of a set of values."""
63 def value(self, values):
64 return len(values)
65
66
68 @classmethod
69 def name(cls):
70 return "median"
71
72 """The median of a set of values."""
73 def value(self, values):
74 return np.median(values)
75
76
77@dataclass(frozen=True)
79 """An arbitrary percentile.
80
81 Parameters
82 ----------
83 percentile : `float`
84 A valid percentile (0 <= p <= 100).
85 """
86 percentile: float
87
88 @classmethod
89 def name(cls):
90 return "percentile"
91
92 def value(self, values):
93 return np.percentile(values, self.percentile)
94
95
97 """The standard deviation (sigma)."""
98 @classmethod
99 def name(cls):
100 return "std"
101
102 def value(self, values):
103 return np.std(values)
104
105
107 """The re-scaled inter-quartile range (sigma equivalent)."""
108 @classmethod
109 def name(cls):
110 return "sigma_iqr"
111
112 def value(self, values):
113 return iqr(values, scale='normal')
114
115
117 """The re-scaled median absolute deviation (sigma equivalent)."""
118 @classmethod
119 def name(cls):
120 return "sigma_mad"
121
122 def value(self, values):
123 return mad_std(values)
124
125
126Statistics = {
127 stat.name(): stat
128 for stat in (Count, Median, Percentile, StandardDeviation, SigmaIQR, SigmaMAD)
129}
table::Key< std::string > name
Definition Amplifier.cc:116