Added OrbitResponseMatrixData

Author: JeanLucPons

pyaml/tuning_tools/orbit.py

@@ -20,7 +20,7 @@
 from ..common.exception import PyAMLException
 from ..external.pySC_interface import pySCInterface
 from ..rf.rf_plant import RFPlant
-from .response_matrix_data import ResponseMatrixData
+from .orbit_response_matrix_data import OrbitResponseMatrixData
 
 logger = logging.getLogger(__name__)
 logging.getLogger("pyaml.external.pySC").setLevel(logging.WARNING)
@@ -39,7 +39,7 @@ class ConfigModel(ElementConfigModel):
     singular_values_H: Optional[int] = None
     singular_values_V: Optional[int] = None
     virtual_target: float = 0
-    response_matrix: Union[str, ResponseMatrixData]
+    response_matrix: Union[str, OrbitResponseMatrixData]
 
 
 class Orbit(Element):
@@ -73,7 +73,7 @@ def __init__(self, cfg: ConfigModel):
         # If the configuration response matrix is a filename, load it
         if type(cfg.response_matrix) is str:
             try:
-                cfg.response_matrix = ResponseMatrixData.load(cfg.response_matrix)
+                cfg.response_matrix = OrbitResponseMatrixData.load(cfg.response_matrix)
             except Exception as e:
                 logger.warning(f"{str(e)}")
                 cfg.response_matrix = None
@@ -90,7 +90,7 @@ def __init__(self, cfg: ConfigModel):
         self._rf_plant: RFPlant = None
 
     @property
-    def reponse_matrix(self) -> ResponseMatrixData | None:
+    def reponse_matrix(self) -> OrbitResponseMatrixData | None:
         return self._cfg.response_matrix
 
     def correct(

pyaml/tuning_tools/orbit_response_matrix_data.py

@@ -0,0 +1,34 @@
+from typing import Optional
+
+from .response_matrix_data import ConfigModel as ReponseMatrixDataConfigModel
+from .response_matrix_data import ResponseMatrixData
+
+PYAMLCLASS = "OrbitResponseMatrixData"
+
+
+class ConfigModel(ReponseMatrixDataConfigModel):
+    """
+    Base configuration model for response matrix
+
+    Parameters
+    ----------
+    rf_response : list[float], optional
+        RF response data
+    input_names : list[str], optional
+        Input plane names, basically the plane of the actuators
+    output_names : list[str], optional
+        Output plane names, basically the plane of measurements
+    """
+
+    rf_response: Optional[list[float]] = None
+    input_planes: Optional[list[str]] = None
+    output_planes: Optional[list[str]] = None
+
+
+class OrbitResponseMatrixData(ResponseMatrixData):
+    """
+    Orbit response matrix loader
+    """
+
+    def __init__(self, cfg: ConfigModel):
+        self._cfg = cfg

pyaml/tuning_tools/response_matrix_data.py

@@ -24,18 +24,13 @@ class ConfigModel(BaseModel):
         Input names, basically the actuators
     output_names : list[str]
         Output names, basically the measurements
-    rf_response : list[float], optional
-        RF response data
     """
 
     model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
 
     matrix: list[list[float]]
     input_names: Optional[list[str]]
     output_names: list[str]
-    rf_response: Optional[list[float]] = None
-    input_planes: Optional[list[str]] = None
-    output_planes: Optional[list[str]] = None
 
 
 class ResponseMatrixData(object):