gammasimtools 0.17.0__py3-none-any.whl → 0.18.0__py3-none-any.whl

simtools/schemas/model_parameters/nsb_reference_spectrum.schema.yml

@@ -32,3 +32,15 @@ source:
   - Calibration
 simulation_software:
   - name: simtools
+plot_configuration:
+  - type: nsb_reference_spectrum
+    title: 'NSB spectrum'
+    xtitle: 'Wavelength [nm]'
+    ytitle: 'Differential photon rate [10^9 / (nm s m^2 sr)]'
+    xscale: 'linear'
+    yscale: 'log'
+    no_markers: true
+    tables:
+      - parameter: nsb_reference_spectrum
+        column_x: 'wavelength'
+        column_y: 'differential photon rate'

simtools/schemas/model_parameters/pm_photoelectron_spectrum.schema.yml

@@ -39,3 +39,22 @@ source:
   - Calibration
 simulation_software:
   - name: sim_telarray
+plot_configuration:
+  - type: pm_photoelectron_spectrum
+    title: 'Single p.e. response'
+    xtitle: 'Amplitude'
+    ytitle: 'Response'
+    xscale: 'linear'
+    yscale: 'log'
+    xlim: [0., 40.]
+    ylim: [1.e-11, null]
+    no_markers: true
+    tables:
+      - parameter: pm_photoelectron_spectrum
+        label: 'prompt'
+        column_x: 'amplitude'
+        column_y: 'response'
+      - parameter: pm_photoelectron_spectrum
+        label: 'prompt + afterpulsing'
+        column_x: 'amplitude'
+        column_y: 'response_with_ap'

simtools/schemas/model_parameters/quantum_efficiency.schema.yml

@@ -40,3 +40,13 @@ source:
   - Calibration
 simulation_software:
   - name: sim_telarray
+plot_configuration:
+  - type: quantum_efficiency
+    title: 'Quantum/detection efficiency'
+    xtitle: 'Wavelength [nm]'
+    ytitle: 'Quantum/detection efficiency'
+    no_markers: true
+    tables:
+      - parameter: quantum_efficiency
+        column_x: 'wavelength'
+        column_y: 'efficiency'

simtools/schemas/plot_configuration.metaschema.yml

@@ -6,157 +6,146 @@ description: YAML representation of plot configuration metaschema
 version: 0.1.0
 name: plot_configuration.metaschema
 type: object
-additionalProperties: false
 
 definitions:
   SimtoolsPlotConfiguration:
     type: object
     additionalProperties: false
     properties:
-      CTA_SIMPIPE:
-        "$ref": "#/definitions/CTASIMPIPE"
-      SCHEMA_VERSION:
+      plot:
+        "$ref": "#/definitions/plot"
+      schema_version:
         type: string
         description: "Version of the schema."
-      SCHEMA_URL:
+      schema_url:
         type: string
         format: uri
         description: "URL of the schema."
-      SCHEMA_NAME:
+      schema_name:
         type: string
         description: "Name of the schema."
     required:
-      - CTA_SIMPIPE
+      - plot
     title: "SimtoolsPlotConfiguration"
-  CTASIMPIPE:
-    type: object
-    additionalProperties: false
-    properties:
-      PLOT:
-        "$ref": "#/definitions/Plot"
-    required:
-      - PLOT
-    title: "CTASimpipe"
-  Plot:
+  plot:
     description: "Plot configuration of simtools data visualization."
     type: object
     additionalProperties: false
     properties:
-      TYPE:
+      type:
         type: string
         description: "Type of the plot (e.g., mirror reflectivity, quantum_efficiency)."
-      TITLE:
+      title:
         type: string
         description: "Title of the plot."
-      XTITLE:
+      xtitle:
         type: string
         description: "Title of x-axis."
-      YTITLE:
+      ytitle:
         type: string
         description: "Title of y-axis."
-      XSCALE:
+      xscale:
         type: string
         enum: ["linear", "log"]
         description: "Scale of x-axis (linear or log)."
-      YSCALE:
+      yscale:
         type: string
         enum: ["linear", "log"]
         description: "Scale of y-axis (linear or log)."
-      XLIM:
+      xlim:
         type: array
         items:
           type: [number, "null"]
           description: "Limits for x-axis [min, max]. Use null for auto-limit."
         minItems: 2
         maxItems: 2
-      YLIM:
+      ylim:
         type: array
         items:
           type: [number, "null"]
           description: "Limits for y-axis [min, max]. Use null for auto-limit."
         minItems: 2
         maxItems: 2
-      ERROR_TYPE:
+      error_type:
         type: string
         enum: ["fill_between", "errorbar", "none"]
         description: "Type of errors."
-      NO_MARKERS:
+      no_markers:
         type: boolean
         description: "Whether to display markers on data points."
