isgri 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

isgri/utils/file_loaders.py

@@ -94,7 +94,7 @@ def default_pif_metadata():
         "SRC_DEC": None,
         "Source_Name": None,
         "cod": None,
-        "No_Modules": 8,
+        "No_Modules": [1] * 8,
     }
 
 

isgri/utils/lightcurve.py

@@ -29,7 +29,7 @@ class LightCurve:
         loc2ijd: Converts local time to IJD time.
     """
 
-    def __init__(self, time, energies, gtis, dety, detz, pif, metadata):
+    def __init__(self, time, energies, gtis, dety, detz, weights, metadata):
         """
         Initialize LightCurve instance.
 
@@ -50,7 +50,7 @@ class LightCurve:
 
         self.dety = dety
         self.detz = detz
-        self.pif = pif
+        self.weights = weights
         self.metadata = metadata
 
     @classmethod
@@ -71,16 +71,16 @@ class LightCurve:
         """
         events, gtis, metadata = load_isgri_events(events_path)
         if pif_path:
-            events, pif, metadata_pif = load_isgri_pif(pif_path, events, pif_threshold, pif_extension)
+            events, weights, metadata_pif = load_isgri_pif(pif_path, events, pif_threshold, pif_extension)
         else:
-            pif = np.ones(len(events))
+            weights = np.ones(len(events))
             metadata_pif = default_pif_metadata()
 
         metadata = merge_metadata(metadata, metadata_pif)
         time = events["TIME"]
         energies = events["ISGRI_ENERGY"]
         dety, detz = events["DETY"], events["DETZ"]
-        return cls(time, energies, gtis, dety, detz, pif, metadata)
+        return cls(time, energies, gtis, dety, detz, weights, metadata)
 
     def rebin(self, binsize, emin, emax, local_time=True, custom_mask=None):
         """
@@ -116,10 +116,10 @@ class LightCurve:
         # Apply filters
         mask = self._create_event_mask(emin, emax, custom_mask)
         time_filtered = time[mask]
-        pif_filtered = self.pif[mask]
+        weights_filtered = self.weights[mask]
 
         # Histogram
-        counts, bin_edges = np.histogram(time_filtered, bins=bins, weights=pif_filtered)
+        counts, bin_edges = np.histogram(time_filtered, bins=bins, weights=weights_filtered)
         time_centers = bin_edges[:-1] + 0.5 * binsize_actual
 
         return time_centers, counts
@@ -208,7 +208,7 @@ class LightCurve:
         time_filtered = time[energy_mask]
         dety_filtered = self.dety[energy_mask]
         detz_filtered = self.detz[energy_mask]
-        pif_filtered = self.pif[energy_mask]
+        weights_filtered = self.weights[energy_mask]
 
         # Compute module indices using digitize
         dety_bin = np.digitize(dety_filtered, DETY_BOUNDS) - 1  # 0 or 1
@@ -218,7 +218,7 @@ class LightCurve:
         counts = []
         for i in range(8):
             mask = module_idx == i
-            counts.append(np.histogram(time_filtered[mask], bins=bins, weights=pif_filtered[mask])[0])
+            counts.append(np.histogram(time_filtered[mask], bins=bins, weights=weights_filtered[mask])[0])
 
         return times, counts
 
@@ -238,7 +238,7 @@ class LightCurve:
             float: The total counts in the specified range.
         """
         time = self.local_time if local_time else self.time
-        return np.sum(self.pif[(time >= t1) & (time < t2) & (self.energies >= emin) & (self.energies < emax)])
+        return np.sum(self.weights[(time >= t1) & (time < t2) & (self.energies >= emin) & (self.energies < emax)])
 
     def ijd2loc(self, ijd_time):
         """

isgri/utils/quality.py

@@ -62,7 +62,7 @@ class QualityMetrics:
         time, counts = self.lightcurve.rebin_by_modules(
             binsize=self.binsize, emin=self.emin, emax=self.emax, local_time=self.local_time
         )
-        module_data = {"time": time, "counts": counts}
+        module_data = {"time": time, "counts": np.asarray(counts)}
         self.module_data = module_data
         return module_data
 
@@ -71,20 +71,36 @@ class QualityMetrics:
         Compute reduced chi-squared for count data.
 
         Args:
-            counts (ndarray): Count array(s) to analyze.
-            return_all (bool, optional): If True, returns chi-squared for each array. If False, returns mean. Defaults to False.
+            counts (ndarray): Count array(s) to analyze. Shape: (n_modules, n_bins) or (n_bins,)
+            return_all (bool, optional): If True, returns detailed results. If False, returns weighted mean. Defaults to False.
 
         Returns:
