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

simtools/schemas/model_parameters/array_triggers.schema.yml

@@ -0,0 +1,93 @@
+%YAML 1.2
+---
+title: Schema for array_triggers 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: array_triggers
+description: |-
+  Array trigger definition. Includes specific coincidence gate
+  widths and telescope multiplicities.
+short_description: |-
+  Array trigger definition.
+data:
+  - type: dict
+    json_schema:
+      type: array
+      items:
+        type: object
+        properties:
+          name:
+            type: string
+            format: array_trigger_name
+            description: |-
+              Name of the trigger
+              (combination of telescope type and 'array' or 'single_telescope').
+          multiplicity:
+            type: object
+            description: |-
+              Minimum number of telescopes required to trigger.
+            properties:
+              value:
+                type: integer
+                minimum: 0
+              unit:
+                type: "null"
+            required: [value]
+          width:
+            type: object
+            description: |-
+              Width of the trigger time window for stereo triggers.
+            properties:
+              value:
+                type: number
+                minimum: 0.
+              unit:
+                anyOf:
+                  - type: string
+                    format: astropy_unit_of_time
+            required: [value, unit]
+          hard_stereo:
+            type: object
+            description: |-
+              Readout requires stereo condition to be met
+              (even if condition is met for other telescope types)
+            properties:
+              value:
+                type: boolean
+              unit:
+                type: "null"
+            required: [value]
+          min_separation:
+            type: object
+            description: |-
+              Minimum separation between telescopes in the ground system to be
+              considered for stereo trigger.
+            properties:
+              value:
+                anyOf:
+                  - type: number
+                  - type: "null"
+              unit:
+                type: string
+                format: astropy_unit_of_length
+            required: [value, unit]
+        required: [name, multiplicity, width, hard_stereo, min_separation]
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeSimulationModel
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/asum_clipping.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for asum_clipping 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: asum_clipping
+description: |-
+  The amplitude level at which the signal from each pixel
+  (after optional shaping) is clipped for its contribution
+  to the analog sum trigger.
+data:
+  - type: double
+    default: 0.0
+    unit: mV
+    allowed_range:
+      min: 0.0
+    condition: default_trigger==AnalogSum
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/asum_offset.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for asum_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: asum_offset
+description: Offset in time where shaping convolution is done.
+data:
+  - type: double
+    default: 0.0
+    unit: ns
+    allowed_range:
+      min: 0.0
+    condition: default_trigger==AnalogSum
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/asum_shaping.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for asum_shaping 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: asum_shaping
+description: |-
+  Shaping (convolution) parameters for an input photo detector signal to the
+  resulting signal from which an analog-sum trigger decision may be derived.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: asum_shaping_file

simtools/schemas/model_parameters/asum_threshold.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for asum_threshold 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: asum_threshold
+description: |-
+  The amplitude level above which an analog sum leads to a telescope
+  trigger.
+data:
+  - type: double
+    default: 0.0
+    unit: mV
+    allowed_range:
+      min: 0.0
+    condition: default_trigger==AnalogSum
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTriggerThresholdsFromRateScan
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/atmospheric_profile.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for atmospheric_profile 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: atmospheric_profile
+description: Density, thickness, and index of refraction as function of altitude.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateAtmosphericModel
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/atmospheric_transmission.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for atmospheric_transmission 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: atmospheric_transmission
+description: |-
+  Optical thickness as a function of photon emission altitude
+  and wavelength.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'atm_trans_2147_1_10_2_0_2147.dat'
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateAtmosphericModel
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: corsika
+  - name: sim_telarray

simtools/schemas/model_parameters/axes_offsets.schema.yml

