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

simtools/simtel/simulator_array.py

@@ -0,0 +1,145 @@
+"""Simulation runner for array simulations."""
+
+import logging
+
+from simtools.io_operations import io_handler
+from simtools.runners.simtel_runner import InvalidOutputFileError, SimtelRunner
+
+__all__ = ["SimulatorArray"]
+
+
+class SimulatorArray(SimtelRunner):
+    """
+    SimulatorArray is the interface with sim_telarray to perform array simulations.
+
+    Parameters
+    ----------
+    corsika_config_data: CorsikaConfig
+        CORSIKA configuration.
+    simtel_path: str or Path
+        Location of source of the sim_telarray/CORSIKA package.
+    label: str
+        Instance label.
+    use_multipipe: bool
+        Use multipipe to run CORSIKA and sim_telarray.
+    """
+
+    def __init__(
+        self,
+        corsika_config,
+        simtel_path,
+        label=None,
+        use_multipipe=False,
+        sim_telarray_seeds=None,
+    ):
+        """Initialize SimulatorArray."""
+        self._logger = logging.getLogger(__name__)
+        self._logger.debug("Init SimulatorArray")
+        super().__init__(
+            label=label,
+            simtel_path=simtel_path,
+            corsika_config=corsika_config,
+            use_multipipe=use_multipipe,
+        )
+
+        self.sim_telarray_seeds = sim_telarray_seeds
+        self.corsika_config = corsika_config
+        self.io_handler = io_handler.IOHandler()
+        self._log_file = None
+
+    def _make_run_command(self, run_number=None, input_file=None):
+        """
+        Build and return the command to run simtel_array.
+
+        Parameters
+        ----------
+        input_file: str
+            Full path of the input CORSIKA file
+        run_number: int (optional)
+            run number
+
+        Returns
+        -------
+        str
+            Command to run sim_telarray.
+        """
+        self._log_file = self.get_file_name(file_type="log", run_number=run_number)
+        histogram_file = self.get_file_name(file_type="histogram", run_number=run_number)
+        output_file = self.get_file_name(file_type="output", run_number=run_number)
+
+        # Array
+        command = str(self._simtel_path.joinpath("sim_telarray/bin/sim_telarray"))
+        command += f" -c {self.corsika_config.array_model.get_config_file()}"
+        command += f" -I{self.corsika_config.array_model.get_config_directory()}"
+        command += super().get_config_option("telescope_theta", self.corsika_config.zenith_angle)
+        command += super().get_config_option("telescope_phi", self.corsika_config.azimuth_angle)
+        command += super().get_config_option(
+            "power_law",
+            SimulatorArray.get_power_law_for_sim_telarray_histograms(
+                self.corsika_config.primary_particle
+            ),
+        )
+        command += super().get_config_option("histogram_file", histogram_file)
+        command += super().get_config_option("output_file", output_file)
+        command += super().get_config_option("random_state", "none")
+        if self.sim_telarray_seeds:
+            command += super().get_config_option("random_seed", self.sim_telarray_seeds)
+        command += super().get_config_option("show", "all")
+        command += f" {input_file}"
+        command += f" > {self._log_file} 2>&1 || exit"
+
+        return command
+
+    def _check_run_result(self, run_number=None):
+        """
+        Check if simtel output file exists.
+
+        Parameters
+        ----------
+        run_number: int
+            Run number.
+
+        Returns
+        -------
+        bool
+            True if simtel output file exists.
+
+        Raises
+        ------
+        InvalidOutputFileError
+            If simtel output file does not exist.
+        """
+        output_file = self.get_file_name(file_type="output", run_number=run_number)
+        if not output_file.exists():
+            msg = f"sim_telarray output file {output_file} does not exist."
+            self._logger.error(msg)
+            raise InvalidOutputFileError(msg)
+        self._logger.debug(f"simtel_array output file {output_file} exists.")
+        return True
+
+    @staticmethod
+    def get_power_law_for_sim_telarray_histograms(primary):
+        """
+        Get the power law index for sim_telarray.
+
+        Events will be histogrammed in sim_telarray with a weight according to
+        the difference between this exponent and the one used for the shower simulations.
+
+        Parameters
+        ----------
+        primary: str
+            Primary particle.
+
+        Returns
+        -------
+        float
+            Power law index.
+        """
+        power_laws = {
+            "gamma": 2.5,
+            "electron": 3.3,
+        }
+        if primary.name in power_laws:
+            return power_laws[primary.name]
+
+        return 2.68

simtools/simtel/{simtel_runner_camera_efficiency.py → simulator_camera_efficiency.py}

@@ -1,15 +1,18 @@
+"""Simulation runner for camera efficiency calculations."""
+
 import logging
 from pathlib import Path
 
-from simtools.simtel.simtel_runner import SimtelRunner
+from simtools.model.model_parameter import InvalidModelParameterError
+from simtools.runners.simtel_runner import SimtelRunner
+from simtools.utils import general
 
