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

simtools/schemas/model_parameters/fadc_compensate_pedestal.schema.yml

@@ -8,7 +8,7 @@ meta_schema_version: 0.1.0
 name: fadc_compensate_pedestal
 description: |-
   Emulate FADC pedestal compensation (as e.g., done in camera firmware using FPGAs)
-  to homogenise significant pixel-to-pixel variations of raw pedestals values
+  to homogenize significant pixel-to-pixel variations of raw pedestals values
   (for high-gain channel for dual-gain readout).
   The resulting values are still unsigned integers and no rescaling takes place
   (pure integer pedestal offset). No compensation takes place for the default value

simtools/schemas/model_parameters/fadc_lg_compensate_pedestal.schema.yml

@@ -8,7 +8,7 @@ meta_schema_version: 0.1.0
 name: fadc_lg_compensate_pedestal
 description: |-
   Emulate FADC pedestal compensation (as e.g., done in camera firmware using FPGAs)
-  to homogenise significant pixel-to-pixel variations of raw pedestals values
+  to homogenize significant pixel-to-pixel variations of raw pedestals values
   (for low-gain channel for dual-gain readout).
   The resulting values are still unsigned integers and no rescaling takes place
   (pure integer pedestal offset). No compensation takes place for the default value

simtools/schemas/model_parameters/fadc_noise.schema.yml

@@ -7,13 +7,13 @@ meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/si
 meta_schema_version: 0.1.0
 name: fadc_noise
 description: |-
-  Gaussian r.m.s. spread of white noise per time bin in digitisation
+  Gaussian r.m.s. spread of white noise per time bin in digitization
   (for high-gain channel, if different gains are used).
-short_description: Gaussian r.m.s. spread of white noise per time bin in digitisation.
+short_description: Gaussian r.m.s. spread of white noise per time bin in digitization.
 data:
   - type: double
     description: |-
-      Gaussian r.m.s. spread of white noise per time bin in digitisation
+      Gaussian r.m.s. spread of white noise per time bin in digitization
       (for high-gain channel in case of dual-readout chain)
     unit: count
     default: 4.0

simtools/schemas/model_parameters/fake_mirror_list.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for fake_mirror_list model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+developer_note: To be replaced by a data table
+name: fake_mirror_list
+short_description: Fake mirror list to be used for camera efficiency calculations ('testeff' program).
+description: |-
+  Fake mirror list to be used for camera efficiency calculations ('testeff' program).
+  Allows to obtain realistic distributions of the photon incidence angles on the camera plan.
+  Not to be used for actual simulations.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraEfficiency
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_photons.schema.yml

@@ -7,9 +7,9 @@ meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/si
 meta_schema_version: 0.1.0
 name: laser_photons
 description: |-
-  Number of laser photons at each photodetector.
+  Number of laser photons at each photo detector.
 short_description: |-
-  Number of laser photons at each photodetector.
+  Number of laser photons at each photo detector.
 data:
   - type: double
     unit: dimensionless

simtools/schemas/model_parameters/secondary_mirror_degraded_reflection.schema.yml

@@ -10,7 +10,7 @@ description: |-
   Mirror degradation factor for the secondary mirror (wavelength independent).
   Strictly interpreted as being for reflection on the secondary mirror of a
   dual-mirror telescope, and still gets applied in simulations where only
