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

simtools/schemas/model_parameters/quantum_efficiency.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for quantum_efficiency 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
+developer_note: To be replaced by a data table
+name: quantum_efficiency
+description: |-
+  Quantum or photon detection efficiency
+  averaged over all pixels per camera.
+  Random pixel-to-pixel variations are calculated using
+  the qe_variation parameter. Pixel-to-pixel differences
+  in detection efficiency using scaling factors can be
+  specified in the camera_config_file.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_qe.dat'
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraChargeResponse
+    - ValidateCameraGainsAndEfficiency
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/random_focal_length.schema.yml

@@ -0,0 +1,45 @@
+%YAML 1.2
+---
+title: Schema for random_focal_length 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: random_focal_length
+developer_note: Note - Description changed significantly in the sim_telarray manual
+  - Note
+description: |-
+  The spread of random fluctuations in mirror panel focal lengths.
+  These parameters get only applied if the focal lengths in the mirror list
+  file (par:mirror_list) are zero (automatic) or negative (individual with
+  error). For positive focal lengths in that list (definite values) the
+  random focal length value does not get applied.
+short_description: The spread of random fluctuations in mirror focal lengths.
+data:
+  - type: double
+    description: Width (r.m.s.) of Gaussian distribution for random focal lengths.
+    unit: cm
+    default: 7.4
+    condition: mirror_class==1
+  - type: double
+    description: Width of top-hat distribution for random focal lengths.
+    unit: cm
+    default: 0.0
+    condition: mirror_class==1
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateMirrorPanelParameters
+    - ValidateOpticalPSF
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/random_generator.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for random_generator 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: random_generator
+short_description: Random generator used.
+description: |-
+  Random generator used. Unless compiled with -DWITH_GSL_RNG the only valid
+  and known generator is "Ranlux". When using the GNU Scientific Library for
+  random number generators, this can be "Ranlux", "mt19937", "taus", "Ranlxd2",
+  or "GSL:" plus the name of any other GSL-based generator, or "GSL_RNG_TYPE"
+  to obtain the generator from the environment variable of that name.
+data:
+  - type: string
+    default: "Ranlux"
+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/reference_point_altitude.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for reference_point_altitude 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: reference_point_altitude
+description: |-
+  Altitude above sea level of site reference point.
+  This location is typically identical or close to the site center.
+short_description: Altitude above sea level of site reference point.
+data:
+  - type: double
+    unit: m
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/reference_point_latitude.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for reference_point_latitude 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: reference_point_latitude
+description: |-
+  Latitude coincident with site reference point.
+  Not to be used for coordinate transformations (use UTM coordinates for this).
+short_description: Latitude of site reference point.
+data:
+  - type: double
+    unit: deg
+    allowed_range:
+      min: -90.0
+      max: 90.0
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/reference_point_longitude.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for reference_point_longitude 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: reference_point_longitude
+description: |-
+  Longitude coincident with site reference point.
+  Not to be used for coordinate transformations (use UTM coordinates for this).
+short_description: Longitude of site reference point.
+data:
+  - type: double
+    unit: deg
+    allowed_range:
+      min: -180.0
+      max: 180.0
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/reference_point_utm_east.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for reference_point_utm_east 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: reference_point_utm_east
+description: |-
+  UTM east of site reference point.
+  Telescope x,y positions are calculated relative to this
+  position.
+short_description: UTM east of site reference point.
+data:
+  - type: double
+    unit: m
+    allowed_range:
+      min: 0.
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup

simtools/schemas/model_parameters/reference_point_utm_north.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for reference_point_utm_north 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: reference_point_utm_north
+description: |-
+  UTM north of site reference point.
+  Telescope x,y positions are calculated relative to this
+  position.
+short_description: UTM north of site reference point.
+data:
+  - type: double
+    unit: m
+    allowed_range:
+      min: 0.
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup

simtools/schemas/model_parameters/sampled_output.schema.yml

@@ -0,0 +1,31 @@
+%YAML 1.2
+---
+title: Schema for sampled_output 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: sampled_output
+description: |-
+  Select a specific output format (if several available). A value of 0 means to write ADC sums, a value of 1 to write ADC samples.
+data:
+  - type: boolean
+    default: true
+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/save_pe_with_amplitude.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for save_pe_with_amplitude 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: save_pe_with_amplitude
+description: |-
+  True if photo-electron data is to be stored with the resulting amplitudes (in mean-p.e. units) in addition to the arrival times.
+  Storing of photo-electron data should be activated separately (see save_photons (bit 1) and store_photoelectrons parameters)
+  but non-zero values of this parameter will also activate save_photons bit 1.
+  Storing p.e. in internal calibration events is controlled separately by save_calibration_pe.
+data:
+  - type: boolean
+    default: false
+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/secondary_mirror_baffle.schema.yml

