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

simtools/applications/validate_camera_efficiency.py

@@ -1,10 +1,7 @@
 #!/usr/bin/python3
 
-"""
-    Summary
-    -------
-    This application validate the camera efficiency by simulating it using \
-    the testeff program provided by sim_telarray.
+r"""
+    Validate the camera efficiency by simulating it using the sim_telarray testeff program.
 
     The results of camera efficiency for Cherenkov (left) and NSB light (right) as a function\
     of wavelength are plotted. See examples below.
@@ -20,47 +17,30 @@
     site (str, required)
         North or South.
     telescope (str, required)
-        Telescope model name (e.g. LST-1, SST-D, ...)
+        Telescope model name (e.g. LSTN-01, SSTS-15)
     model_version (str, optional)
-        Model version (default='Released')
+        Model version
     zenith_angle (float, optional)
         Zenith angle in degrees (between 0 and 180).
     azimuth_angle (float, optional)
-        Telescope pointing direction in azimuth. It can be in degrees between 0 and 360 or
-        one of north, south, east or west (case insensitive). Note that North is 0 degrees
-        and the azimuth grows clockwise, so East is 90 degrees.
+        Telescope pointing direction in azimuth.
     nsb_spectrum (str, optional)
         File with NSB spectrum to use for the efficiency simulation.
-        The expected format is two columns with wavelength in nm and
-        NSB flux with the units: [1e9 * ph/m2/s/sr/nm].
-        If the file has more than two columns, the first and third are used,
-        and the second is ignored (native sim_telarray behaviour).
-    verbosity (str, optional)
-        Log level to print
 
     Example
     -------
-    MST-NectarCam - Prod5
+    MSTN-01 5.0.0
 
     Runtime < 1 min.
 
     .. code-block:: console
 
-        simtools-validate-camera-efficiency --site North \
-            --azimuth_angle 0 --zenith_angle 20 \
-            --nsb_spectrum average_nsb_spectrum_CTAO-N_ze20_az0.txt \
-            --telescope MST-NectarCam-D --model_version prod5
+        simtools-validate-camera-efficiency --site North \\
+            --azimuth_angle 0 --zenith_angle 20 \\
+            --nsb_spectrum average_nsb_spectrum_CTAO-N_ze20_az0.txt \\
+            --telescope MSTN-01 --model_version 5.0.0
 
     The output is saved in simtools-output/validate_camera_efficiency.
