Add hard stop for byte-by-byte search, add test file for sentinel v

Author: jmcvey3

examples/data/dolfyn/sentinelv_b5.pd0

@@ -21,6 +21,7 @@ def read_rdi(
     debug_level=-1,
     vmdas_search=False,
     winriver=False,
+    search_num=20000,
     **kwargs,
 ) -> xr.Dataset:
     """
@@ -65,7 +66,11 @@ def read_rdi(
     # Reads into a dictionary of dictionaries using netcdf naming conventions
     # Should be easier to debug
     rdr = _RDIReader(
-        filename, debug_level=debug_level, vmdas_search=vmdas_search, winriver=winriver
+        filename,
+        debug_level=debug_level,
+        vmdas_search=vmdas_search,
+        winriver=winriver,
+        search_num=search_num,
     )
     datNB, datBB = rdr.load_data(nens=nens)
 
@@ -159,9 +164,7 @@ def _set_rdi_declination(dat, fname, inplace):
 
 
 class _RDIReader:
-    def __init__(
-        self, fname, navg=1, debug_level=-1, vmdas_search=False, winriver=False
-    ):
+    def __init__(self, fname, debug_level, vmdas_search, winriver, search_num):
         self.fname = base._abspath(fname)
         print("\nReading file {} ...".format(fname))
         self._debug_level = debug_level
@@ -170,6 +173,7 @@ def __init__(
         self._vm_source = 0
         self._pos = 0
         self.progress = 0
+        self.search_num = search_num
         self._cfac32 = np.float32(180 / 2**31)  # signed 32 to float
         self._cfac16 = np.float32(180 / 2**15)  # unsigned16 to float
         self._fixoffset = 0
@@ -194,7 +198,7 @@ def __init__(
             logging.info("self._BB {}".format(self._BB))
             logging.info("self.cfgBB: {}".format(self.cfgBB))
         self.f.seek(self._pos, 0)
-        self.n_avg = navg
+        self.n_avg = 1
 
         self.ensemble = lib._ensemble(self.n_avg, self.cfg["n_cells"])
         if self._BB:
@@ -500,7 +504,7 @@ def search_buffer(self):
         """
         Check to see if the next bytes indicate the beginning of a
         data block.  If not, search for the next data block, up to
-        _search_num times.
+        search_num times.
         """
         fd = self.f
         id = fd.read_ui8(2)
@@ -515,8 +519,11 @@ def search_buffer(self):
             logging.info("cfgid0: [{:x}, {:x}]".format(*cfgid))
         # If not [127, 127] or if the file ends in the next ensemble
         while (cfgid != [127, 127]) or self.check_eof():
+            if search_cnt == self.search_num:
+                logging.debug(f"Stopped searching at byte position {fd.tell()}")
+                return False
+            # Search for the next header or the end of the file
             if cfgid == [127, 121]:
-                # Search for the next header or the end of the file
                 skipbytes = fd.read_i16(1)
                 fd.seek(skipbytes - 2, 1)
                 id = fd.read_ui8(2)

examples/data/dolfyn/test_data/sentinelv_b5.nc

@@ -1068,7 +1068,7 @@ def read_sentinelv_ping_setup(rdr, bb=False):
     clock[1] += century
     cfg["deployment_start"] = tmlib.date2str(
         tmlib.datetime(*clock[1:7], microsecond=int(float(clock[7]) * 10000))
-    )
+    )[0]
     if rdr._debug_level > -1:
         logging.info("Read Sentinel V Ping Setup")
     rdr._nbyte = 2 + 42

mhkit/dolfyn/io/rdi.py

@@ -22,6 +22,7 @@
 dat_wr2 = load("winriver02.nc")
 dat_rp = load("RiverPro_test01.nc")
 dat_transect = load("winriver02_transect.nc")
+dat_senb5 = load("sentinelv_b5.nc")
 
 dat_awac = load("AWAC_test01.nc")
 dat_awac_ud = load("AWAC_test01_ud.nc")
@@ -52,6 +53,7 @@ def test_io_rdi(self):
         td_wr2 = read("winriver02.PD0")
         td_rp = read("RiverPro_test01.PD0")
         td_transect = read("winriver02_transect.PD0", nens=nens)
+        td_senb5 = read("sentinelv_b5.pd0")
 
         if make_data:
             save(td_rdi, "RDI_test01.nc")
@@ -64,6 +66,7 @@ def test_io_rdi(self):
             save(td_wr2, "winriver02.nc")
             save(td_rp, "RiverPro_test01.nc")
             save(td_transect, "winriver02_transect.nc")
+            save(td_senb5, "sentinelv_b5.nc")
             return
 
         assert_allclose(td_rdi, dat_rdi, atol=1e-6)
@@ -76,6 +79,7 @@ def test_io_rdi(self):
         assert_allclose(td_wr2, dat_wr2, atol=1e-6)
         assert_allclose(td_rp, dat_rp, atol=1e-6)
         assert_allclose(td_transect, dat_transect, atol=1e-6)
+        assert_allclose(td_senb5, dat_senb5, atol=1e-6)
 
     def test_io_nortek(self):
         nens = 100