-      PLOT_RATIO:
+      plot_ratio:
         type: boolean
         description: "Whether to display ratio plot."
-      TABLES:
+      tables:
         type: array
         description: "List of tables to plot."
         items:
-          "$ref": "#/definitions/TableConfig"
+          "$ref": "#/definitions/table_config"
     required:
-      - TYPE
-      - TITLE
-      - XTITLE
-      - YTITLE
-      - TABLES
+      - type
+      - title
+      - xtitle
+      - ytitle
+      - tables
     title: "Plot"
-  TableConfig:
+  table_config:
     type: object
     description: "Configuration for a data table to plot."
     additionalProperties: false
     properties:
-      PARAMETER:
+      parameter:
         type: string
         description: "Parameter name to retrieve data for."
-      FILE_NAME:
+      file_name:
         type: string
         description: "Path to the data file."
-      TYPE:
+      type:
         type: string
         description: "Type of data file."
-      TELESCOPE:
+      telescope:
         type: string
         description: "Telescope descriptor to retrieve data for."
-      SITE:
+      site:
         type: string
         description: "Site name (North/South)."
-      MODEL_VERSION:
+      model_version:
         type: string
         description: "Model version to use."
-      PARAMETER_VERSION:
+      parameter_version:
         type: string
         description: "Parameter version to use."
-      LABEL:
+      label:
         type: string
         description: "Label for the plot legend."
-      COLUMN_X:
+      column_x:
         type: string
         description: "Column name to use for x-axis."
-      COLUMN_Y:
+      column_y:
         type: string
         description: "Column name to use for y-axis."
-      COLUMN_X_ERR:
+      column_x_err:
         type: string
         description: "Column name to use for x-axis error."
-      COLUMN_Y_ERR:
+      column_y_err:
         type: string
         description: "Column name to use for y-axis error."
-      NORMALIZE_Y:
+      normalize_y:
         type: boolean
         description: "Whether to normalize y values."
-      SELECT_VALUES:
+      select_values:
         type: object
         description: "Selection criteria for data filtering."
         properties:
-          COLUMN_NAME:
+          column_name:
             type: string
             description: "Column name to use for filtering."
-          VALUE:
+          value:
             type: [number, string]
             description: "Value to filter by."
         required:
-          - COLUMN_NAME
-          - VALUE
+          - column_name
+          - value
     required:
-      - COLUMN_X
-      - COLUMN_Y
-      - LABEL
+      - column_x
+      - column_y
     title: "TableConfig"

simtools/simtel/simtel_io_event_reader.py

@@ -144,7 +144,7 @@ class SimtelIOEventDataReader:
         for col in table.colnames:
             if col == "telescope_list":
                 arrays = [
-                    np.array(list(map(int, tel_list.split(","))), dtype=np.int16)
+                    np.array(list(map(str, tel_list.split(","))), dtype=np.str_)
                     for tel_list in table[col]
                 ]
                 triggered_data.telescope_list = arrays

simtools/simtel/simtel_io_event_writer.py

