gammasimtools 0.6.1__py3-none-any.whl → 0.8.2__py3-none-any.whl

simtools/model/mirrors.py

@@ -1,13 +1,17 @@
+"""Definition and modeling of mirror panels."""
+
 import logging
+from pathlib import Path
 
+import astropy.io.ascii
 import astropy.units as u
 import numpy as np
 from astropy.table import Table
 
-__all__ = ["InvalidMirrorListFile", "Mirrors"]
+__all__ = ["InvalidMirrorListFileError", "Mirrors"]
 
 
-class InvalidMirrorListFile(Exception):
+class InvalidMirrorListFileError(Exception):
     """Exception for invalid mirror list file."""
 
 
@@ -17,14 +21,14 @@ class Mirrors:
 
     Parameters
     ----------
-    mirror_list_file: str
-        mirror list in sim_telarray or ecsv format (with panel focal length only).
+    mirror_list_file: Union[str, Path]
+        Mirror list in sim_telarray or ecsv format (with panel focal length only).
+    parameters: dict, optional
+        Dictionary of parameters from the database.
     """
 
-    def __init__(self, mirror_list_file, parameters=None):
-        """
-        Initialize Mirrors.
-        """
+    def __init__(self, mirror_list_file: str | Path, parameters: dict | None = None):
+        """Initialize Mirrors."""
         self._logger = logging.getLogger(__name__)
         self._logger.debug("Mirrors Init")
 
@@ -39,10 +43,10 @@ class Mirrors:
 
     def _read_mirror_list(self):
         """
-        Read the mirror lists from disk and store the data. Allow reading of mirror lists in \
-        sim_telarray and ecsv format
-        """
+        Read the mirror lists from disk and store the data.
 
+        Allow reading of mirror lists in sim_telarray and ecsv format.
+        """
         if str(self._mirror_list_file).find("ecsv") > 0:
             self._read_mirror_list_from_ecsv()
         else:
@@ -54,13 +58,11 @@ class Mirrors:
 
         Raises
         ------
-        InvalidMirrorListFile
+        InvalidMirrorListFileError
             If number of mirrors is 0.
         """
-        # Getting mirror parameters from mirror list.
-
-        self.mirror_table = Table.read(self._mirror_list_file, format="ascii.ecsv")
         self._logger.debug(f"Reading mirror properties from {self._mirror_list_file}")
+        self.mirror_table = Table.read(self._mirror_list_file, format="ascii.ecsv")
 
         self.number_of_mirrors = np.shape(self.mirror_table)[0]
         self._logger.debug(f"Number of Mirrors = {self.number_of_mirrors}")
@@ -68,7 +70,7 @@ class Mirrors:
         if self.number_of_mirrors == 0:
             msg = "Problem reading mirror list file"
             self._logger.error(msg)
-            raise InvalidMirrorListFile
+            raise InvalidMirrorListFileError
 
         try:
             self.mirror_diameter = u.Quantity(self.mirror_table["mirror_diameter"])[0]
@@ -77,8 +79,8 @@ class Mirrors:
             self._logger.debug("Mirror mirror_panel_diameter not in mirror file")
             try:
                 self.mirror_diameter = u.Quantity(
-                    self.parameters["mirror_panel_diameter"]["Value"],
-                    self.parameters["mirror_panel_diameter"]["units"],
+                    self.parameters["mirror_panel_diameter"]["value"],
+                    self.parameters["mirror_panel_diameter"]["unit"],
                 )
                 self._logger.debug("Take mirror_panel_diameter from parameters")
             except TypeError as error:
@@ -95,8 +97,8 @@ class Mirrors:
                 try:
                     self.mirror_table["focal_length"] = self.number_of_mirrors * [
                         u.Quantity(
-                            self.parameters["mirror_focal_length"]["Value"],
-                            self.parameters["mirror_focal_length"]["units"],
+                            self.parameters["mirror_focal_length"]["value"],
+                            self.parameters["mirror_focal_length"]["unit"],
                         )
                     ]
                     self._logger.debug("Take mirror_focal_length from parameters")
@@ -111,7 +113,7 @@ class Mirrors:
         except KeyError:
             self._logger.debug("Mirror shape_type not in mirror file")
             try:
-                self.shape_type = self.parameters["mirror_panel_shape"]["Value"]
+                self.shape_type = self.parameters["mirror_panel_shape"]["value"]
                 self._logger.debug("Take shape_type from parameters")
             except TypeError as error:
                 msg = "Mirror shape_type not contained in DB"
@@ -122,33 +124,52 @@ class Mirrors:
         """
         Read the mirror list in sim_telarray format and store the data.
 