-
-    Expected final print-out message:
-
-    .. code-block:: console
-
-        INFO::validate_camera_efficiency(l118)::main::Plotted NSB efficiency in /workdir/external/\
-        simtools/simtools-output/validate_camera_efficiency/application-plots/validate_camera\
-        _efficiency_MST-NectarCam-D_nsb
-
 """
 
 import logging
@@ -69,16 +49,10 @@ from pathlib import Path
 import simtools.utils.general as gen
 from simtools.camera_efficiency import CameraEfficiency
 from simtools.configuration import configurator
-from simtools.configuration.commandline_parser import CommandLineParser
-from simtools.io_operations import io_handler
-from simtools.model.telescope_model import TelescopeModel
 
 
 def _parse(label):
-    """
-    Parse command line configuration
-
-    """
+    """Parse command line configuration."""
     config = configurator.Configurator(
         label=label,
         description=(
@@ -86,25 +60,6 @@ def _parse(label):
             "Plot the camera efficiency vs wavelength for cherenkov and NSB light."
         ),
     )
-    config.parser.add_argument(
-        "--azimuth_angle",
-        help=(
-            "Telescope pointing direction in azimuth. "
-            "It can be in degrees between 0 and 360 or one of north, south, east or west "
-            "(case insensitive). Note that North is 0 degrees and "
-            "the azimuth grows clockwise, so East is 90 degrees."
-        ),
-        type=CommandLineParser.azimuth_angle,
-        default=0,
-        required=False,
-    )
-    config.parser.add_argument(
-        "--zenith_angle",
-        help="Zenith angle in degrees (between 0 and 180).",
-        type=CommandLineParser.zenith_angle,
-        default=20,
-        required=False,
-    )
     config.parser.add_argument(
         "--nsb_spectrum",
         help=(
@@ -112,13 +67,28 @@ def _parse(label):
             "The expected format is two columns with wavelength in nm and "
             "NSB flux with the units: [1e9 * ph/m2/s/sr/nm]."
             "If the file has more than two columns, the first and third are used,"
-            "and the second is ignored (native sim_telarray behaviour)."
+            "and the second is ignored (native sim_telarray behavior)."
         ),
         type=str,
         default=None,
         required=False,
     )
-    _args_dict, _db_config = config.initialize(db_config=True, telescope_model=True)
+    config.parser.add_argument(
+        "--skip_correction_to_nsb_spectrum",
+        help=(
+            "Apply a correction to the NSB spectrum to account for the "
+            "difference between the altitude used in the reference B&E spectrum and "
+            "the observation level at the CTAO sites."
+            "This correction is done internally in sim_telarray and is on by default."
+        ),
+        required=False,
+        action="store_true",
+    )
+    _args_dict, _db_config = config.initialize(
+        db_config=True,
+        simulation_model="telescope",
+        simulation_configuration={"corsika_configuration": ["zenith_angle", "azimuth_angle"]},
+    )
     if _args_dict["site"] is None or _args_dict["telescope"] is None:
         config.parser.print_help()
         print("\n\nSite and telescope must be provided\n\n")
@@ -126,60 +96,23 @@ def _parse(label):
     return _args_dict, _db_config
 
 
-def main():
+def main():  # noqa: D103
     label = Path(__file__).stem
     args_dict, _db_config = _parse(label)
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
-    # Output directory to save files related directly to this app
-    _io_handler = io_handler.IOHandler()
-    output_dir = _io_handler.get_output_directory(label, sub_dir="application-plots")
-
-    tel_model = TelescopeModel(
-        site=args_dict["site"],
-        telescope_model_name=args_dict["telescope"],
-        mongo_db_config=_db_config,
-        model_version=args_dict["model_version"],
-        label=label,
-    )
-
-    # For debugging purposes
-    tel_model.export_config_file()
-
-    logger.info(f"Validating the camera efficiency of {tel_model.name}")
-
     ce = CameraEfficiency(
-        telescope_model=tel_model,
-        simtel_source_path=args_dict["simtel_path"],
+        db_config=_db_config,
+        simtel_path=args_dict["simtel_path"],
         label=label,
-        config_data={
-            "zenith_angle": args_dict["zenith_angle"],
-            "azimuth_angle": args_dict["azimuth_angle"],
-            "nsb_spectrum": args_dict["nsb_spectrum"],
-        },
+        config_data=args_dict,
     )
-    ce.simulate(force=True)
+    ce.simulate()
     ce.analyze(force=True)
-
-    # Plotting the camera efficiency for Cherenkov light
-    fig = ce.plot_cherenkov_efficiency()
-    cherenkov_plot_file_name = label + "_" + tel_model.name + "_cherenkov"
-    cherenkov_plot_file = output_dir.joinpath(cherenkov_plot_file_name)
-    for f in ["pdf", "png"]:
-        fig.savefig(str(cherenkov_plot_file) + "." + f, format=f, bbox_inches="tight")
-    logger.info(f"Plotted cherenkov efficiency in {cherenkov_plot_file}")
-    fig.clf()
-
-    # Plotting the camera efficiency for NSB light
-    fig = ce.plot_nsb_efficiency()
-    nsb_plot_file_name = label + "_" + tel_model.name + "_nsb"
-    nsb_plot_file = output_dir.joinpath(nsb_plot_file_name)
-    for f in ["pdf", "png"]:
-        fig.savefig(str(nsb_plot_file) + "." + f, format=f, bbox_inches="tight")
-    logger.info(f"Plotted NSB efficiency in {nsb_plot_file}")
-    fig.clf()
+    ce.plot_efficiency(efficiency_type="Cherenkov", save_fig=True)
+    ce.plot_efficiency(efficiency_type="NSB", save_fig=True)
 
 
 if __name__ == "__main__":

simtools/applications/validate_camera_fov.py

@@ -1,10 +1,9 @@
 #!/usr/bin/python3
 
-"""
-    Summary
-    -------
-    This application calculate the camera FoV of the telescope requested and plot the camera \
-    as seen for an observer facing the camera.
+r"""
+    Calculate the camera FoV of the telescope requested and plot the camera.
+
+    The orientation for the plotting is "as seen for an observer facing the camera".
 
     An example of the camera plot can be found below.
 
@@ -28,17 +27,14 @@
         Up to which pixel ID to print. To suppress printing of pixel IDs, set to zero\
          (--print_pixels_id 0). To print all pixels, set to 'All'."
 
-    verbosity (str, optional)
-        Log level to print
-
     Example
     -------
-    LST - Prod5
+    LST - 5.0.0
 
     .. code-block:: console
 
-        simtools-validate-camera-fov --site North \
-            --telescope LST-1 --model_version prod5
+        simtools-validate-camera-fov --site North \\
+            --telescope LSTN-01 --model_version 5.0.0
 
     The output is saved in simtools-output/validate_camera_fov.
 
@@ -46,7 +42,7 @@
 
     .. code-block:: console
 
-        Saved camera plot in /workdir/external/simtools/simtools-output/validate_camera_fov\
+        Saved camera plot in /workdir/external/simtools/simtools-output/validate_camera_fov\\
         /application-plots/validate_camera_fov_LST-1_pixel_layout.png
 
 """
