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

simtools/schemas/model_parameters/laser_external_trigger.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for laser_external_trigger model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_external_trigger
+description: |-
+  A laser/LED flatfielding unit would typically operate at a sufficient illumination \
+  that the camera can trigger by itself. If operated at low illumination \
+  (e.g. a single-p.e. calibration unit outside of the camera), then an external trigger is needed.
+short_description: |-
+  Use external trigger for calibration.
+data:
+  - type: int
+    default: 0
+    allowed_range:
+      min: 0
+      max: 1
+
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_photons.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for laser_photons model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_photons
+description: |-
+  Number of laser photons at each photodetector.
+short_description: |-
+  Number of laser photons at each photodetector.
+data:
+  - type: double
+    unit: dimensionless
+    default: 500
+    allowed_range:
+      min: 1
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_pulse_exptime.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for laser_pulse_exptime model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_pulse_exptime
+description: |-
+  To be used (non-zero) if the pulse shape of the light emitted from the flat-fielding \
+  or single-p.e. calibration unit follows an exponential, e.g. as used in early HESS calibration \
+  units with a UV laser illuminating a scintillator and exciting it to emit light with a decay time of 2.5 ns.
+short_description: |-
+  Exponentially decaying pulse shape time.
+data:
+  - type: double
+    unit: "ns"
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_pulse_offset.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for laser_pulse_offset model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_pulse_offset
+description: |-
+  The flat-fielding and single-p.e. calibration units are assumed to operate with an external trigger.\
+  Thus the position of the signal in the read-out window can be shifted \
+  (negative number: earlier, positive numbers: later).
+short_description: |-
+  Shift position of the signal in the read-out window.
+data:
+  - type: double
+    unit: "ns"
+    default: 0.0
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_pulse_sigtime.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for laser_pulse_sigtime model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_pulse_sigtime
+description: |-
+  To be used (non-zero) if the pulse shape of the light emitted from the flat-fielding \
+  or single-p.e. calibration unit follows a Gaussian, with the given number standing for the sigma of the Gaussian.
+short_description: |-
+  Gaussian pulse time width.
+data:
+  - type: double
+    unit: "ns"
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_pulse_twidth.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for laser_pulse_twidth model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_pulse_twidth
+description: |-
+  To be used (non-zero) if the pulse shape of the light emitted from the flat-fielding \
+  or single-p.e. calibration unit follows a top-hat (Heavyside) function, with the given number standing for the full width.
+short_description: |-
+  Top-Hat pulse time full-width.
+data:
+  - type: double
+    unit: "ns"
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_var_photons.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for laser_var_photons model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_var_photons
+description: |-
+  Relative variation of laser shots from shot to shot, independent for each telescope.
+short_description: |-
+  Relative variation of laser shots from shot to shot.
+data:
+  - type: double
+    unit: dimensionless
+    default: 0.05
+    allowed_range:
+      min: 0
+      max: 1
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/laser_wavelength.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for laser_wavelength model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: laser_wavelength
+description: |-
+  The wavelength of the light emitted from the flat-fielding \
+  or single-p.e. calibration unit. Applies to both laser and LED type events.
+short_description: |-
+  Wavelength of light-source.
+data:
+  - type: double
+    unit: "nm"
+    default: 400
+    allowed_range:
+      min: 200
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/led_events.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for led_events model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: led_events
+description: |-
+  If greater than zero than additional calibration-type events are simulated before \
+  the first shower events, assuming an independent LED in front of each pixel, \
+  taking this type of data with closed lid, i.e. without NSB.
+short_description: |-
+  Additional calibration-type events.
+data:
+  - type: int
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/led_photons.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for led_photons model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: led_photons
+description: |-
+  The intensity of LEDs assumed to sit in the camera lid in front of each pixel \
+  (like originally HESS CT3) when simulating extra calibration-type events (with LED_EVENTS greater than zero).\
+  Typically this would be single-p.e. calibration events without NSB background.
+short_description: |-
+  LED intensity in the camera lid in front of each pixel.
+data:
+  - type: double
+    unit: dimensionless
+    default: 4.0
+    allowed_range:
+      min: 0.05
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/led_pulse_offset.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for led_pulse_offset model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: led_pulse_offset
+description: |-
+  The flat-fielding and single-p.e. calibration units are assumed to operate with an external trigger.\
+  Thus the position of the signal in the read-out window can be shifted \
+  (negative number: earlier, positive numbers: later).
+short_description: |-
+  Shift position of the signal in the read-out window.
+data:
+  - type: double
+    unit: "ns"
+    default: 0.0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/led_pulse_sigtime.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for led_pulse_sigtime model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: led_pulse_sigtime
+description: |-
+  To be used (non-zero) if the pulse shape of the light emitted from the flat-fielding \
+  or single-p.e. calibration unit follows a Gaussian, with the given number standing for the sigma of the Gaussian.
+short_description: |-
+  Gaussian sigma LED pulse width.
+data:
+  - type: double
+    unit: "ns"
+    default: 0.0
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/led_var_photons.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for led_var_photons model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: led_var_photons
+description: |-
+  Variation of the average amplitude of the LEDs in front of each pixel,\
+  from pixel to pixel (not including the statistical event-to-event fluctuation).
+short_description: |-
+  Average amplitude variation of LED in front of each pixel.
+data:
+  - type: double
+    unit: dimensionless
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 1.0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/lightguide_efficiency_vs_incidence_angle.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for lightguide_efficiency_vs_incidence_angle model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/data.metaschema.yml
+meta_schema_version: 0.1.0
+name: lightguide_efficiency_vs_incidence_angle
+developer_note: |-
+  Part of sim_telarray camera_config_file (parameter PixType).
+  To be replaced by a data table.
+description: |-
+  Lightguide efficiency as a function of incidence angle.
+  The wavelength dependence is averaged over, weighting by the
+  Cherenkov spectrum on the ground.
+short_description: Lightguide efficiency as a function of incidence angle.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetLightGuideEfficiency
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/lightguide_efficiency_vs_wavelength.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for lightguide_efficiency_vs_wavelength model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/data.metaschema.yml
+meta_schema_version: 0.1.0
+name: lightguide_efficiency_vs_wavelength
+developer_note: |-
+  The extra funnel efficiency table is interpreted such that
+  efficiency factors are not double-counted on top of that in
+  the angle-dependence table (normalized to yield no extra
+  correction for 400 nm wavelength at the expected average
+  incidence angle).
+  This is not interchangeable with the window filter transmission.
+  Part of sim_telarray camera_config_file (parameter PixType).
+  To be replaced by a data table.
+description: Lightguide efficiency for on-axis photons vs wavelength.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetLightGuideEfficiency
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/min_photoelectrons.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for min_photoelectrons model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: min_photoelectrons
+short_description: |-
+  Minimum number of detected photoelectrons required before running electronics simulation.
+description: |-
+  Minimum number of detected photoelectrons required in a camera before running the
+  more CPU-intense electronics simulation.
+data:
+  - type: int
+    unit: dimensionless
+    default: -1
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/min_photons.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for min_photons model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: min_photons
+description: |-
+  Minimum number of photons required before doing simulation.
+data:
+  - type: double
+    unit: dimensionless
+    default: -1
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_align_random_distance.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for mirror_align_random_distance model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: mirror_align_random_distance
+description: |-
+  Gaussian r.m.s. spread of random fluctuations in the aligned mirror
+  distance from the focus.
+data:
+  - type: double
+    unit: cm
+    default: 2.0
+    condition: mirror_class==1
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetMirrorPanelAlignment
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateOpticalPSF
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+  - SimPipe Derived
+simulation_software:
+  - name: sim_telarray