-__all__ = ["SimtelRunnerCameraEfficiency"]
+__all__ = ["SimulatorCameraEfficiency"]
 
 
-class SimtelRunnerCameraEfficiency(SimtelRunner):
+class SimulatorCameraEfficiency(SimtelRunner):
     """
-    SimtelRunnerCameraEfficiency is the interface with the testeff tool of sim_telarray to perform\
-    camera efficiency simulations.
+    Interface with the testeff tool of sim_telarray to perform camera efficiency simulations.
 
     Parameters
     ----------
@@ -17,31 +20,32 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
         Instance of TelescopeModel class.
     label: str
         Instance label. Important for output file naming.
-    simtel_source_path: str or Path
+    simtel_path: str or Path
         Location of sim_telarray installation.
     file_simtel: str or Path
-        location of the sim_telarray testeff tool output file.
+        Location of the sim_telarray testeff tool output file.
     zenith_angle: float
-        The zenith angle given in the config to CameraEfficiency.
+        Zenith angle given in the config to CameraEfficiency.
+    nsb_spectrum: str or Path
+        Path to the nsb spectrum file.
     """
 
     def __init__(
         self,
         telescope_model,
         label=None,
-        simtel_source_path=None,
+        simtel_path=None,
         file_simtel=None,
         file_log=None,
         zenith_angle=None,
         nsb_spectrum=None,
+        skip_correction_to_nsb_spectrum=False,
     ):
-        """
-        Initialize SimtelRunner.
-        """
+        """Initialize SimtelRunner."""
         self._logger = logging.getLogger(__name__)
-        self._logger.debug("Init SimtelRunnerCameraEfficiency")
+        self._logger.debug("Init SimulatorCameraEfficiency")
 
-        super().__init__(label=label, simtel_source_path=simtel_source_path)
+        super().__init__(label=label, simtel_path=simtel_path)
 
         self._telescope_model = telescope_model
         self.label = label if label is not None else self._telescope_model.label
@@ -50,29 +54,28 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
         self._file_log = file_log
         self.zenith_angle = zenith_angle
         self.nsb_spectrum = nsb_spectrum
+        self.skip_correction_to_nsb_spectrum = skip_correction_to_nsb_spectrum
 
     @property
     def nsb_spectrum(self):
-        """nsb_spectrum property"""
+        """nsb_spectrum property."""
         return self._nsb_spectrum
 
     @nsb_spectrum.setter
     def nsb_spectrum(self, nsb_spectrum):
-        """Setter for nsb_spectrum"""
+        """Setter for nsb_spectrum."""
         if nsb_spectrum is not None:
             self._nsb_spectrum = self._validate_or_fix_nsb_spectrum_file_format(nsb_spectrum)
         else:
-            self._nsb_spectrum = None
-
-    def _shall_run(self, **kwargs):  # pylint: disable=unused-argument; applies only to this line
-        """Tells if simulations should be run again based on the existence of output files."""
-        return not self._file_simtel.exists()
-
-    def _make_run_command(self, **kwargs):  # pylint: disable=unused-argument
-        """
-        Prepare the command used to run testeff
-        """
+            self._nsb_spectrum = (
+                self._telescope_model.config_file_directory
+                / Path(self._telescope_model.get_parameter_value("nsb_reference_spectrum")).name
+            )
 
+    def _make_run_command(
+        self, run_number=None, input_file=None
+    ):  # pylint: disable=unused-argument
+        """Prepare the command used to run testeff."""
         self._logger.debug("Preparing the command to run testeff")
 
         # Processing camera pixel features
@@ -81,20 +84,21 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
         pixel_diameter = self._telescope_model.camera.get_pixel_diameter()
 
         # Processing focal length
-        focal_length = self._telescope_model.get_parameter_value_with_unit("effective_focal_length")
-        if focal_length == 0.0:
-            self._logger.warning("Using focal_length because effective_focal_length is 0")
-            focal_length = self._telescope_model.get_parameter_value_with_unit("focal_length")
+        focal_length = self._telescope_model.get_telescope_effective_focal_length("m", True)
 
         # Processing mirror class
         mirror_class = 1
-        if self._telescope_model.has_parameter("mirror_class"):
+        try:
             mirror_class = self._telescope_model.get_parameter_value("mirror_class")
+        except InvalidModelParameterError:
+            pass
 
         # Processing camera transmission
         camera_transmission = 1
-        if self._telescope_model.has_parameter("camera_transmission"):
+        try:
             camera_transmission = self._telescope_model.get_parameter_value("camera_transmission")
+        except KeyError:
+            pass
 
         # Processing camera filter
         # A special case is testeff does not support 2D distributions
@@ -117,21 +121,26 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
                 "mirror_reflectivity", "secondary_mirror_incidence_angle"
             )
 