@@ -58,9 +54,10 @@ import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.io_operations import io_handler
 from simtools.model.telescope_model import TelescopeModel
+from simtools.visualization import plot_camera
 
 
-def main():
+def _parse():
     config = configurator.Configurator(
         label=Path(__file__).stem,
         description=(
@@ -72,7 +69,7 @@ def main():
         "--camera_in_sky_coor",
         help=(
             "Plot the camera layout in sky coordinates "
-            "(akin to looking at it from behind for single mirror telesecopes)"
+            "(akin to looking at it from behind for single mirror telescopes)"
         ),
         action="store_true",
         default=False,
@@ -86,8 +83,12 @@ def main():
         ),
         default=50,
     )
+    return config.initialize(db_config=True, simulation_model="telescope")
+
+
+def main():  # noqa: D103
+    args_dict, db_config = _parse()
 
-    args_dict, db_config = config.initialize(db_config=True, telescope_model=True)
     label = "validate_camera_fov"
 
     logger = logging.getLogger()
@@ -99,7 +100,7 @@ def main():
 
     tel_model = TelescopeModel(
         site=args_dict["site"],
-        telescope_model_name=args_dict["telescope"],
+        telescope_name=args_dict["telescope"],
         mongo_db_config=db_config,
         model_version=args_dict["model_version"],
         label=label,
@@ -108,7 +109,7 @@ def main():
 
     print(f"\nValidating the camera FoV of {tel_model.name}\n")
 
-    focal_length = float(tel_model.get_parameter_value("effective_focal_length"))
+    focal_length = tel_model.get_telescope_effective_focal_length("cm")
     camera = tel_model.camera
 
     fov, r_edge_avg = camera.calc_fov()
@@ -130,10 +131,10 @@ def main():
                 f"The value provided to --print_pixels_id ({args_dict['print_pixels_id']}) "
                 "should be an integer or All"
             ) from exc
-    fig = camera.plot_pixel_layout(args_dict["camera_in_sky_coor"], pixel_ids_to_print)
+    fig = plot_camera.plot_pixel_layout(camera, args_dict["camera_in_sky_coor"], pixel_ids_to_print)
     plot_file_prefix = output_dir.joinpath(f"{label}_{tel_model.name}_pixel_layout")
     for suffix in ["pdf", "png"]:
-        file_name = f"{str(plot_file_prefix)}.{suffix}"
+        file_name = f"{plot_file_prefix!s}.{suffix}"
         fig.savefig(file_name, format=suffix, bbox_inches="tight")
         print(f"\nSaved camera plot in {file_name}\n")
     fig.clf()

simtools/applications/{compare_cumulative_psf.py → validate_cumulative_psf.py}