@@ -0,0 +1,53 @@
+%YAML 1.2
+---
+title: Schema for axes_offsets 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: axes_offsets
+description: |-
+  Geometric offsets to be used in case that the azimuth, altitude, and
+  optical axes do not intersect at the reference point (the center of
+  the fiducial sphere in CORSIKA simulations). If both
+  values are non-zero but equal, the optical axis coincides with the
+  azimuth axis for vertical pointing.
+short_description: |-
+  Geometric offsets to be used in case that the azimuth, altitude,
+  and optical axes do not intersect at the reference point.
+data:
+  - type: double
+    unit: cm
+    default: 0.
+    description: |-
+      Horizontal offset between the (vertical) azimuth axis and the
+      (horizontal) altitude rotation axis. A positive value corresponds
+      to an altitude axis towards the reflector. Altitude axis is on
+      the optical axis, if the second parameter is zero.
+  - type: double
+    unit: cm
+    default: 0.
+    description: |-
+      Displacement perpendicular to the optical axis and the altitude
+      axis of the altitude rotation axis w.r.t to the reflector.
+      If the altitude axis is on the optical axis, the second parameter
+      is zero.
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_body_diameter.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for camera_body_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: camera_body_diameter
+description: |-
+  Diameter of camera body (used to account for effects of shadowing).
+  Flat-to-flat for square and hexagonal shapes.
+data:
+  - type: double
+    unit: cm
+    default: 160.0
+    allowed_range:
+      min: 0.0
+      max: 1000.0
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeShadowingParameters
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeShadowing
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_body_shape.schema.yml

@@ -0,0 +1,45 @@
+%YAML 1.2
+---
+title: Schema for camera_body_shape 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: camera_body_shape
+description: |-
+  Code for the shape of the camera,
+  \begin{itemize}
+  \item[$\circ$] 0 -- circular (default);
+  \item[$\circ$] 1 or 3 -- hexagonal;
+  \item[$\circ$] 2 -- square.
+  \end{itemize}
+  This shape is used only for the estimation of the shadowing.
+short_description: Camera body shape parameter (used to account for effects of shadowing).
+data:
+  - type: uint
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+      max: 3
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeShadowingParameters
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_config_file.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for camera_config_file 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: camera_config_file
+description: |-
+  Definition of pixel types, positions, status (on/off), relative gain
+  (w.r.t the provided gain) and quantum/photodetector efficiency
+  scaling (scale the provided quantum/photodetector efficiency distribution,
+  ignoring wavelength dependence).
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateCameraGeometry
+    - ValidatePixelStatus
+    - ValidateCameraGainsAndEfficiency
+source:
+  - Initial instrument setup
+  - Calibration
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_config_rotate.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for camera_config_rotate 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: camera_config_rotate
+developer_note: Part of sim_telarray camera_config_file (parameter Rotate).
+description: |-
+  Camera rotation angle, rotating the whole camera with all the pixels by
+  the given angle.
+short_description: Camera rotation angle.
+data:
+  - type: double
+    unit: deg
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraGeometry
+source:
+  - Initial instrument setup
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_degraded_efficiency.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for camera_degraded_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
+name: camera_degraded_efficiency
+description: |-
+  Camera efficiency degradation factor (wavelength independent).
+  What matters typically is the overall product of the efficiencies.
+  Breaking it down into mirror(s) and/or camera degradation
+  only matters where BYPASS_OPTICS becomes involved. Then this parameter
+  is still applied to the camera efficiency.
+short_description: |-
+  Camera efficiency degradation factor (wavelength independent).
+data:
+  - type: double
+    unit: dimensionless
+    default: 1.
+    allowed_range:
+      min: 0.
+      max: 1.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_degraded_map.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for camera_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: camera_degraded_map
+description: |-
+  Position-dependent map of degradation factors for the camera efficiency.
+  The degradation gets applied on top of camera_degraded_efficiency and
+  is not accounted for in the NSB pixel p.e. rate calculations
+  (and in particular not for a localized NSB reduction).
+  Tables with equidistant spacing in both x and y are highly recommended.
+short_description: |-
+  Position-dependent map of degradation factors for the camera efficiency.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_depth.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for camera_depth 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: camera_depth
+description: |-
+  Depth of a camera body, used for shadowing.
+  If non-zero, shadowing is checked both at the height of the camera front
+  and the camera depth.
+short_description: Depth of the camera body (used to account for effects of shadowing).
+data:
+  - type: double
+    unit: cm
+    default: 0.
+    allowed_range:
+      min: 0.0
+      max: 1000.0
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeShadowingParameters
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeShadowing
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray