[TASK] added orbit object

Author: hzb-ps

src/dt4acc/custom_epics/ioc/pv_setup.py

@@ -46,11 +46,14 @@ def initialize_magnet_pvs(builder, magnet):
         on_update=lambda val: handle_device_update(magnet_name, "K", val),
     )
     rdbk = builder.aIn(f"{magnet_name}:Cm:rdbk", initial_value=val)
+
     async def handle_magnet_update(device_id: str, property_id: str, value: float):
-        r = await handle_device_update(device_id=device_id, property_id=property_id, value=value)
+        r = await handle_device_update(
+            device_id=device_id, property_id=property_id, value=value
+        )
         logger.info("%s:%s setting setpoint val=%s", device_id, property_id, value)
         rdbk.set(value)
-        logger.info("%s:%s set readback  val=%s", device_id, property_id,value)
+        logger.info("%s:%s set readback  val=%s", device_id, property_id, value)
         return r
 
     builder.aOut(
@@ -111,9 +114,12 @@ def add_pc_pvs(builder, pc_name, prefix):
     )
     start_val = np.asarray(vals).mean()
     rdbk = builder.aOut(f"{pc_name}:rdbk", initial_value=start_val)
+
     async def handle_pc_update(device_id: str, property_id: str, value: float):
         logger.debug("%s:%s updating setpoint val=%s", device_id, property_id, value)
-        r = await handle_device_update(device_id=device_id, property_id=property_id, value=value)
+        r = await handle_device_update(
+            device_id=device_id, property_id=property_id, value=value
+        )
         logger.debug("%s:%s updating rdbk val=%s", device_id, property_id, value)
         rdbk.set(value)
         return r
@@ -218,6 +224,18 @@ def initialize_bpm_pvs(builder):
     builder.longOut(f"{special_pvs['bpm_pv']}:count", initial_value=0)
 
 
+def initialize_orbit_object_pvs(builder):
+    n_bpms = 128
+    tmp = np.ravel(np.empty([n_bpms, 2], float))
+    tmp.fill(np.nan)
+    builder.WaveformOut("ORBITCC:rdPos", initial_value=tmp, length=len(tmp))
+    tmp = np.ravel(np.empty([n_bpms, 4], float))
+    tmp.fill(np.nan)
+    builder.WaveformOut("ORBITCC:rdButtons", initial_value=tmp, length=len(tmp))
+    builder.WaveformOut("ORBITCC:rdBpmNames", initial_value=[""], length=n_bpms)
+    builder.longOut("ORBITCC:count", initial_value=0)
+
+
 def initialize_cavity_pvs(builder):
     """
     Initializes PVs for RF cavities.

src/dt4acc/custom_epics/ioc/server.py

@@ -10,6 +10,7 @@
     initialize_master_clock_pvs,
     initialize_orbit_pvs,
     initialize_bpm_pvs,
+    initialize_orbit_object_pvs,
     initialize_twiss_pvs,
     initialize_other_pvs,
 )
@@ -35,6 +36,7 @@ def startup():
     initialize_power_converter_pvs(builder, prefix)  # Initialize power converters and linked magnets
     initialize_orbit_pvs(builder)  # Initialize orbit-related PVs
     initialize_bpm_pvs(builder)  # Initialize Beam Position Monitor PVs
+    initialize_orbit_object_pvs(builder)  # Initialize PV's of the new orbit object ... collection of bpms
     initialize_twiss_pvs(builder)  # Initialize Twiss parameter PVs
 
     # Load the database of PVs defined above into the SoftIOC server

src/dt4acc/custom_epics/utils/bpm_mimicry.py

@@ -66,9 +66,8 @@ def extract_bpm_data(self, orbit_result: Orbit):
             for name in self.bpm_names
         ])
 
-    def extract_bpm_legacy_data(self, orbit_result: Orbit):
-        """
-        Publish BPM data to EPICS.
+    def extract_bpm_legacy_data_to_df(self, orbit_result: Orbit) -> pd.DataFrame:
+        """Publish BPM data to EPICS.
 
         Args:
             orbit_result (OrbitResult): Result of the orbit calculation.
@@ -89,7 +88,7 @@ def extract_bpm_legacy_data(self, orbit_result: Orbit):
         bpm_names_as_index = pd.Series([f"empty_{cnt:03d}" for cnt in np.arange(128)])
         bpm_names_as_index.iloc[bpm_config["idx"]] = bpm_config["name"]
         df_bpm = pd.DataFrame(columns=["x", "y", "intensity_z", "intensity_s", "status", "x_rms", "y_rms"],
-                              index=bpm_names_as_index)
+                              index=bpm_names_as_index, dtype=float)
 
         # Waring: order is lost!!!
         known_bpm_names = list(set(bpm_config["name"]).intersection(orbit_result.names))
@@ -98,7 +97,7 @@ def extract_bpm_legacy_data(self, orbit_result: Orbit):
         assert df_bpm.shape[0] == 128
 
         # default values
-        fill_value = 2 ** 15 - 1
+        fill_value = np.nan
         df_bpm.loc[:, "x"] = fill_value
         df_bpm.loc[:, "y"] = fill_value
         df_bpm.loc[:, "y_rms"] = 0
@@ -118,8 +117,10 @@ def extract_bpm_legacy_data(self, orbit_result: Orbit):
         # needs to be at least a bit in 16 ...
         df_bpm.loc[known_bpm_names, "x_rms"] = 1
         df_bpm.loc[known_bpm_names, "y_rms"] = 1
+        return df_bpm
 
-        tmp = np.empty([len(df_bpm), 8], dtype=np.int16)
+    def bpm_legacy_data_df_to_array(self, bpm_data: pd.DataFrame) -> np.ndarray[np.int16]:
+        tmp = np.empty([len(bpm_data), 8], dtype=np.int16)
         tmp.fill(0)
         mm2cnts = 2 ** 15 / 10
 
@@ -128,19 +129,24 @@ def convert(vec):
             """
             Todo: add test for maximum acceptable range
             """
-            r = np.clip(-2 ** 15 + 1, 2 ** 15 - 1, vec * mm2cnts)
+            # mark invalid data
+            tmp = vec.copy()
+            tmp[np.isnan(vec)] = 2 ** 15 - 1
+            r = np.clip(-2 ** 15 + 1, 2 ** 15 - 1, tmp * mm2cnts)
             return r.astype(np.int16)
 
-        tmp[:, 0] = convert(df_bpm.x)
-        tmp[:, 1] = convert(df_bpm.y)
-        tmp[:, 4] = df_bpm.status
-        tmp[:, 6] = convert(df_bpm.x_rms)
-        tmp[:, 7] = convert(df_bpm.y_rms)
+        tmp[:, 0] = convert(bpm_data.x.values)
+        tmp[:, 1] = convert(bpm_data.y.values)
+        tmp[:, 4] = bpm_data.status
+        tmp[:, 6] = convert(bpm_data.x_rms.values)
+        tmp[:, 7] = convert(bpm_data.y_rms.values)
         bpm_legacy_data_vector = np.zeros([2048], np.int16)
         bpm_legacy_data_vector[:1024] = tmp.transpose().ravel()
 
         return bpm_legacy_data_vector
 
+    def extract_bpm_legacy_data(self, orbit_result: Orbit):
+        raise NotImplementedError("why still needed?")
 
 @functools.lru_cache(maxsize=1)
 def create_bpm_config():

src/dt4acc/custom_epics/views/calculation_result_view.py

@@ -2,6 +2,7 @@
 from typing import Sequence
 
 import numpy as np
+import pandas as pd
 from p4p.client.asyncio import Context
 
 from ...core.model.element_upate import ElementUpdate
@@ -100,12 +101,28 @@ async def push_bpms(self, orbit_data):
             raise ValueError("BPM Mimicry not set in ResultView")
         try:
             logger.warning(f"pushing legacy bpm data")
-            bpm_legacy_data = self.bpm_mimicry.extract_bpm_legacy_data(orbit_data)
+            df_bpm = self.bpm_mimicry.extract_bpm_legacy_data_to_df(orbit_data)
+            bpm_legacy_data = self.bpm_mimicry.bpm_legacy_data_df_to_array(df_bpm)
             self.default_bpm_legacy_data = bpm_legacy_data
             await self.push_legacy_bpm_data(bpm_legacy_data)
+            df_for_orbit = df_bpm.copy()
+            mm2nm = 1e6
+            df_for_orbit.x = df_bpm.x * mm2nm
+            df_for_orbit.y = df_bpm.y * mm2nm
+            await self.push_orbit_object(df_for_orbit)
         except Exception as e:
             logger.error(f"Error processing orbit data: {e}")
 
+    async def push_orbit_object(self, bpm_data: pd.DataFrame):
+        try:
+            prefix = f"{self.prefix}:ORBITCC"
+            # Todo: check that the dimensions are properly made
+            pos = np.array(bpm_data.loc[:, ["x", "y"]]).ravel()
+            await ctx.put(f"{prefix}:rdPos", pos)
+            await ctx.put(f"{prefix}:rdBpmNames", [str(val) for val in bpm_data.index])
+        except Exception as e:
+            logger.error(f"Error processing orbit object data: {e}")
+
     async def push_legacy_bpm_data(self, bpm_legacy_data: Sequence[np.int16] = None):
         """
         Push BPM data to EPICS. If no data is provided, push the default data.