#!/usr/bin/python3
r"""
Validate the optical model parameters through ray tracing simulations of the whole telescope.
A point-like light source is assumed. The output includes PSF (D80), \
effective mirror area and effective focal length as a function of the off-axis angle. \
The telescope zenith angle and the source distance can be set by command line arguments.
Examples of the plots generated by this application are shown below. On the top, the D80 \
vs off-axis is shown in cm (left) and deg (right). On the bottom, the effective mirror \
area (left) and the effective focal length (right) vs off-axis angle are shown.
.. _validate_optics_plot:
.. image:: images/validate_optics_North-LST-1_d80_cm.png
:width: 49 %
.. image:: images/validate_optics_North-LST-1_d80_deg.png
:width: 49 %
.. image:: images/validate_optics_North-LST-1_eff_area.png
:width: 49 %
.. image:: images/validate_optics_North-LST-1_eff_flen.png
:width: 49 %
Command line arguments
----------------------
site (str, required)
North or South.
telescope (str, required)
Telescope model name (e.g. LST-1, SST-D, ...).
model_version (str, optional)
Model version.
src_distance (float, optional)
Source distance in km.
zenith (float, optional)
Zenith angle in deg.
max_offset (float, optional)
Maximum offset angle in deg.
offset_steps (float, optional)
Offset angle step size.
plot_images (activation mode, optional)
Produce a multiple pages pdf file with the image plots.
test (activation mode, optional)
If activated, application will be faster by simulating fewer photons.
Example
-------
LST-1 5.0.0
.. code-block:: console
simtools-validate-optics --site North --telescope LST-1 --max_offset 1.0 \\
--zenith 20 --src_distance 10 --test
The output is saved in simtools-output/validate_optics
Expected final print-out message:
.. code-block:: console
INFO::ray_tracing(l434)::plot::Plotting eff_area vs off-axis angle
INFO::ray_tracing(l434)::plot::Plotting eff_flen vs off-axis angle
"""
from pathlib import Path
import astropy.units as u
import matplotlib.pyplot as plt
import numpy as np
from matplotlib.backends.backend_pdf import PdfPages
from simtools.application_control import get_application_label, startup_application
from simtools.configuration import configurator
from simtools.model.model_utils import initialize_simulation_models
from simtools.ray_tracing.ray_tracing import RayTracing
from simtools.visualization import visualize
def _parse():
"""Parse command line configuration."""
config = configurator.Configurator(
label=get_application_label(__file__),
description=(
"Calculate and plot the PSF and effective mirror area as a function of off-axis angle "
"of the telescope requested."
),
)
config.parser.add_argument(
"--src_distance",
help="Source distance in km",
type=float,
default=10,
)
config.parser.add_argument("--zenith", help="Zenith angle in deg", type=float, default=20)
config.parser.add_argument(
"--max_offset",
help="Maximum offset angle in deg",
type=float,
default=4,
)
config.parser.add_argument(
"--offset_steps",
help="Offset angle step size",
type=float,
default=0.25,
)
config.parser.add_argument(
"--plot_images",
help="Produce a multiple pages pdf file with the image plots.",
action="store_true",
)
return config.initialize(db_config=True, simulation_model=["telescope", "model_version"])
[docs]
def main():
"""Validate the optical model parameters through ray tracing simulations."""
app_context = startup_application(_parse, setup_io_handler=True)
tel_model, site_model, _ = initialize_simulation_models(
label=Path(__file__).stem,
db_config=app_context.db_config,
site=app_context.args["site"],
telescope_name=app_context.args["telescope"],
model_version=app_context.args["model_version"],
)
######################################################################
# This is here as an example how to change parameters when necessary.
######################################################################
# pars_to_change = {
# 'mirror_focal_length': 1608.3,
# 'mirror_offset': -177.5,
# 'camera_body_diameter': 289.7,
# 'telescope_transmission': 1
# }
# tel_model.change_multiple_parameters(**pars_to_change)
app_context.logger.info(
f"\nValidating telescope optics with ray tracing simulations for {tel_model.name}\n"
)
ray = RayTracing(
telescope_model=tel_model,
site_model=site_model,
simtel_path=app_context.args["simtel_path"],
zenith_angle=app_context.args["zenith"] * u.deg,
source_distance=app_context.args["src_distance"] * u.km,
off_axis_angle=np.linspace(
0,
app_context.args["max_offset"],
int(app_context.args["max_offset"] / app_context.args["offset_steps"]) + 1,
)
* u.deg,
)
ray.simulate(test=app_context.args["test"], force=False)
ray.analyze(force=True)
# Plotting
for key in ["d80_deg", "d80_cm", "eff_area", "eff_flen"]:
plt.figure(figsize=(8, 6), tight_layout=True)
ray.plot(key, marker="o", linestyle=":", color="k")
plot_file_name = "_".join((app_context.args.get("label"), tel_model.name, key))
plot_file = app_context.io_handler.get_output_file(plot_file_name)
visualize.save_figure(plt, plot_file)
# Plotting images
if app_context.args["plot_images"]:
plot_file_name = "_".join((app_context.args.get("label"), tel_model.name, "images.pdf"))
plot_file = app_context.io_handler.get_output_file(plot_file_name)
pdf_pages = PdfPages(plot_file)
app_context.logger.info(f"Plotting images into {plot_file}")
for image in ray.images():
fig = plt.figure(figsize=(8, 6), tight_layout=True)
image.plot_image()
pdf_pages.savefig(fig)
plt.clf()
plt.close()
pdf_pages.close()
if __name__ == "__main__":
main()