-  the reflection on the primary mirror is bypassd (for example a
+  the reflection on the primary mirror is bypassed (for example a
   flat-fielding light source illuminating the camera via reflection on the
   secondary).
 short_description: |-

simtools/schemas/production_configuration_metrics.schema.yml

@@ -0,0 +1,68 @@
+---
+$schema: http://json-schema.org/draft-06/schema#
+$ref: '#/definitions/ErrorMetrics'
+title: Statistical Error Metrics Schema
+description: |
+  YAML representation of simulation production configuration
+  metrics.
+version: 0.1.0
+name: production_configuration_metrics.metaschema
+type: object
+additionalProperties: false
+
+definitions:
+  ErrorMetrics:
+    type: object
+    description: Definition of error metrics and validity ranges.
+    additionalProperties: false
+    properties:
+      uncertainty_effective_area:
+        $ref: '#/definitions/ErrorMetric'
+      energy_estimate:
+        $ref: '#/definitions/ErrorMetric'
+
+  ErrorMetric:
+    type: object
+    description: Error metric definition.
+    additionalProperties: false
+    properties:
+      description:
+        type: string
+        description: Description of the error metric.
+      target_error:
+        $ref: '#/definitions/TargetError'
+      energy_range:
+        $ref: '#/definitions/EnergyRange'
+    required:
+      - target_error
+      - energy_range
+
+  TargetError:
+    type: object
+    description: Target error specification.
+    additionalProperties: false
+    properties:
+      value:
+        type: number
+        description: Target error value.
+    required:
+      - value
+
+  EnergyRange:
+    type: object
+    description: Energy range specification.
+    additionalProperties: false
+    properties:
+      value:
+        type: array
+        description: Energy range values.
+        items:
+          type: number
+        minItems: 2
+        maxItems: 2
+      unit:
+        type: string
+        description: Energy unit.
+    required:
+      - value
+      - unit

simtools/schemas/production_tables.schema.yml

@@ -0,0 +1,41 @@
+---
+$schema: http://json-schema.org/draft-06/schema#
+$ref: '#/definitions/ProductionModelTable'
+title: SimPipe DB Production Model Metaschema
+description: |
+  YAML representation of DB production model metaschema
+  (based on simulation model DB).
+version: 0.1.0
+name: production_table.metaschema
+type: object
+additionalProperties: false
+
+definitions:
+  ProductionModelTable:
+    properties:
+      model_version:
+        type: string
+        description: Model version.
+        pattern: '^\d+\.\d+\.\d+$'
+      parameters:
+        type: object
+        description: Model parameters.
+        additionalProperties:
+          type: object
+          description: Model parameter.
+          additionalProperties:
+            type: string
+            description: Parameter version (semantical versioning).
+            pattern: '^\d+\.\d+\.\d+$'
+        propertyNames:
+          description: Allowed parameter name patterns.
+          pattern: '^([A-Za-z](ST|LL)[N,S,x]-\d{2,3}|[A-Za-z](ST|LL)[N,S,x]-design|OBS-(North|South)|Dummy-Telescope)$'
+      design_model:
+        type: object
+        description: Design models.
+        additionalProperties:
+          type: string
+          description: Design model of a telescope
+    required:
+      - model_version
+      - parameters

simtools/simtel/simtel_config_writer.py

@@ -78,8 +78,10 @@ class SimtelConfigWriter:
             file.write("#endif\n\n")
 
             for _simtel_name, value in parameters.items():
-                if _simtel_name.startswith("array_trigger"):
-                    continue  # array trigger is a site parameter, not a telescope parameter
+                # array trigger is a site parameter, not a telescope parameter
+                # fake_mirror_list is not a sim_telarray parameter (used for testeff only)
+                if _simtel_name.startswith("array_trigger") or _simtel_name == "fake_mirror_list":
+                    continue
                 if _simtel_name:
                     file.write(f"{_simtel_name} = {self._get_value_string_for_simtel(value)}\n")
             _config_meta = self._get_simtel_metadata("telescope")
@@ -294,10 +296,7 @@ class SimtelConfigWriter:
         _site_parameters = site_model.get_simtel_parameters()
         for par, value in _site_parameters.items():
             _simtel_name = names.get_simulation_software_name_from_parameter_name(
-                par,
-                simulation_software="sim_telarray",
-                search_telescope_parameters=False,
-                search_site_parameters=True,
+                par, simulation_software="sim_telarray"
             )
             _simtel_name, value = self._convert_model_parameters_to_simtel_format(
                 _simtel_name, value, model_path, telescope_model

simtools/simtel/simtel_io_histogram.py

@@ -1,8 +1,4 @@
-"""
-Reads the content of either a single histogram (.hdata) or a single simtel_array output (.simtel).
-
-Files can be zst compressed.
-"""
+"""Reads the content of either a single histogram or simtel_array output file."""
 
 import copy
 import logging
@@ -81,9 +77,9 @@ class SimtelIOHistogram:
         self._config = None
         self._total_area = None
         self._solid_angle = None
+        self._histogram = None
         self._total_num_simulated_events = None
         self._total_num_triggered_events = None
-        self._histogram = None
         self._initialize_histogram()
         self.trigger_rate = None
         self.trigger_rate_uncertainty = None
@@ -134,56 +130,39 @@ class SimtelIOHistogram:
         """
         Return information about the input parameters for the simulation.
 
+        If the file is a .hdata or .hdata.zst, config will be None.
+
         Returns
         -------
         dict:
             dictionary with information about the simulation (pyeventio MCRunHeader object).
         """
         if self._config is None:
-            # If the file is a .hdata or .hdata.zst, config will continue to be None.
             with EventIOFile(self.histogram_file) as f:
-                # Try to find configuration from .simtel file. If .hdata, config will be None
-                for obj in f:
-                    if isinstance(obj, MCRunHeader):
-                        self._config = obj.parse()
-
+                self._config = next(
+                    (obj.parse() for obj in f if isinstance(obj, MCRunHeader)), None
+                )
         return self._config
 
     @property
-    def total_num_simulated_events(self):
-        """
-        Return the total number of simulated events the histograms.
-
-        Returns
-        -------
-        int:
-            total number of simulated events.
-        """
-        if self._total_num_simulated_events is None:
-            events_histogram, _ = self.fill_event_histogram_dicts()
-            self._total_num_simulated_events = np.sum(events_histogram["data"])
-            logging.debug(f"Number of total simulated showers: {self._total_num_simulated_events}")
-        return self._total_num_simulated_events
-
-    @property
-    def total_num_triggered_events(self):
+    def total_number_of_events(self):
         """
-        Returns the total number of triggered events.
-
-        Please note that this value is not supposed to match the trigger rate x estimated
-        observation time, as the simulation is optimized for computational time and the energy
-        distribution assumed is not necessarily the reference cosmic-ray spectra.
+        Return the total number of simulated and triggered events in the histograms.
 
         Returns
         -------
-        int:
-            total number of simulated events.
+        int, int:
+            total number of simulated and triggered events.
         """
-        if self._total_num_triggered_events is None:
-            _, trigger_histogram = self.fill_event_histogram_dicts()
+        if self._total_num_simulated_events is None or self._total_num_triggered_events is None:
+            simulated_histogram, trigger_histogram = self.fill_event_histogram_dicts()
+            self._total_num_simulated_events = np.sum(simulated_histogram["data"])
             self._total_num_triggered_events = np.sum(trigger_histogram["data"])
-            logging.debug(f"Number of total triggered showers: {self._total_num_triggered_events}")
-        return self._total_num_triggered_events
+            logging.debug(
+                "Number of total simulated / triggered events: "
+                f"{self._total_num_simulated_events} / {self._total_num_triggered_events}"
+            )
+        return self._total_num_simulated_events, self._total_num_triggered_events
 
     def fill_event_histogram_dicts(self):
         """
@@ -191,34 +170,18 @@ class SimtelIOHistogram:
 
         Returns
         -------
-        dict:
-            Information about the histograms with simulated events.
-        dict:
-            Information about the histograms with triggered events.
+        tuple(dict, dict):
+            Information about the histograms with simulated and triggered events.
 
         Raises
         ------
         HistogramIdNotFoundError:
             if histogram ids not found. Problem with the file.
         """
-        # Save the appropriate histograms to variables
-        found_simulated_events_hist = False
-        found_triggered_events_hist = False
-        events_histogram = None
-        triggered_events_histogram = None
-        for hist in self.histogram:
-            if hist["id"] == 1:
-                events_histogram = hist
-                found_simulated_events_hist = True
-            elif hist["id"] == 2:
-                triggered_events_histogram = hist
-                found_triggered_events_hist = True
-            if found_simulated_events_hist * found_triggered_events_hist:
-                if "triggered_events_histogram" in locals():
-                    return events_histogram, triggered_events_histogram
-        msg = "Histograms ids not found. Please check your files."
-
-        self._logger.error(msg)
+        histograms = {hist["id"]: hist for hist in self.histogram if hist["id"] in {1, 2}}
+        if 1 in histograms and 2 in histograms:
+            return histograms[1], histograms[2]
+        self._logger.error("Histograms ids not found. Please check your files.")
         raise HistogramIdNotFoundError
 
     def _set_view_cone(self, view_cone):
@@ -521,11 +484,11 @@ class SimtelIOHistogram:
         """
         Get the particle distribution function.
 
-        This depends  on whether one wants the reference CR distribution or the distribution
+        This depends on whether one wants the reference CR distribution or the distribution
         used in the simulation. This is controlled by label.
         By using label="reference", one gets the distribution function according to a pre-defined CR
         distribution, while by using label="simulation", the spectral index of the distribution
-        function from the simulation is used. Naturally, label="simulation" only works when the
+        function from the simulation is used. The label="simulation" works only when the
         input file is a .simtel file and not a .hdata file.
 
         Parameters
@@ -603,7 +566,8 @@ class SimtelIOHistogram:
             self.energy_range[1],
         )
         if stacked_num_simulated_events is None:
-            return (self.total_num_simulated_events / first_estimate) * u.s
+            _simulated_events, _ = self.total_number_of_events
+            return (_simulated_events / first_estimate) * u.s
         return (stacked_num_simulated_events / first_estimate) * u.s
 
     def estimate_trigger_rate_uncertainty(
@@ -648,13 +612,14 @@ class SimtelIOHistogram:
         dict:
             Dictionary with the information, e.g., view angle, energy range, etc.
         """
+        _simulated, _triggered = self.total_number_of_events
         info_dict = {
             "view_cone": self.view_cone,
             "solid_angle": self.solid_angle,
             "total_area": self.total_area,
             "energy_range": self.energy_range,
-            "total_num_simulated_events": self.total_num_simulated_events,
-            "total_num_triggered_events": self.total_num_triggered_events,
+            "total_num_simulated_events": _simulated,
+            "total_num_triggered_events": _triggered,
         }
         if mode != "silent":
             print(info_dict)

simtools/simtel/simtel_io_histograms.py

@@ -1,10 +1,4 @@
-"""
-Reads the content of multiples files from sim_telarray.
-
-Reads the content of either multiple histogram (.hdata, or .hdata.zst) or
-simtel_array output files (.simtel or .simtel.zst). The module is built on top of the
-simtel_io_histogram module and uses its class (SimtelIOHistogram) to read the individual files.
-"""
+"""Reads the content of multiples files from sim_telarray."""
 
 import copy
 import logging
@@ -192,8 +186,9 @@ class SimtelIOHistograms:
                 energy_range=self.energy_range,
                 view_cone=self.view_cone,
             )
-            stacked_num_simulated_events += simtel_hist_instance.total_num_simulated_events
-            stacked_num_triggered_events += simtel_hist_instance.total_num_triggered_events
+            _simulated, _triggered = simtel_hist_instance.total_number_of_events
+            stacked_num_simulated_events += _simulated
+            stacked_num_triggered_events += _triggered
         return stacked_num_simulated_events, stacked_num_triggered_events
 
     def _rates_for_stacked_files(self):
@@ -245,7 +240,7 @@ class SimtelIOHistograms:
         logging.info(
             f"System trigger event rate for stacked files: "
             # pylint: disable=E1101
-            f"{triggered_event_rate.value:.4e} \u00B1 "
+            f"{triggered_event_rate.value:.4e} \u00b1 "
             # pylint: disable=E1101
             f"{triggered_event_rate_uncertainty.value:.4e} Hz"
         )
@@ -282,24 +277,17 @@ class SimtelIOHistograms:
             if print_info:
                 simtel_hist_instance.print_info()
 
+            _simulated_events, _triggered_events = simtel_hist_instance.total_number_of_events
             logging.info(f"Histogram {i_file + 1}:")
-            logging.info(
-                "Total number of simulated events: "
-                f"{simtel_hist_instance.total_num_simulated_events} events"
-            )
-            logging.info(
-                "Total number of triggered events: "
-                f"{simtel_hist_instance.total_num_triggered_events} events"
-            )
+            logging.info(f"Total number of simulated events: {_simulated_events} events")
+            logging.info(f"Total number of triggered events: {_triggered_events} events")
 
-            obs_time = simtel_hist_instance.estimate_observation_time(
-                simtel_hist_instance.total_num_simulated_events
-            )
+            obs_time = simtel_hist_instance.estimate_observation_time(_simulated_events)
             logging.info(
                 f"Estimated equivalent observation time corresponding to the number of "
                 f"events simulated: {obs_time.value} s"
             )
-            sim_event_rate = simtel_hist_instance.total_num_simulated_events / obs_time
+            sim_event_rate = _simulated_events / obs_time
             sim_event_rates.append(sim_event_rate)
             logging.info(f"Simulated event rate: {sim_event_rate.value:.4e} Hz")
 
@@ -310,7 +298,7 @@ class SimtelIOHistograms:
             logging.info(
                 f"System trigger event rate: "
                 # pylint: disable=E1101
-                f"{triggered_event_rate.value:.4e} \u00B1 "
+                f"{triggered_event_rate.value:.4e} \u00b1 "
                 # pylint: disable=E1101
                 f"{triggered_event_rate_uncertainty.value:.4e} Hz"
             )
@@ -515,15 +503,16 @@ class SimtelIOHistograms:
 
     def export_histograms(self, hdf5_file_name, overwrite=False):
         """
-        Export the histograms to hdf5 files.
+        Export sim_telarray histograms to hdf5 files.
 
         Parameters
         ----------
         hdf5_file_name: str
             Name of the file to be saved with the hdf5 tables.
         overwrite: bool
-            If True overwrites the histograms already saved in the hdf5 file.
+            If True overwrites histograms already saved in the hdf5 file.
         """
+        self._logger.info(f"Exporting histograms to {hdf5_file_name}.")
         for histogram in self.combined_hists:
             x_bin_edges_list = np.linspace(
                 histogram["lower_x"],
@@ -556,14 +545,10 @@ class SimtelIOHistograms:
                 f"Writing histogram with name {self._meta_dict['Title']} to {hdf5_file_name}."
             )
             # overwrite takes precedence over append
-            if overwrite is True:
-                append = False
-            else:
-                append = True
             write_table(
                 table,
                 hdf5_file_name,
                 f"/{self._meta_dict['Title']}",
-                append=append,
+                append=not overwrite,
                 overwrite=overwrite,
             )