sacc 1.0__py3-none-any.whl → 2.0__py3-none-any.whl

sacc/windows.py

@@ -1,8 +1,8 @@
 import numpy as np
 from astropy.table import Table
+from .io import BaseIO, MULTIPLE_OBJECTS_PER_TABLE, ONE_OBJECT_PER_TABLE
 
-
-class BaseWindow:
+class BaseWindow(BaseIO):
     """Base class for window functions.
 
     Window functions here are for 1D variables and describe
@@ -17,70 +17,10 @@ class BaseWindow:
     This base class has class methods that can be used to turn
     mixed lists of windows to/from astropy tables, for I/O.
     """
-    _window_classes = {}
-
-    def __init_subclass__(cls, window_type):
-        # This gets called whenever a subclass is defined.
-        # The window_type argument is specified next to the
-        # base class in the subclass definition, e.g.
-        # window_typ='TopHat', as shown below
-        cls._window_classes[window_type] = cls
-        cls.window_type = window_type
-
-    @classmethod
-    def to_tables(cls, instance_list):
-        """Convert a list of BaseWindos to a list of tables.
-
-        This is called when saving data to file.
+    _sub_classes = {}
 
-        The input instances can be different subclasses, and no
-        ordering is maintained.
 
-        Parameters
-        ----------
-        instance_list: list
-            List of BaseWindow subclass instances
-
-        Returns
-        -------
-        table: list
-            List of astropy.table.Table instances
-        """
-        tables = []
-        for name, subcls in cls._window_classes.items():
-            # Pull out the relevant objects for this subclass.
-            # Note that we can't use isinstance here.
-            windows = [w for w in instance_list if type(w) == subcls]
-            if len(windows) > 0:
-                tables += subcls.to_tables(windows)
-        return tables
-
-    @classmethod
-    def from_tables(cls, table_list):
-        """Turn a list of astropy tables into window objects
-
-        This is called when loading data from file.
-
-        Parameters
-        ----------
-        instance_list: list
-            List of BaseWindow instances
-
-        Returns
-        -------
-        windows: dict
-            Dictionary of id -> Window instances
-        """
-        windows = {}
-        for table in table_list:
-            subclass_name = table.meta['SACCCLSS']
-            subclass = cls._window_classes[subclass_name]
-            # Different subclasses can handle this differently.
-            windows.update(subclass.from_table(table))
-        return windows
-
-
-class TopHatWindow(BaseWindow, window_type='TopHat'):
+class TopHatWindow(BaseWindow, type_name='TopHat'):
     """A window function that is constant between two values.
 
     The top-hat is zero elsewhere.
@@ -98,6 +38,7 @@ class TopHatWindow(BaseWindow, window_type='TopHat'):
     max: int/float
         The maximum value where the top-hat function equals 1
     """
+    storage_type = MULTIPLE_OBJECTS_PER_TABLE
     def __init__(self, range_min, range_max):
         """Create a top-hat window
 
@@ -113,8 +54,35 @@ class TopHatWindow(BaseWindow, window_type='TopHat'):
         self.min = range_min
         self.max = range_max
 
+    def __eq__(self, other):
+        """Equality test.
+
+        Two TopHatWindows are equal if they have the same min and max.
+
+        Parameters
+        ----------
+        other: object
+            The other object to test for equality
+        """
+        if not isinstance(other, type(self)):
+            return False
+        return self.min == other.min and self.max == other.max
+
+    def __hash__(self):
+        """Hash function.
+
+        This uses the same attributes as __eq__ to ensure consistent
+        behaviour.
+
+        Returns
+        -------
+        hash: int
+
+        """
+        return hash((self.min, self.max))
+
     @classmethod
-    def to_tables(cls, window_list):
+    def to_table(cls, window_list):
         """Convert a list of Top-Hat windows to a list of astropy tables.
 
         A single table is created for all the windows.
@@ -136,11 +104,7 @@ class TopHatWindow(BaseWindow, window_type='TopHat'):
         mins = [w.min for w in window_list]
         maxs = [w.max for w in window_list]
         ids = [id(w) for w in window_list]
-        t = Table(data=[ids, mins, maxs], names=['id', 'min', 'max'])
-        t.meta['SACCTYPE'] = 'window'
-        t.meta['SACCCLSS'] = cls.window_type
-        t.meta['EXTNAME'] = 'window:' + cls.window_type
-        return [t]
+        return Table(data=[ids, mins, maxs], names=['id', 'min', 'max'])
 
     @classmethod
     def from_table(cls, table):
@@ -160,17 +124,16 @@ class TopHatWindow(BaseWindow, window_type='TopHat'):
         return {row['id']: cls(row['min'], row['max']) for row in table}
 
 
-class LogTopHatWindow(TopHatWindow, window_type='LogTopHat'):
+class LogTopHatWindow(TopHatWindow, type_name='LogTopHat'):
     """A window function that is log-constant between two values.
 
     This object is the same as the TopHat form, except that in between
     the min and max values it is assumed to be constant in the log of the
     argument.  The difference arises when this object is used elsewhere.
     """