@@ -1,9 +1,7 @@
 #!/usr/bin/python3
 
 """
-    Summary
-    -------
-    This application simulates the cumulative PSF and compare with data (if available).
+    Simulate the cumulative PSF and compare with data (if available).
 
     The telescope zenith angle and the source distance can be set by command line arguments.
 
@@ -17,10 +15,10 @@
     Examples of the plots generated by this applications are shown below. On the left, \
     the cumulative PSF and on the right, the simulated PSF image.
 
-    .. _compare_cumulative_psf_plot:
-    .. image::  images/compare_cumulative_psf_North-LST-1_cumulativePSF.png
+    .. _validate_cumulative_psf_plot:
+    .. image::  images/validate_cumulative_psf_North-LST-1_cumulativePSF.png
       :width: 49 %
-    .. image::  images/compare_cumulative_psf_North-LST-1_image.png
+    .. image::  images/validate_cumulative_psf_North-LST-1_image.png
       :width: 49 %
 
     Command line arguments
@@ -41,12 +39,10 @@
         Yaml file with the new model parameters to replace the default ones.
     test (activation mode, optional)
         If activated, application will be faster by simulating fewer photons.
-    verbosity (str, optional)
-        Log level to print.
 
     Example
     -------
-    LST-1 Prod5
+    LST-1 5.0.0
 
     Runtime < 1 min.
 
@@ -61,9 +57,9 @@
     .. code-block:: console
 
         simtools-compare-cumulative-psf --site North --telescope LST-1 \
-            --model_version prod5 --data PSFcurve_data_v2.txt
+            --model_version 5.0.0 --data PSFcurve_data_v2.txt
 
-    The output is saved in simtools-output/compare_cumulative_psf
+    The output is saved in simtools-output/validate_cumulative_psf
 
     Expected final print-out message:
 
@@ -80,31 +76,16 @@ from pathlib import Path
 import astropy.units as u
 import matplotlib.pyplot as plt
 import numpy as np
-import yaml
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.io_operations import io_handler
 from simtools.model.telescope_model import TelescopeModel
-from simtools.ray_tracing import RayTracing
+from simtools.ray_tracing.ray_tracing import RayTracing
 from simtools.visualization import visualize
 
 
-def load_data(datafile):
-    """
-    Load the data file with the measured PSF vs radius [cm].
-
-    """
-    d_type = {"names": ("Radius [cm]", "Relative intensity"), "formats": ("f8", "f8")}
-    # test_data_file = io.get_test_data_file('PSFcurve_data_v2.txt')
-    data = np.loadtxt(datafile, dtype=d_type, usecols=(0, 2))
-    data["Radius [cm]"] *= 0.1
-    data["Relative intensity"] /= np.max(np.abs(data["Relative intensity"]))
-    return data
-
-
-def main():
-    label = Path(__file__).stem
+def _parse(label):
     config = configurator.Configurator(
         label=label,
         description=(
@@ -118,15 +99,35 @@ def main():
         type=float,
         default=10,
     )
-    config.parser.add_argument("--zenith", help="Zenith angle in deg", type=float, default=20.0)
     config.parser.add_argument(
-        "--data", help="Data file name with the measured PSF vs radius [cm]", type=str
+        "--zenith",
+        help="Zenith angle in deg",
+        type=float,
+        default=20.0,
     )
     config.parser.add_argument(
-        "--mc_parameter_file", help="Yaml file with the model parameters to be replaced", type=str
+        "--data",
+        help="Data file name with the measured PSF vs radius [cm]",
+        type=str,
     )
+    return config.initialize(db_config=True, simulation_model="telescope")
+
+
+def load_data(datafile):
+    """Load the data file with the measured PSF vs radius [cm]."""
+    radius_cm = "Radius [cm]"
+    relative_intensity = "Relative intensity"
+
+    d_type = {"names": (radius_cm, relative_intensity), "formats": ("f8", "f8")}
+    data = np.loadtxt(datafile, dtype=d_type, usecols=(0, 2))
+    data[radius_cm] *= 0.1
+    data[relative_intensity] /= np.max(np.abs(data[relative_intensity]))
+    return data
 
-    args_dict, db_config = config.initialize(db_config=True, telescope_model=True)
+
+def main():  # noqa: D103
+    label = Path(__file__).stem
+    args_dict, db_config = _parse(label)
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
@@ -137,24 +138,20 @@ def main():
 
     tel_model = TelescopeModel(
         site=args_dict["site"],
-        telescope_model_name=args_dict["telescope"],
+        telescope_name=args_dict["telescope"],
         mongo_db_config=db_config,
         model_version=args_dict["model_version"],
         label=label,
     )
+    if args_dict.get("telescope_model_file"):
+        tel_model.change_multiple_parameters_from_file(args_dict["telescope_model_file"])
 
-    # New parameters
-    if args_dict.get("pars", None):
-        with open(args_dict["pars"], encoding="utf-8") as file:
-            new_pars = yaml.safe_load(file)
-        tel_model.change_multiple_parameters(**new_pars)
-
-    ray = RayTracing.from_kwargs(
+    ray = RayTracing(
         telescope_model=tel_model,
-        simtel_source_path=args_dict["simtel_path"],
-        source_distance=args_dict["src_distance"] * u.km,
+        simtel_path=args_dict["simtel_path"],
         zenith_angle=args_dict["zenith"] * u.deg,
-        off_axis_angle=[0.0 * u.deg],
+        source_distance=args_dict["src_distance"] * u.km,
+        off_axis_angle=[0.0] * u.deg,
     )
 
     ray.simulate(test=args_dict["test"], force=False)
@@ -168,13 +165,17 @@ def main():
     # Plotting cumulative PSF
     # Measured cumulative PSF
     data_to_plot = OrderedDict()
+    radius = None
     if args_dict.get("data", None):
         data_file = gen.find_file(args_dict["data"], args_dict["model_path"])
         data_to_plot["measured"] = load_data(data_file)
         radius = data_to_plot["measured"]["Radius [cm]"]
 
     # Simulated cumulative PSF
-    data_to_plot[r"sim$\_$telarray"] = im.get_cumulative_data(radius * u.cm)
+    if radius is not None:
+        data_to_plot[r"sim$\_$telarray"] = im.get_cumulative_data(radius * u.cm)
+    else:
+        raise ValueError("Radius data is not available. Cannot compute cumulative PSF.")
 
     fig = visualize.plot_1d(data_to_plot)
     fig.gca().set_ylim(0, 1.05)