@@ -18,7 +18,11 @@ from eventio.simtel import (
 
 from simtools.corsika.primary_particle import PrimaryParticle
 from simtools.simtel.simtel_io_file_info import get_corsika_run_header
+from simtools.simtel.simtel_io_metadata import (
+    get_sim_telarray_telescope_id_to_telescope_name_mapping,
+)
 from simtools.utils.geometry import calculate_circular_mean
+from simtools.utils.names import get_common_identifier_from_array_element_name
 
 
 @dataclass
@@ -44,6 +48,7 @@ class TableSchemas:
         "array_altitude": (np.float64, u.rad),
         "array_azimuth": (np.float64, u.rad),
         "telescope_list": (str, None),  # Store as comma-separated string
+        "telescope_list_common_id": (str, None),  # Store as comma-separated string
     }
 
     file_info_schema = {
@@ -93,6 +98,7 @@ class SimtelIOEventDataWriter:
         self.shower_data = []
         self.trigger_data = []
         self.file_info = []
+        self.telescope_id_to_name = {}
 
     def process_files(self):
         """
@@ -152,6 +158,7 @@ class SimtelIOEventDataWriter:
     def _process_file_info(self, file_id, file):
         """Process file information and append to file info list."""
         run_info = get_corsika_run_header(file)
+        self.telescope_id_to_name = get_sim_telarray_telescope_id_to_telescope_name_mapping(file)
         particle = PrimaryParticle(
             particle_id_type="eventio_id", particle_id=run_info.get("primary_id", 1)
         )
@@ -246,7 +253,12 @@ class SimtelIOEventDataWriter:
                 )
 
         if len(telescopes) > 0 and tracking_positions:
-            self._fill_array_event(telescopes, tracking_positions, eventio_object.event_id, file_id)
+            self._fill_array_event(
+                self._map_telescope_names(telescopes),
+                tracking_positions,
+                eventio_object.event_id,
+                file_id,
+            )
 
     def _fill_array_event(self, telescopes, tracking_positions, event_id, file_id):
         """Add array event triggered events with tracking positions."""
@@ -261,9 +273,33 @@ class SimtelIOEventDataWriter:
                 "array_altitude": float(np.mean(altitudes)),
                 "array_azimuth": float(calculate_circular_mean(azimuths)),
                 "telescope_list": ",".join(map(str, telescopes)),
+                "telescope_list_common_id": ",".join(
+                    [
+                        str(get_common_identifier_from_array_element_name(tel, 0))
+                        for tel in telescopes
+                    ]
+                ),
             }
         )
 
+    def _map_telescope_names(self, telescope_ids):
+        """
+        Map sim_telarray telescopes IDs to CTAO array element names.
+
+        Parameters
+        ----------
+        telescope_ids : list
+            List of telescope IDs.
+
+        Returns
+        -------
+        list
+            List of telescope names corresponding to the IDs.
+        """
+        return [
+            self.telescope_id_to_name.get(tel_id, f"Unknown_{tel_id}") for tel_id in telescope_ids
+        ]
+
     def _get_preliminary_nsb_level(self, file):
         """
         Return preliminary NSB level from file name.

simtools/simtel/simtel_io_metadata.py

@@ -2,11 +2,15 @@
 """Read metadata from sim_telarray files."""
 
 import logging
+import re
 from functools import cache
 
 from eventio import EventIOFile
+from eventio.iact import InputCard
 from eventio.simtel import HistoryMeta
 
+from simtools.utils import names
+
 _logger = logging.getLogger(__name__)
 
 
@@ -56,9 +60,12 @@ def read_sim_telarray_metadata(file, encoding="utf8"):
         return {k: v.strip() if isinstance(v, str) else v for k, v in meta.items()}
 
     # keys to lower case and strip leading '*', trailing spaces
-    return clean_meta(global_meta), {
-        tel_id: clean_meta(meta) for tel_id, meta in telescope_meta.items()
-    }
+    try:
+        return clean_meta(global_meta), {
+            tel_id: clean_meta(meta) for tel_id, meta in telescope_meta.items()
+        }
+    except AttributeError as e:
+        raise AttributeError(f"Error reading metadata from file {file}: {e}") from e
 
 
 def _decode_dictionary(meta, encoding="utf8"):
@@ -104,3 +111,92 @@ def get_sim_telarray_telescope_id(telescope_name, file):
             telescope_name_to_sim_telarray_id[telescope_name] = tel_id
 
     return telescope_name_to_sim_telarray_id.get(telescope_name, None)
+
+
+def get_sim_telarray_telescope_id_to_telescope_name_mapping(file):
+    """
+    Return a mapping of telescope IDs to telescope names from a sim_telarray file.
+
+    Parameters
+    ----------
+    file: str
+        Path to the sim_telarray file.
+
+    Returns
+    -------
+    dict
+        Dictionary mapping telescope IDs to telescope names.
+    """
+    _, telescope_meta = read_sim_telarray_metadata(file)
+    telescope_map = {}
+    for i, (tel_id, meta) in enumerate(telescope_meta.items()):
+        try:
+            telescope_name = names.validate_array_element_name(
+                meta.get("optics_config_name", f"Unknown-{tel_id}")
+            )
+        except ValueError:
+            telescope_name = _guess_telescope_name_for_legacy_files(i, file)
+        if telescope_name is not None:
+            telescope_map[tel_id] = telescope_name
+
+    return telescope_map
+
+
+def _guess_telescope_name_for_legacy_files(tel_counter, file):
+    """
+    Guess telescope names for legacy prod6 sim_telarray files with incomplete metadata.
+
+    Parameters
+    ----------
+    tel_counter: int
+        Telescope counter, used to index into the telescope list.
+    file: str, Path
+        Path to the sim_telarray file.
+
+    Returns
+    -------
+    str, None
+        Guessed telescope name or None if not found.
+    """
+    telescope_list = _get_telescope_list_from_input_card(file)
+    try:
+        return names.validate_array_element_name(telescope_list[tel_counter])
+    except (IndexError, ValueError):
+        pass
+    return None
+
+
+@cache
+def _get_telescope_list_from_input_card(file):
+    r"""
+    Return telescope list from CORSIKA input card.
+
+    Note hardwired regex pattern with telescope naming convention.
+    This function is intended for legacy files generated for prod6,
+    where metadata is incomplete.
+
+    Expected format in input card:
+
+    .. code-block:: console
+        TELESCOPE    -70.91E2     -52.35E2 45.00E2  12.50E2  # (ID=1)  LSTN   01   2B5\n
+
+    Parameters
+    ----------
+    file: str, Path
+        Path to the sim_telarray file.
+
+    Returns
+    -------
+    list
+        List of telescope names as found in CORSIKA input card.
+    """
+    with EventIOFile(file) as f:
+        for o in f:
+            if isinstance(o, InputCard):
+                input_card = o.parse().decode("utf-8")
+                regex = (
+                    r"TELESCOPE\s+[-\d.E]+\s+[-\d.E]+\s+[-\d.E]+\s+[-\d.E]+\s+"
+                    r"# \(ID=\d+\)\s+(LST[N|S]|MST[N|S]|S[S|C]TS)\s+([^\s]+)"
+                )
+                return [f"{m[0]}-{m[1]}" for m in re.findall(regex, input_card)]
+    return []

simtools/utils/general.py

@@ -324,10 +324,8 @@ def get_log_level_from_user(log_level):
     possible_levels = {
         "info": logging.INFO,
         "debug": logging.DEBUG,
-        "warn": logging.WARNING,
         "warning": logging.WARNING,
         "error": logging.ERROR,
-        "critical": logging.CRITICAL,
     }
     try:
         log_level_lower = log_level.lower()

simtools/utils/names.py

@@ -12,6 +12,7 @@ Naming in simtools:
 
 """
 
+import json
 import logging
 import re
 from functools import cache
@@ -22,7 +23,7 @@ import yaml
 from simtools.constants import (
     MODEL_PARAMETER_DESCRIPTION_METASCHEMA,
     MODEL_PARAMETER_SCHEMA_PATH,
-    SCHEMA_PATH,
+    RESOURCE_PATH,
 )
 
 _logger = logging.getLogger(__name__)
@@ -59,10 +60,30 @@ def array_elements():
     dict
         Array elements.
     """
-    with open(Path(SCHEMA_PATH) / "array_elements.yml", encoding="utf-8") as file:
+    # for efficiency reason, no functions from simtools.utils.general are used here
+    with open(Path(RESOURCE_PATH) / "array_elements.yml", encoding="utf-8") as file:
         return yaml.safe_load(file)["data"]
 
 
+@cache
+def array_element_common_identifiers():
+    """
+    Get array element IDs from CTAO common identifier.
+
+    Returns
+    -------
+    dict, dict
+        Dictionary mapping array element names to their IDs and vice versa.
+    """
+    # for efficiency reason, no functions from simtools.utils.general are used here
+    id_to_name = {}
+    with open(Path(RESOURCE_PATH) / "array-element-ids.json", encoding="utf-8") as file:
+        data = json.load(file)
+    id_to_name = {e["id"]: e["name"] for e in data["array_elements"]}
+    name_to_id = {e["name"]: e["id"] for e in data["array_elements"]}
+    return id_to_name, name_to_id
+
+
 @cache
 def simulation_software():
     """
@@ -415,6 +436,54 @@ def get_array_element_id_from_name(array_element_name):
         raise ValueError(f"Invalid name {array_element_name}") from exc
 
 
+def get_common_identifier_from_array_element_name(array_element_name, default_return=None):
+    """
+    Get numerical common identifier from array element name as used by CTAO.
+
+    Common identifiers are numerical IDs used by the CTAO ACADA and DPPS systems.
+
+    Parameters
+    ----------
+    array_element_name: str
+        Array element name (e.g. LSTN-01)
+
+    Returns
+    -------
+    int
+        Common identifier.
+    """
+    _, name_to_id = array_element_common_identifiers()
+    try:
+        return name_to_id[array_element_name]
+    except KeyError as exc:
+        if default_return is not None:
+            return default_return
+        raise ValueError(f"Unknown array element name {array_element_name}") from exc
+
+
+def get_array_element_name_from_common_identifier(common_identifier):
+    """
+    Get array element name from common identifier as used by CTAO.
+
+    Common identifiers are numerical IDs used by the CTAO ACADA and DPPS systems.
+
+    Parameters
+    ----------
+    common_identifier: int
+        Common identifier.
+
+    Returns
+    -------
+    str
+        Array element name.
+    """
+    id_to_name, _ = array_element_common_identifiers()
+    try:
+        return id_to_name[common_identifier]
+    except KeyError as exc:
+        raise ValueError(f"Unknown common identifier {common_identifier}") from exc
+
+
 def get_list_of_array_element_types(
     array_element_class="telescopes", site=None, observatory="CTAO"
 ):

simtools/visualization/plot_pixels.py

@@ -246,7 +246,6 @@ def _create_pixel_plot(
     )
     _add_legend(ax, on_pixels, off_pixels)
 
-    plt.tight_layout()
     return fig