-    pass
 
 
-class Window(BaseWindow, window_type='Standard'):
+class Window(BaseWindow, type_name='Standard'):
     """The Window class defines a tabulated window function.
 
     The class contains tabulated values of the abscissa (e.g. ell or theta) and
@@ -187,12 +150,41 @@ class Window(BaseWindow, window_type='Standard'):
         The weights corresponding to each value
 
     """
+    storage_type = ONE_OBJECT_PER_TABLE
+
     def __init__(self, values, weight):
         self.values = np.array(values)
         self.weight = np.array(weight)
 
-    @classmethod
-    def to_tables(cls, window_list):
+    def __eq__(self, other):
+        """Equality test
+
+        Two Windows are equal if they have equivalent values and weights.
+
+        Parameters
+        ----------
+        other: Window
+            The other Window to compare
+
+        """
+        if not isinstance(other, type(self)):
+            return False
+        return np.allclose(self.values, other.values) and np.allclose(self.weight, other.weight)
+
+    def __hash__(self):
+        """Hash function.
+
+        This uses the identity of the object. Caution: this is not
+        ideal, because it means that two windows with equivalent values and
+        weights may not have the same hash.
+
+        Returns
+        -------
+        hash: int
+        """
+        return id(self)
+
+    def to_table(self):
         """Convert a list of windows to a list of astropy tables.
 
         One table is created per window.
@@ -211,17 +203,10 @@ class Window(BaseWindow, window_type='Standard'):
         table: list
             List of astropy.table.Table instances
         """
-        tables = []
-        for w in window_list:
-            cols = [w.values, w.weight]
-            names = ['values', 'weight']
-            t = Table(data=cols, names=names)
-            t.meta['SACCTYPE'] = 'window'
-            t.meta['SACCCLSS'] = cls.window_type
-            t.meta['SACCNAME'] = id(w)
-            t.meta['EXTNAME'] = 'window:' + cls.window_type
-            tables.append(t)
-        return tables
+        cols = [self.values, self.weight]
+        names = ['values', 'weight']
+        t = Table(data=cols, names=names)
+        return t
 
     @classmethod
     def from_table(cls, table):
@@ -238,10 +223,10 @@ class Window(BaseWindow, window_type='Standard'):
         windows: dict
             Dictionary of id -> Window instances
         """
-        return {table.meta['SACCNAME']: cls(table['values'], table['weight'])}
+        return cls(table['values'], table['weight'])
 
 
-class BandpowerWindow(BaseWindow, window_type='Bandpower'):
+class BandpowerWindow(BaseWindow, type_name='Bandpower'):
     """The BandpowerWindow class defines a tabulated for power
     spectrum bandpowers.
 
@@ -258,6 +243,8 @@ class BandpowerWindow(BaseWindow, window_type='Bandpower'):
         weights corresponding to each value.
 
     """
+    storage_type = ONE_OBJECT_PER_TABLE
+
     def __init__(self, values, weight):
         nl, nv = weight.shape
         nell = len(values)
@@ -268,8 +255,42 @@ class BandpowerWindow(BaseWindow, window_type='Bandpower'):
         self.values = np.array(values)
         self.weight = np.array(weight)
 
-    @classmethod
-    def to_tables(cls, window_list):
+    def __eq__(self, other):
+        """Equality test
+
+        Two BandpowerWindows are equal if they have the same values and weights.
+
+        Parameters
+        ----------
+        other: BandpowerWindow
+            The other BandpowerWindow to compare
+
+        Returns
+        -------
+        bool
+            True if the windows are equal, False otherwise
+        """
+        if not isinstance(other, type(self)):
+            return False
+        return self.nell == other.nell and \
+            self.nv == other.nv and \
+            np.allclose(self.values, other.values) and \
+            np.allclose(self.weight, other.weight)
+
+    def __hash__(self):
+        """Hash function.
+
+        This uses the identity of the object. Caution: this is not ideal,
+        because it means that two windows with equivalent values and
+        weights may not have the same hash.
+
+        Returns
+        -------
+        hash: int
+        """
+        return id(self)
+
+    def to_table(self):
         """Convert a list of windows to a list of astropy tables.
 
         One table is created per window.
@@ -288,17 +309,10 @@ class BandpowerWindow(BaseWindow, window_type='Bandpower'):
         table: list
             List of astropy.table.Table instances
         """
-        tables = []
-        for w in window_list:
-            cols = [w.values, w.weight]
-            names = ['values', 'weight']
-            t = Table(data=cols, names=names)
-            t.meta['SACCTYPE'] = 'window'
-            t.meta['SACCCLSS'] = cls.window_type
-            t.meta['SACCNAME'] = id(w)
-            t.meta['EXTNAME'] = 'window:' + cls.window_type
-            tables.append(t)
-        return tables
+        cols = [self.values, self.weight]
+        names = ['values', 'weight']
+        t = Table(data=cols, names=names)
+        return t
 
     @classmethod
     def from_table(cls, table):
@@ -315,7 +329,7 @@ class BandpowerWindow(BaseWindow, window_type='Bandpower'):
         windows: dict
             Dictionary of id -> Window instances
         """
