Merge pull request #929 from yashbhargava1992/add_laxpc_specific_codes

Add AstroSat-LAXPC specific codes

Author: matteobachetti

docs/changes/929.feature.rst

@@ -0,0 +1 @@
+Added functionality to read LAXPC observations. 

stingray/events.py

@@ -862,3 +862,33 @@ def intensity(ev):
         starts, stops, (rate, rate_err) = self.analyze_segments(intensity, segment_size)
 
         return starts, stops, rate, rate_err
+
+    def get_mask_for_filter_by_detector_id(self, value):
+        """Supplies a mask to filter the data for a particular detector(s) for a event file.
+        For example can be used to filter the data for a single unit of LAXPC or a selected NICER detector ID
+
+
+        Args:
+            value: The value for which the mask returns 1
+        """
+        if isinstance(value, int):
+            col = self.detector_id
+            return col == value
+        elif isinstance(value, list) and all(isinstance(i, int) for i in value):
+            col = self.detector_id
+            full_mask = col == value[0]
+            for i in range(1, len(value)):
+                mask = col == value[i]
+                full_mask = full_mask | mask
+            return full_mask
+
+    def filter_detector_id(self, detector_id, inplace=False):
+        """Filters the data selecting only a selected detector or a list of detectors.
+
+        Args:
+            detector_id (int, optional): The detector id on which the filtering needs to be applied. It can be a list.
+        """
+
+        mask = self.get_mask_for_filter_by_detector_id(detector_id)
+        new_ev = self.apply_mask(mask, inplace=inplace)
+        return new_ev

stingray/io.py

@@ -878,7 +878,7 @@ def _transform_slice_into_events(self, data):
                 if col == self.detector_key:
                     continue
                 if col in data.dtype.names:
-                    setattr(new_ts, col.lower(), data[col])
+                    setattr(new_ts, col.replace(".", "_").lower(), data[col])
 
         for attr in self.meta_attrs():
             local_value = getattr(self, attr)

stingray/mission_support/missions.py

@@ -85,6 +85,10 @@ def _patch_mission_info(info, mission=None):
     if mission.lower() == "xte" and "ecol" in info:
         info["ecol"] = "PHA"
         info["ccol"] = "PCUID"
+    if mission.lower() == "astrosat":  # Check if instrument is part of info dict.
+        info["ecol"] = "Energy"
+        info["ccol"] = "LAXPC_No."
+        info["instkey"] = "INSTRUME"
     return info
 
 

stingray/tests/data/laxpc_file_read.fits

@@ -268,6 +268,17 @@ def test_event_file_read(self, fname):
         fname = os.path.join(datadir, fname)
         EventList.read(fname, fmt="hea")
 
+    def test_event_file_read_laxpc(self):
+        """Test LAXPC file reading"""
+        fname = os.path.join(datadir, "laxpc_file_read.fits")
+        with pytest.warns(UserWarning, match="HDU EVENTS"):
+            with pytest.warns(UserWarning, match="No valid GTI"):
+                ev = EventList.read(fname, fmt="hea")
+        assert ev.instr.lower() == "laxpc3"
+        assert ev.mission.lower() == "astrosat"
+        assert ((ev.filter_detector_id(detector_id=1)).main_array_length) == 453
+        assert ((ev.filter_detector_id(detector_id=[1])).main_array_length) == 453
+
     def test_fits_with_additional(self):
         """Test that fits works with a standard event list
         file.

stingray/tests/test_events.py

@@ -140,6 +140,14 @@ def test_event_file_read_chandra_noE(self):
         assert hasattr(data, "energy_list")
         assert data.energy_list.max() < 18
 
+    def test_event_file_read_laxpc(self):
+        """Test event file reading."""
+        fname = os.path.join(datadir, "laxpc_file_read.fits")
+        with pytest.warns(UserWarning, match="No valid GTI*"):
+            data = load_events_and_gtis(fname, additional_columns=["Layer"], hduname="event file")
+        assert data.mission.lower() == "astrosat"
+        assert read_header_key(fname, "INSTRUME", hdu=0) == "LAXPC3"
+
     def test_event_file_read_no_mission(self):
         """Test event file reading."""
         fname = os.path.join(datadir, "nomission.evt")