SHORT_SET: adds option to return general metadata from processing attempt

Author: Ryan Kingsbury

peregrine/short_set.py

@@ -550,7 +550,7 @@ def compute_dops(prns, ephem, r, t, disp=False):
             "gdop":gdop}
 
 def postprocess_short_samples(signal, prior_trajectory, t_prior, settings,
-                              plot = True, return_dops = False):
+                              plot = True, return_metadata = False):
     """
     Postprocess a short baseband sample record into a navigation solution.
 
@@ -569,14 +569,19 @@ def postprocess_short_samples(signal, prior_trajectory, t_prior, settings,
       e.g. from peregrine.initSettings.initSettings()
     plot : bool
       Make pretty graphs.
+    return_metadata : bool
+      Return dict of metadata from the solver
 
     Returns
     -------
     acq_results : [:class:`AcquisitionResult`]
       List of :class:`AcquisitionResult` objects loaded from the file.
-
+    sol_metadata
+      Dict of metadata from the solver (optional)
     """
 
+    metadata = {}
+
     if hasattr(prior_trajectory, '__call__'):
         prior_traj_func = True
         prior_traj = prior_trajectory
@@ -633,6 +638,8 @@ def postprocess_short_samples(signal, prior_trajectory, t_prior, settings,
                 cPickle.dump((acqed_prns, obs_cp, obs_dopp), f,
                              protocol=cPickle.HIGHEST_PROTOCOL)
 
+    metadata['acqed_prns'] = len(acqed_prns)
+
     # Check whether we have enough satellites
     if len(acqed_prns) < 5:
         logger.error(("Acquired %d SVs; need at least 5 for a solution" +
@@ -688,15 +695,17 @@ def postprocess_short_samples(signal, prior_trajectory, t_prior, settings,
     v_sol, rx_freq_err = vel_solve(r_sol, t_sol, ephem, obs_dopp, los, tot)
     print "Velocity: %s (%.1f m/s)" % (v_sol, norm(v_sol))
 
+    metadata['rx_freq_err'] = rx_freq_err
+
     # Compute DOPs
-    dops = compute_dops(acqed_prns, ephem, r_sol, t_sol, disp=True)
+    metadata["dops"] = compute_dops(acqed_prns, ephem, r_sol, t_sol, disp=True)
 
     # How accurate is the time component of the solution?
     if plot:
         plot_t_recv_sensitivity(r_sol, t_sol, obs_pr, ephem,
                                 spread = 0.1, step = 0.01)
 
-    if return_dops:
-        return r_sol, v_sol, t_sol, dops
+    if return_metadata:
+        return r_sol, v_sol, t_sol, metadata
     else:
         return r_sol, v_sol, t_sol