Merge pull request #183 from StingraySoftware/fix_input_ogip

Warn about missing imageio; save best detection info

Author: matteobachetti

hendrics/efsearch.py

@@ -25,7 +25,7 @@
 
 from astropy import log
 from astropy.logger import AstropyUserWarning
-from astropy.table import Table
+from astropy.table import Table, vstack
 from astropy.utils.introspection import minversion
 
 from .base import (
@@ -630,10 +630,16 @@ def plot_transient_search(results, gif_name=None):
     import matplotlib as mpl
     import matplotlib.pyplot as plt
 
+    if not HAS_IMAGEIO:
+        warnings.warn("imageio needed to save the transient search results into a gif image.")
+        return []
+
     mpl.use("Agg")
     if gif_name is None:
         gif_name = "transients.gif"
 
+    result_name = gif_name.replace(".gif", ".csv")
+    max_stats_rows = []
     all_images = []
     for i, (ima, nave) in enumerate(zip(results.stats, results.nave)):
         f = results.freqs
@@ -692,7 +698,6 @@ def plot_transient_search(results, gif_name=None):
                 )
             elif maxline >= 5 and i_f == 0:  # pragma: no cover
                 print(f"{gif_name}: Candidate at step {i}: {best_f} Hz (~{maxline:.1f} sigma)")
-
             axf.plot(f, mean_line, lw=1, c="k", zorder=10, label="mean", ls="-")
 
             axima.set_xlabel("Frequency")
@@ -703,6 +708,9 @@ def plot_transient_search(results, gif_name=None):
             xmin = max(best_f - df, results.f0)
             xmax = min(best_f + df, results.f1)
             if i_f == 0:
+                max_stats_rows.append(
+                    {"step": i + 1, "nave": nave, "best_f": best_f, "max_stat": maxline}
+                )
                 axf.set_xlim([results.f0, results.f1])
                 axf.axvline(xmin, ls="--", c="b", lw=2)
                 axf.axvline(xmax, ls="--", c="b", lw=2)
@@ -715,11 +723,9 @@ def plot_transient_search(results, gif_name=None):
 
         plt.close(fig)
         all_images.append(image)
+    vstack(max_stats_rows).write(result_name, overwrite=True)
 
-    if HAS_IMAGEIO:
-        imageio.v3.imwrite(gif_name, all_images, duration=1000.0)
-    else:
-        warnings.warn("imageio needed to save the transient search results " "into a gif image.")
+    imageio.v3.imwrite(gif_name, all_images, duration=1000.0)
 
     return all_images
 
@@ -1722,7 +1728,8 @@ def _common_main(args, func):
                 oversample=oversample,
             )
             plot_transient_search(results, out_fname + "_transient.gif")
-            continue
+            if not args.fast and not args.ffa:
+                continue
 
         if not args.fast and not args.ffa:
             fdotmin = args.fdotmin if args.fdotmin is not None else 0
@@ -1782,6 +1789,7 @@ def _common_main(args, func):
         M = length // segment_size
 
         fdots = 0
+
         if len(results) == 4:
             frequencies, stats, step, length = results
         elif len(results) == 6: