Comment addition

StingraySoftware · Oct 23, 2024 · 4802257 · 4802257
1 parent 49e36cd
commit 4802257
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/stingray/io.py b/stingray/io.py
@@ -949,6 +949,11 @@ def _initialize_header_events(self, fname, force_hduname=None):
         self._add_meta_attr("hduname", hduname)
 
         header = hdulist[hduname].header
+
+        # self.header has to be a string, for backwards compatibility and... for convenience!
+        # No need to cope with dicts working badly with Netcdf, for example. The header
+        # can be saved back and forth to files and be interpreted through
+        # fits.Header.fromstring(self.header) when needed.
         self._add_meta_attr("header", hdulist[self.hduname].header.tostring())
         self._add_meta_attr("nphot", header["NAXIS2"])