@@ -0,0 +1,79 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_baffle 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: secondary_mirror_baffle
+description: |-
+  Defines a baffle around the secondary mirror to keep NSB light from
+  falling directly onto the camera. Shadowing by the baffle is applied
+  both to incoming photons and to photons reflected from the primary
+  to the secondary mirror. Absence of a baffle is indicated by $r_1=0$.
+short_description: |-
+  Defines a baffle around the secondary mirror to keep NSB light from
+  falling directly onto the camera.
+data:
+  - name: baffle_z1
+    description: |-
+      Beginning of the baffle along the optical axis, counted from the
+      primary center, which means a z value of par:secondary_ref_radius
+      times the first par:secondary_mirror_parameters value is at the
+      height of the center of the secondary.
+    type: double
+    unit: cm
+    required: true
+    condition: mirror_class==2
+    default: 0.
+  - name: baffle_z2
+    description: |-
+      End of the baffle along the optical axis, counted from the
+      primary center, which means a z value of par:secondary_ref_radius
+      times the first par:secondary_mirror_parameters value is at the
+      height of the center of the secondary.
+    type: double
+    unit: cm
+    required: true
+    condition: mirror_class==2
+    default: 0.
+  - name: radius_r1
+    description: Radius of open cylinder shape or cone shape at baffle_z1.
+    type: double
+    unit: cm
+    required: true
+    condition: mirror_class==2
+    default: 0.
+  - name: thickness_d1
+    description: |-
+      Wall thickness of the baffle. The radius radius_r1 and radius_r2
+      are the inner radii in case of finite wall thickness.
+    type: double
+    unit: cm
+    required: false
+    condition: mirror_class==2
+    default: 0.
+  - name: radius_r2
+    description: Radius of open cylinder shape or cone shape at baffle_z2.
+    type: double
+    unit: cm
+    required: false
+    condition: mirror_class==2
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateTelescopeEfficiency
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: secondary_baffle

simtools/schemas/model_parameters/secondary_mirror_degraded_map.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_degraded_map 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
+developer_note: |-
+  To be replaced by a data table. Accepted range is 0 to 1
+name: secondary_mirror_degraded_map
+description: |-
+  Position-dependent map of degradation factors for the secondary mirror.
+  This degradation gets applied on top of secondary_mirror_degraded_reflection.
+  Note that the impact of it on the nightsky background is not automatically
+  accounted for and must be evaluated separately and included in the
+  configured NSB pixel p.e. rates. It is recommended to use a map with an
+  average efficiency of 1.0 and use secondary_mirror_degraded_reflection
+  for the overall degradation.  Tables with equidistant spacing in both x and
+  y are highly recommended because the interpolation is faster.
+short_description: |-
+  Position-dependent map of degradation factors for the secondary mirror.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateTelescopeShadowing
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: secondary_degraded_map

simtools/schemas/model_parameters/secondary_mirror_degraded_reflection.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_degraded_reflection 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: secondary_mirror_degraded_reflection
+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
+  flat-fielding light source illuminating the camera via reflection on the
+  secondary).
+short_description: |-
+  Mirror degradation factor for the secondary mirror (wavelength independent).
+data:
+  - type: double
+    unit: dimensionless
+    default: 1.
+    allowed_range:
+      min: 0.
+      max: 1.
+    condition: mirror_class==2
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: mirror2_degraded_reflection

simtools/schemas/model_parameters/secondary_mirror_diameter.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_diameter 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: secondary_mirror_diameter
+description: |-
+  The outer diameter of the secondary reflector.
+  Used only in case mirror_list is not defined (i.e., mirror_list=none).
+data:
+  - name: secondary_mirror_diameter
+    type: double
+    unit: cm
+    condition: mirror_list==None&&mirror_class==2
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: secondary_diameter

simtools/schemas/model_parameters/secondary_mirror_hole_diameter.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_hole_diameter 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: secondary_mirror_hole_diameter
+description: |-
+  The diameter of any non-reflective part of the secondary mirror.
+  For the secondary, this should not be a hole.
+  With a segments defined, it effectively clips the inner edge of
+  the segments
+data:
+  - name: secondary_hole_diameter
+    description: Diameter of any non-reflective part of the secondary mirror.
+    type: double
+    default: 0.
+    unit: cm
+    condition: mirror_class==2
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: secondary_hole_diameter

simtools/schemas/model_parameters/secondary_mirror_incidence_angle.schema.yml

@@ -0,0 +1,29 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_incidence_angle 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
+developer_note: To be replaced by a data table
+name: secondary_mirror_incidence_angle
+description: |-
+  Distribution of incidence angle on the SST secondary mirror.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_file.dat'
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - SimPipe Derived
+simulation_software:
+  - name: simtools