-            float or ndarray: Reduced chi-squared value(s).
+            If return_all=False:
+                float: Weighted mean chi-squared (weighted by total counts per module)
+            If return_all=True:
+                tuple: (chi_squared, dof, no_counts) where:
+                    - chi_squared: Raw chi-squared values per module
+                    - dof: Degrees of freedom per module (n_bins - 1 excluding NaN)
+                    - no_counts: Total counts per module
         """
         counts = np.asarray(counts)
         counts = np.where(counts == 0, np.nan, counts)
         mean_counts = np.nanmean(counts, axis=-1, keepdims=True)
         chi_squared = np.nansum((counts - mean_counts) ** 2 / mean_counts, axis=-1)
-        dof = counts.shape[-1] - 1
+
+        # DOF = number of non-empty bins minus 1
+        nan_mask = ~np.isnan(counts)
+        dof = np.sum(nan_mask, axis=-1) - 1
+        no_counts = np.nansum(counts, axis=-1)
+
         if return_all:
-            return chi_squared / dof
-        return np.nanmean(chi_squared / dof)
+            return chi_squared, dof, no_counts
+
+        if np.sum(no_counts) == 0 or np.all(dof <= 0):
+            return np.nan
+        
+        # Weight by total counts per module
+        return np.average(chi_squared / dof, weights=no_counts)
 
     def raw_chi_squared(self, counts=None, return_all=False):
         """

{isgri-0.1.0.dist-info → isgri-0.3.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: isgri
-Version: 0.1.0
+Version: 0.3.0
 Summary: Python package for INTEGRAL IBIS/ISGRI lightcurve analysis
 Author: Dominik Patryk Pacholski
 License: MIT
 License-File: LICENSE
 Requires-Python: >=3.10
-Requires-Dist: astropy>=7.2.0
-Requires-Dist: numpy>=2.3.5
+Requires-Dist: astropy
+Requires-Dist: numpy
 Description-Content-Type: text/markdown
 
 # isgri
@@ -22,7 +22,7 @@ pip install isgri
 
 Or from source:
 ```bash
-git clone https://github.com/yourusername/isgri.git
+git clone https://github.com/dominp/isgri.git
 cd isgri
 pip install -e .
 ```
@@ -49,6 +49,8 @@ qm = QualityMetrics(lc, binsize=1.0, emin=30, emax=300)
 chi = qm.raw_chi_squared()
 ```
 
+**About PIF files:** PIF (Pixel Illumination Fraction) files contain per-pixel sensitivity maps generated by OSA task `ii_pif`. They weight events based on source position to improve signal-to-noise ratio. Using PIF files is recommended but optional.
+
 ## Features
 
 - Load ISGRI events and PIF files
@@ -60,5 +62,5 @@ chi = qm.raw_chi_squared()
 
 ## Documentation
 
-- **Tutorial**: See [demo/lightcurve_walkthrough.ipynb](demo/lightcurve_walkthrough.ipynb)
+- **Tutorial**: - **Tutorial**: See [demo notebook](https://github.com/dominp/isgri/blob/main/demo/lightcurve_walkthrough.ipynb) on GitHub
 - **API docs**: All functions have docstrings - use `help(LightCurve)`

isgri-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+isgri/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+isgri/utils/__init__.py,sha256=H83Al7urc6LNW5KUzUBRdtRBUTahiZmkehKFiK90RrU,183
+isgri/utils/file_loaders.py,sha256=HBQ-n-jFhcP1cxykemBFYTZ72ydJNQrZMUQTeZ2dSnw,5509
+isgri/utils/lightcurve.py,sha256=VGRWcpOMnh8Rrbo-EETKAevhYYBZe55IuRQOw_cIfvY,10243
+isgri/utils/pif.py,sha256=oxndfoZp-y9FO_TXcCP3dmesvh-sC7hAy2u_1YwGitw,1317
+isgri/utils/quality.py,sha256=TZGXnao6hQ2STlI8S8JIfaldPAfdMORQJ0IH_rilFu4,7930
+isgri/utils/time_conversion.py,sha256=47aTXn6cvi-LjOptDY2W-rjeF_PjthZer61VIsJqsro,908
+isgri-0.3.0.dist-info/METADATA,sha256=MofiJhRbXTPhMNOQAtOSc4QmsYEIm8ckXayvr2LTIMQ,1767
+isgri-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+isgri-0.3.0.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
+isgri-0.3.0.dist-info/RECORD,,

isgri-0.1.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-isgri/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-isgri/utils/__init__.py,sha256=H83Al7urc6LNW5KUzUBRdtRBUTahiZmkehKFiK90RrU,183
-isgri/utils/file_loaders.py,sha256=c0k7B4Uk1OfNKC_TkHtRbHuEeAu4lHxcbCoYLPuRw5E,5503
-isgri/utils/lightcurve.py,sha256=qhD5NvHnaSWPWaUh0nWXObj93f-ii6TQu92FIL7aznk,10191
-isgri/utils/pif.py,sha256=oxndfoZp-y9FO_TXcCP3dmesvh-sC7hAy2u_1YwGitw,1317
-isgri/utils/quality.py,sha256=vNOkIFOkOTP1FAy_1-t5Xvi38gp6UNgXJN3T-DtM8es,7209
-isgri/utils/time_conversion.py,sha256=47aTXn6cvi-LjOptDY2W-rjeF_PjthZer61VIsJqsro,908
-isgri-0.1.0.dist-info/METADATA,sha256=6rocF7iR95JEZnw51lyDBIIiBd8dp5wMBa8Q7xfJ4kE,1487
-isgri-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-isgri-0.1.0.dist-info/licenses/LICENSE,sha256=Q8oxmHR1cSnEXSHCjY3qeXMtupZI_1ZQZ1MBt4oeANE,1102
-isgri-0.1.0.dist-info/RECORD,,