Add solve time to the guider solution metadata and output files

Author: albireox

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 * Back to using the official `sep` package from `sep-developers/sep` now that it's maintained again.
 * Apply rotation and translation corrections independently, starting with rotation until the rotator has converged. The first correction, however, applies both rotation and translation at once to minimize the number of telescope offsets.
+* Add solve time to the guider solution metadata and output files.
 
 
 ## 0.7.0 - February 27, 2025

src/lvmguider/dataclasses.py

@@ -114,6 +114,7 @@ class CameraSolution(BaseSolution):
     ref_frame: pathlib.Path | None = None
     wcs_mode: WCS_MODE_T = "none"
     guider_version: Version = Version("0.0.0")
+    solve_time: float | None = None
     hdul: fits.HDUList | None = None
 
     @classmethod
@@ -149,6 +150,7 @@ def open(cls, file: str | pathlib.Path):
         with warnings.catch_warnings():
             warnings.simplefilter("ignore", category=FITSFixedWarning)
             solved = proc["SOLVED"]
+            solve_time = proc.get("SOLVET", None)
             wcs_mode = proc["WCSMODE"].lower()
             wcs = WCS(proc) if solved and wcs_mode != "none" else None
 
@@ -172,6 +174,7 @@ def open(cls, file: str | pathlib.Path):
             matched=len(sources.ra.dropna()) > 0 if sources is not None else False,
             ref_frame=ref_frame,
             guider_version=guiderv,
+            solve_time=solve_time,
             hdul=hdul,
         )
 
@@ -386,6 +389,15 @@ def open(cls, file: str | pathlib.Path, dirname: str | pathlib.Path | None = Non
             guider_version=guiderv,
         )
 
+    @property
+    def solve_time(self):
+        """Returns the total time required to solve all cameras.."""
+
+        if all(cs.solve_time is None for cs in self.solutions):
+            return None
+
+        return max([cs.solve_time or 0.0 for cs in self.solutions])
+
 
 @dataclass(kw_only=True)
 class FrameData:
@@ -597,6 +609,7 @@ def guider_data(self):
                 pa=numpy.float32(pa),
                 zero_point=numpy.float32(gs.zero_point),
                 solved=bool(gs.solved),
+                solve_time=numpy.float32(gs.solve_time),
                 n_cameras_solved=int(gs.n_cameras_solved),
                 guide_mode=gs.guide_mode,
                 x_ff_pixel=numpy.float32(gs.guide_pixel[0]),

src/lvmguider/etc/datamodel.yml

@@ -90,6 +90,7 @@ GUIDERDATA_HEADER:
   DIRNAME: [null, 'Original file directory']
   SOURCESF: [null, 'Sources file']
   SOLVED: [False, 'Astrometric solution found?']
+  SOLVET: [null, '[s] Time needed to solve the frame']
   NCAMSOL: [0, 'Number of cameras combined for the WCS']
   XFFPIX: [null, 'The x pixel of the full frame']
   ZFFPIX: [null, 'The z pixel of the full frame']
@@ -146,6 +147,7 @@ GUIDERDATA_FRAME:
   mjd: 'int32[pyarrow]'
   date_obs: 'string[pyarrow]'
   solved: 'bool[pyarrow]'
+  solve_time: 'f4[pyarrow]'
   n_cameras_solved: 'int8[pyarrow]'
   guide_mode: 'string[pyarrow]'
   fwhm: 'f4[pyarrow]'

src/lvmguider/guider.py

@@ -10,6 +10,7 @@
 
 import asyncio
 import pathlib
+import time
 
 from typing import TYPE_CHECKING
 
@@ -383,6 +384,8 @@ async def solve_camera(
     ):
         """Astrometrically solves a single camera using astrometry.net or k-d tree."""
 
+        t0 = time.time()
+
         file = pathlib.Path(file)
         frameno = get_frameno(file)
         hdul = fits.open(str(file))
@@ -491,6 +494,8 @@ async def solve_camera(
         zp = estimate_zeropoint(data, sources)
         sources.update(zp)
 
+        solve_time = round(time.time() - t0, 3)
+
         camera_solution = CameraSolution(
             frameno=frameno,
             camera=camname,
@@ -501,6 +506,7 @@ async def solve_camera(
             matched=matched,
             ref_frame=ref_frame if wcs is not None else None,
             telescope=self.telescope,
+            solve_time=solve_time,
         )
 
         if camera_solution.solved is False:
@@ -730,7 +736,8 @@ async def update_fits(self, guider_solution: GuiderSolution):
         gheader["PAFIELD"] = numpy.round(self.field_centre[2], 4)
         gheader["XFFPIX"] = guider_solution.guide_pixel[0]
         gheader["ZFFPIX"] = guider_solution.guide_pixel[1]
-        gheader["SOLVED"] = guider_solution.solved
+        gheader["SOLVED"] = nan_or_none(guider_solution.solved, 3)
+        gheader["SOLVET"] = guider_solution.solve_time
         gheader["NCAMSOL"] = guider_solution.n_cameras_solved
         gheader["RAMEAS"] = nan_or_none(guider_solution.pointing[0], 6)
         gheader["DECMEAS"] = nan_or_none(guider_solution.pointing[1], 6)