+        Allow to read mirror lists with different number of columns.
+
         Raises
         ------
-        InvalidMirrorListFile
+        InvalidMirrorListFileError
             If number of mirrors is 0.
         """
+        self._logger.debug(f"Reading mirror properties from {self._mirror_list_file}")
 
-        self.mirror_table = Table.read(
-            self._mirror_list_file,
-            format="ascii.no_header",
-            names=[
-                "mirror_x",
-                "mirror_y",
-                "mirror_diameter",
-                "focal_length",
-                "shape_type",
-                "mirror_z",
-                "sep",
-                "mirror_panel_id",
-            ],
-            units=["cm", "cm", "cm", "cm", None, "cm", None, None],
-        )
-        self.mirror_table["mirror_panel_id"] = np.array(
-            [
-                int("".join(filter(str.isdigit, string)))
-                for string in self.mirror_table["mirror_panel_id"]
-            ]
-        )
+        try:
+            self.mirror_table = Table.read(
+                self._mirror_list_file,
+                format="ascii.no_header",
+                names=[
+                    "mirror_x",
+                    "mirror_y",
+                    "mirror_diameter",
+                    "focal_length",
+                    "shape_type",
+                    "mirror_z",
+                    "sep",
+                    "mirror_panel_id",
+                ],
+                units=["cm", "cm", "cm", "cm", None, "cm", None, None],
+            )
+            self.mirror_table["mirror_panel_id"] = np.array(
+                [
+                    int("".join(filter(str.isdigit, string)))
+                    for string in self.mirror_table["mirror_panel_id"]
+                ]
+            )
+        except astropy.io.ascii.core.InconsistentTableError:
+            self._logger.debug("Try and read mirror list with low number of columns")
+            self.mirror_table = Table.read(
+                self._mirror_list_file,
+                format="ascii.no_header",
+                names=[
+                    "mirror_x",
+                    "mirror_y",
+                    "mirror_diameter",
+                    "focal_length",
+                    "shape_type",
+                ],
+                units=["cm", "cm", "cm", "cm", None],
+            )
+            self.mirror_table["mirror_panel_id"] = np.arange(len(self.mirror_table["mirror_x"]))
 
         self.shape_type = self.mirror_table["shape_type"][0]
         self.mirror_diameter = u.Quantity(
@@ -160,7 +181,7 @@ class Mirrors:
         self._logger.debug(f"Mirror diameter = {self.mirror_diameter}")
         self._logger.debug(f"Number of Mirrors = {self.number_of_mirrors}")
 
-    def get_single_mirror_parameters(self, number):
+    def get_single_mirror_parameters(self, number: int) -> tuple:
         """
         Get parameters for a single mirror given by number.
 
@@ -171,10 +192,10 @@ class Mirrors:
 
         Returns
         -------
-        (pos_x, pos_y, mirror_diameter, focal_length, shape_type): tuple of float
+        tuple
+            (pos_x, pos_y, mirror_diameter, focal_length, shape_type): tuple of float
             X, Y positions, mirror_diameter, focal length and shape_type.
         """
-
         mask = self.mirror_table["mirror_panel_id"] == number
         if not np.any(mask):
             self._logger.debug(f"Mirror id{number} not in table, using first mirror instead")
@@ -217,6 +238,4 @@ class Mirrors:
         return return_values
 
     def plot_mirror_layout(self):
-        """
-        Plot the mirror layout (not implemented yet).
-        """
+        """Plot the mirror layout (not implemented yet)."""