Add missing, mandatory Beam_group beam_stabilisation and non_quantita…

…tive_processing, as scalars
OSOceanAcoustics · Jul 31, 2023 · 05618e8 · 05618e8
1 parent 13be688
commit 05618e8
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 0 deletions.
diff --git a/echopype/convert/set_groups_azfp.py b/echopype/convert/set_groups_azfp.py
@@ -382,6 +382,24 @@ def set_beam(self) -> List[xr.Dataset]:
                         "valid_min": 0.0,
                     },
                 ),
+                "beam_stabilisation": (
+                    [],
+                    np.array(0, np.byte),
+                    {
+                        "long_name": "Beam stabilisation applied (or not)",
+                        "flag_values": [0, 1],
+                        "flag_meanings": ["not stabilised", "stabilised"],
+                    },
+                ),
+                "non_quantitative_processing": (
+                    [],
+                    np.array(0, np.int16),
+                    {
+                        "long_name": "Presence or not of non-quantitative processing applied to the backscattering data (sonar specific)",  # noqa
+                        "flag_values": [0],
+                        "flag_meanings": ["None"],
+                    },
+                ),
             },
             coords={
                 "channel": (

diff --git a/echopype/convert/set_groups_ek60.py b/echopype/convert/set_groups_ek60.py
@@ -585,6 +585,24 @@ def set_beam(self) -> List[xr.Dataset]:
                     ["channel"],
                     beam_params["gpt_software_version"],
                 ),
+                "beam_stabilisation": (
+                    [],
+                    np.array(0, np.byte),
+                    {
+                        "long_name": "Beam stabilisation applied (or not)",
+                        "flag_values": [0, 1],
+                        "flag_meanings": ["not stabilised", "stabilised"],
+                    },
+                ),
+                "non_quantitative_processing": (
+                    [],
+                    np.array(0, np.int16),
+                    {
+                        "long_name": "Presence or not of non-quantitative processing applied to the backscattering data (sonar specific)",  # noqa
+                        "flag_values": [0],
+                        "flag_meanings": ["None"],
+                    },
+                ),
             },
             coords={
                 "channel": (

diff --git a/echopype/convert/set_groups_ek80.py b/echopype/convert/set_groups_ek80.py
@@ -592,6 +592,24 @@ def _assemble_ds_ping_invariant(self, params, data_type):
                     ["channel"],
                     beam_params["transceiver_software_version"],
                 ),
+                "beam_stabilisation": (
+                    [],
+                    np.array(0, np.byte),
+                    {
+                        "long_name": "Beam stabilisation applied (or not)",
+                        "flag_values": [0, 1],
+                        "flag_meanings": ["not stabilised", "stabilised"],
+                    },
+                ),
+                "non_quantitative_processing": (
+                    [],
+                    np.array(0, np.int16),
+                    {
+                        "long_name": "Presence or not of non-quantitative processing applied to the backscattering data (sonar specific)",  # noqa
+                        "flag_values": [0],
+                        "flag_meanings": ["None"],
+                    },
+                ),
             },
             coords={
                 "channel": (

diff --git a/echopype/utils/coding.py b/echopype/utils/coding.py
@@ -44,6 +44,8 @@
     "beam": np.str_,
     "channel_mode": np.byte,
     "range_sample_offset": np.int32,
+    "beam_stabilisation": np.byte,
+    "non_quantitative_processing": np.int16,
 }  # channel name  # beam name
 
 PREFERRED_CHUNKS = "preferred_chunks"