-        command = str(self._simtel_source_path.joinpath("sim_telarray/bin/testeff"))
+        command = str(self._simtel_path.joinpath("sim_telarray/testeff"))
+        if self.skip_correction_to_nsb_spectrum:
+            command += " -nc"  # Do not apply correction to original altitude where B&E was derived
+        command += " -I"  # Clear the fall-back configuration directories
+        command += f" -I{self._telescope_model.config_file_directory}"
         if self.nsb_spectrum is not None:
             command += f" -fnsb {self.nsb_spectrum}"
         command += " -nm -nsb-extra"
-        command += f" -alt {self._telescope_model.get_parameter_value('altitude')}"
+        command += f" -alt {self._telescope_model.get_parameter_value('corsika_observation_level')}"
         command += f" -fatm {self._telescope_model.get_parameter_value('atmospheric_transmission')}"
-        command += f" -flen {focal_length.to('m').value}"
+        command += f" -flen {focal_length}"
         command += f" {pixel_shape_cmd} {pixel_diameter}"
-        if mirror_class == 1:
+        if mirror_class == 0:
             command += f" -fmir {self._telescope_model.get_parameter_value('mirror_list')}"
         command += f" -fref {mirror_reflectivity}"
         if mirror_class == 2:
             command += " -m2"
             command += f" -fref2 {mirror_reflectivity_secondary}"
-        command += f" -teltrans {self._telescope_model.get_telescope_transmission_parameters()[0]}"
+        command += " -teltrans "
+        command += f"{self._telescope_model.get_parameter_value('telescope_transmission')[0]}"
         command += f" -camtrans {camera_transmission}"
         command += f" -fflt {camera_filter_file}"
         command += (
@@ -142,18 +151,16 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
         )
         command += f" -fqe {self._telescope_model.get_parameter_value('quantum_efficiency')}"
         command += " 200 1000"  # lmin and lmax
-        command += " 300 26"  # Xmax, ioatm (Konrad always uses 26)
+        command += " 300"  # Xmax
+        command += f" {self._telescope_model.get_parameter_value('atmospheric_profile')}"
         command += f" {self.zenith_angle}"
         command += f" 2>{self._file_log}"
         command += f" >{self._file_simtel}"
 
-        # Moving to sim_telarray directory before running
-        command = f"cd {self._simtel_source_path.joinpath('sim_telarray')} && {command}"
+        return f"cd {self._simtel_path.joinpath('sim_telarray')} && {command}"
 
-        return command
-
-    def _check_run_result(self, **kwargs):  # pylint: disable=unused-argument
-        """Checking run results
+    def _check_run_result(self, run_number=None):  # pylint: disable=unused-argument
+        """Check run results.
 
         Raises
         ------
@@ -171,10 +178,18 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
     def _get_one_dim_distribution(self, two_dim_parameter, weighting_distribution_parameter):
         """
         Calculate an average one-dimensional curve for testeff from the two-dimensional curve.
+
         The two-dimensional distribution is provided in two_dim_parameter. The distribution
         of weights to use for averaging the two-dimensional distribution is given in
         weighting_distribution_parameter.
 
+        Parameters
+        ----------
+        two_dim_parameter: str
+            The name of the two-dimensional distribution parameter.
+        weighting_distribution_parameter: str
+            The name of the parameter with the distribution of weights.
+
         Returns
         -------
         one_dim_file: Path
@@ -203,27 +218,36 @@ class SimtelRunnerCameraEfficiency(SimtelRunner):
         new_file_name = (
             f"weighted_average_1D_{self._telescope_model.get_parameter_value(two_dim_parameter)}"
         )
-        one_dim_file = self._telescope_model.export_table_to_model_directory(
+        return self._telescope_model.export_table_to_model_directory(
             new_file_name, distribution_to_export
         )
 
-        return one_dim_file
-
     def _validate_or_fix_nsb_spectrum_file_format(self, nsb_spectrum_file):
         """
         Validate or fix the nsb spectrum file format.
+
         The nsb spectrum file format required by sim_telarray has three columns:
-            wavelength (nm), ignored, NSB flux [1e9 * ph/m2/s/sr/nm],
+        wavelength (nm), ignored, NSB flux [1e9 * ph/m2/s/sr/nm],
         where the second column is ignored by sim_telarray and the third is used for the NSB flux.
         This function makes sure the file has at least three columns,
         by copying the second column to the third.
-        """
 
+        Parameters
+        ----------
+        nsb_spectrum_file: str or Path
+            The path to the nsb spectrum file.
+
+        Returns
+        -------
+        validated_nsb_spectrum_file: Path
+            The path to the validated nsb spectrum file.
+        """
         validated_nsb_spectrum_file = (
-            self._telescope_model.get_config_directory() / Path(nsb_spectrum_file).name
+            self._telescope_model.config_file_directory / Path(nsb_spectrum_file).name
         )
-        with open(nsb_spectrum_file, "r", encoding="utf-8") as file:
-            lines = file.readlines()
+
+        lines = general.read_file_encoded_in_utf_or_latin(nsb_spectrum_file)
+
         with open(validated_nsb_spectrum_file, "w", encoding="utf-8") as file:
             for line in lines:
                 if line.startswith("#"):