-        return {table.meta['SACCNAME']: cls(table['values'], table['weight'])}
+        return cls(table['values'], table['weight'])
 
     def get_section(self, indices):
         """Get part of this window function corresponding to the input

{sacc-1.0.dist-info → sacc-2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sacc
-Version: 1.0
+Version: 2.0
 Summary: SACC - the LSST/DESC summary statistic data format library
 Author-email: LSST DESC <joezuntz@googlemail.com>
 License: BSD-3-Clause
@@ -10,17 +10,19 @@ Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: scipy
-Requires-Dist: numpy>=1.20
+Requires-Dist: numpy>=2
 Requires-Dist: astropy
 Provides-Extra: all
-Requires-Dist: qp-prob[all]; extra == "all"
+Requires-Dist: qp-prob[all]>=1; extra == "all"
 Requires-Dist: numpydoc; extra == "all"
 Provides-Extra: doc
 Requires-Dist: numpydoc; extra == "doc"
 Provides-Extra: qp
-Requires-Dist: qp-prob[all]; extra == "qp"
+Requires-Dist: qp-prob[all]>=1; extra == "qp"
 Dynamic: license-file
 
+[![codecov](https://codecov.io/github/LSSTDESC/sacc/graph/badge.svg?token=YZf4IXbzA0)](https://codecov.io/github/LSSTDESC/sacc)
+
 Sacc
 ====
 

sacc-2.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+sacc/__init__.py,sha256=pcKSj7s0VizX896xmXFBl350KslJYKb3QZC3bDW5Jxs,516
+sacc/covariance.py,sha256=kXviJMVeoFPVwmOD1obz_yf1zM8QtX41TIqaA-t2gjU,19414
+sacc/data_types.py,sha256=fsp1UXJpsk1rYh4BIdu6Em0zhh6IEArVx7x8uWr4cdw,18261
+sacc/io.py,sha256=MQsXLwyW-AvgRTIpxI68YxwBuTf9N5eRmPjrqY5o1_U,16743
+sacc/sacc.py,sha256=jgksrG3GsTvJqKn-SQmZ2MkdHHBdFU06007cRTt8NM0,59030
+sacc/utils.py,sha256=wRWRanAdyN9IdKVbcZLGIpi0oQgylc7qJsN_Cqmxaj0,5701
+sacc/windows.py,sha256=SdRGom8ejHvDH-UEhTQBI4PpHb8dC_20SU0T3krnAvg,9910
+sacc/tracer_uncertainty/__init__.py,sha256=ZH623ylPtHvBrydCYuZIUmJpebTB_ad32byKA8Xr0Dw,83
+sacc/tracer_uncertainty/base.py,sha256=ecSqs-9CAFejwqPvm4XKF5El79I3KniX32e-TuxMUgw,942
+sacc/tracer_uncertainty/nz.py,sha256=yitocUjN0_8SVisRauHssOPTDwfrxmJo0WyNiQF1HCk,9475
+sacc/tracers/__init__.py,sha256=_HFydXF1lzymJLYwaoL9dEXllMCMapF5J0pQaAFRygc,274
+sacc/tracers/base.py,sha256=2CZnj9fGgFkAffzNh3NuxEdbgMxox-5uJztl9klgR3o,4264
+sacc/tracers/clusters.py,sha256=fRGqKrBE6JqgYesvrgOPtCpQ477Jivuz98z77aaHVSc,11642
+sacc/tracers/maps.py,sha256=Ww6wVPnirMxtEH1WsP0wOQbgkvXftOV6iDUv7evDDVA,7382
+sacc/tracers/misc.py,sha256=IbbvcB_8N2OlKWi_t6JP3fRd_956SQThb1TBXq7zOdc,2785
+sacc/tracers/nz.py,sha256=oHCXnPUSUuVvQJ10Vv0prRst4Vy6X8vjqTWGCqigXlg,8604
+sacc/tracers/survey.py,sha256=1HJRQxnaoraBDmol8_BW32BsNwEiAt5itPNyuRz6KFM,2568
+sacc-2.0.dist-info/licenses/LICENSE,sha256=WMLhPVmrUk6KoMHcLwY1ynIJcA7id_bfU-QSSiCAxtI,1469
+sacc-2.0.dist-info/METADATA,sha256=8FVuN-WubnhaUqq7E0SdMxuqgQ6JGN2QGapTQxZQoMg,2528
+sacc-2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sacc-2.0.dist-info/top_level.txt,sha256=nyd_Bzl4Ly4EGXdgYFa0MHs8CYGAOIGPG1PhQTZsSdM,5
+sacc-2.0.dist-info/RECORD,,

{sacc-1.0.dist-info → sacc-2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any