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

simtools/schemas/model_parameters/mirror_align_random_horizontal.schema.yml

@@ -0,0 +1,64 @@
+%YAML 1.2
+---
+title: Schema for mirror_align_random_horizontal 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_horizontal
+description: |-
+  Fluctuations of the mirror alignment angle with respect to nominal
+  alignment in the horizontal component (in azimuth or y direction in
+  dish coordinates). The three terms are added up as independent
+  (i.e., by squares; therefore he square of the horizontal mirror
+  alignment error is $\sigma^2 = \sigma_0^2 + \sigma_c^2 + \sigma_s^2$).
+  The values here are usually derived from fits to the measured point
+  spread functions, with the single mirror point-spread function adapted
+  beforehand. Note that, since this affects the angles of the mirrors,
+  the impact on the combined spot size is twice as large.
+short_description: |-
+  Gaussian r.m.s. spread of random fluctuations of the mirror alignment
+  angle with respect to nominal alignment in the horizontal component.
+data:
+  - type: double
+    description: Constant value $\sigma_0$.
+    unit: deg
+    default: 0.0035
+  - type: double
+    description: Zenith angle $\theta_0$ at which minimum is reached.
+    unit: deg
+    default: 28.0
+  - type: double
+    description: |-
+      Scaling term $k_c$ in
+      $\sigma_c = (\cos(\theta)-\cos(\theta_0)) / k_c$.
+    unit: dimensionless
+    default: 0.023
+  - type: double
+    description: |-
+      Scaling term $k_s$ in
+      $\sigma_s = (\sin(\theta)-\sin(\theta_0)) / k_s$.
+    unit: dimensionless
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetMirrorPanelAlignment
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateOpticalPSF
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+  - SimPipe Derived
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_align_random_vertical.schema.yml

@@ -0,0 +1,64 @@
+%YAML 1.2
+---
+title: Schema for mirror_align_random_vertical 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_vertical
+description: |-
+  Fluctuations of the mirror alignment angle with respect to nominal
+  alignment in the vertical component (in altitude or $x$ direction in
+  dish coordinates). The three terms are added up as independent
+  (i.e., by squares; therefore he square of the vertical mirror
+  alignment error is $\sigma^2 = \sigma_0^2 + \sigma_c^2 + \sigma_s^2$).
+  The values here are usually derived from fits to the measured point
+  spread functions, with the single mirror point-spread function adapted
+  beforehand. Note that, since this affects the angles of the mirrors,
+  the impact on the combined spot size is twice as large.
+short_description: |-
+  Gaussian r.m.s. spread of random fluctuations of the mirror alignment
+  angle with respect to nominal alignment in the vertical component.
+data:
+  - type: double
+    description: Constant value $\sigma_0$.
+    unit: deg
+    default: 0.0034
+  - type: double
+    description: Zenith angle $\theta_0$ at which minimum is reached.
+    unit: deg
+    default: 28.0
+  - type: double
+    description: |-
+      Scaling term $k_c$ in
+      $\sigma_c = (\cos(\theta)-\cos(\theta_0)) / k_c$.
+    unit: dimensionless
+    default: 0.01
+  - type: double
+    description: |-
+      Scaling term $k_s$ in
+      $\sigma_s = (\sin(\theta)-\sin(\theta_0)) / k_s$.
+    unit: dimensionless
+    default: 0.0
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetMirrorPanelAlignment
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateOpticalPSF
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+  - SimPipe Derived
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_class.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for mirror_class 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_class
+description: |-
+  Parameter to control the type of mirror used.
+  Includes segmented primary mirror optics with spherical mirror tiles (0),
+  parabolic primary made of a single piece (1), and a a secondary mirror
+  optics (2), with primary and secondary each made of a single piece.
+  Class 3 represents a simple Fresnel lens implementation.
+short_description: Parameter to control the type of mirror used (DC, parabolic or
+  SC).
+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
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_degraded_reflection.schema.yml

@@ -0,0 +1,51 @@
+%YAML 1.2
+---
+title: Schema for 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: mirror_degraded_reflection
+description: |-
+  Mirror degradation factor (wavelength independent).
+  Applied to the mirror reflectivity of the primary mirror
+  (note also the primary, secondary, and camera efficiency
+  degradation factors).
+  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 actually interpreted as being for reflection on the primary mirror
+  (would not be relevant for a flat-fielding light source directly illuminating
+  the camera or illuminating it via reflection on the secondary mirror).
+  The nightsky background in each pixel is also scaled by the same factor
+  (even if the actual simulation bypasses optical ray-tracing).
+  For wavelength-dependent degradation, the tables for reflectivity,
+  window transmission, or light-cone efficiency need to be adapted.
+short_description: |-
+  Mirror degradation factor (wavelength independent).
+data:
+  - type: double
+    unit: dimensionless
+    default: 1.
+    allowed_range:
+      min: 0.
+      max: 1.
+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/mirror_focal_length.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for mirror_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: mirror_focal_length
+description: |-
+  Standard focal length of mirror tiles. This parameter is only used if
+  the focal lengths of the mirror tiles in the par:mirror_list
+  are zero. For a parabolic dish any non-zero value will then force
+  all mirror tiles to have the same focal lengths (which should then match
+  the average distance of the parabolic dish from the focus, not exactly
+  the overall focal length).
+short_description: Standard focal length of mirror tiles.
+data:
+  - type: double
+    unit: cm
+    default: 0.0
+    allowed_range:
+      min: 0.
+      max: 10000.0
+    condition: mirror_class==1
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateMirrorPanelParameters
+    - ValidateOpticalPSF
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_list.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for mirror_list 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: mirror_list
+description: List of mirror positions, diameters, focal lengths, and shape codes.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateMirrorPanelParameters
+    - ValidateOpticalPSF
+    - ValidateTelescopeStructure
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeShadowing
+    - ValidateTelescopeSimulationModel
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_offset.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for mirror_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: mirror_offset
+description: |-
+  Offset of mirror back plane from fixed point of telescope mount
+  (if axes intersect) or from the altitude rotation axis, along
+  the direction of the optical axis.  Positive if fixed point
+  (or altitude axis) is between the mirror back plane and the focus or,
+  in other words, the center of the primary mirror is behind/below
+  the altitude rotation axis.
+short_description: |-
+  Offset of mirror back plane from fixed point of telescope mount or
+  from the altitude rotation axis, along the direction of the optical axis.
+data:
+  - type: double
+    unit: cm
+    default: 130.0
+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/mirror_panel_2f_measurements.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for mirror panel 2F measurements
+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_panel_2f_measurement
+description: |-
+  Mirror panel 2F measurements determining
+  panel radius and panel PSF.
+data:
+  - type: data_table
+    table_columns:
+      - name: mirror_panel_id
+        description: |-
+          Mirror panel ID.
+        required: true
+        unit: dimensionless
+        type: string
+      - name: mirror_panel_radius
+        description: |-
+          Mirror panel radius.
+        required: true
+        unit: cm
+        type: double
+      - name: psf
+        description: |-
+          Spot size of mirror panel PSF at nominal distance.
+        required: true
+        unit: cm
+        type: double
+      - name: psf_opt
+        description: |-
+          Spot size of mirror panel PSF
+          (best value, not at nominal distance).
+        required: false
+        unit: cm
+        type: double

simtools/schemas/model_parameters/mirror_reflection_random_angle.schema.yml

@@ -0,0 +1,61 @@
+%YAML 1.2
+---
+title: Schema for mirror_reflection_random_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
+name: mirror_reflection_random_angle
+description: |-
+  Gaussian random fluctuations of reflection angles, due to
+  small-scale surface deviations, with one or two components.
+  For two components, the random reflection angle is applied
+  separately to each projection, in the coordinate system of the mirror
+  surface, with the same r.m.s. in both projections.
+short_description: |-
+  Gaussian r.m.s. spread of random fluctuations of microscopic reflection
+  angles due to small-scale surface deviations.
+data:
+  - type: double
+    description: Projected Gaussian r.m.s. of the first component.
+    unit: deg
+    default: 0.0066
+    allowed_range:
+      min: 0.0
+      max: 2.0
+  - type: double
+    description: Fractional amplitude of second component.
+    unit: dimensionless
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 1.0
+  - type: double
+    description: Projected Gaussian r.m.s. of the second component.
+    unit: deg
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 2.0
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetMirrorPanelRandomReflection
+    - SetParameterFromExternal
+  validation:
+    - ValidateMirrorPanelParameters
+    - ValidateOpticalPSF
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+  - SimPipe Derived
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/mirror_reflectivity.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for mirror_reflectivity 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: mirror_reflectivity
+description: |-
+  Mirror reflectivity measured directly on the facet as function of
+  wavelength. For dual mirror telescopes without explicit reflectivity
+  table given for the secondary, this reflectivity given here is
+  applied twice.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_reflectivity.dat'
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeEfficiency
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTriggerPerformance
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/multiplicity_offset.schema.yml

@@ -0,0 +1,46 @@
+%YAML 1.2
+---
+title: Schema for multiplicity_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: multiplicity_offset
+description: |-
+  This number tells where the actual threshold of the telescope trigger
+  is adjusted relative to the nominal number of required pixels.
+  A value of -0.5 means that with par:trigger-pixels of 4, the sum of
+  pixel discriminator/comparator outputs must exceed 3.5 times the
+  average output amplitude for the given minimum time and by the
+  given minimum signal integral in order to accept any `sector'
+  trigger (and therefore a telescope trigger) with the majority
+  trigger logic.
+short_description: |-
+  Actual threshold of the telescope trigger, adjusted relative to the
+  number of required pixels.
+data:
+  - type: double
+    unit: dimensionless
+    default: -0.5
+    allowed_range:
+      min: -0.5
+      max: 0.5
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/nsb_autoscale_airmass.schema.yml

@@ -0,0 +1,51 @@
+%YAML 1.2
+---
+title: Schema for nsb_autoscale_airmass 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: nsb_autoscale_airmass
+description: |-
+  NSB scaling as function of airmass (zenith angle).
+  This only takes effect if nsb_scaling_factor is exactly 1.0
+short_description: NSB scaling as function of airmass (zenith angle).
+data:
+  - type: double
+    description: |-
+      Zenith-level fraction of NSB resulting from airglow.
+      Value should be on the order of 0.7.
+    unit: dimensionless
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 1.0
+  - type: double
+    description: |-
+      Effective extinction coefficient applicable for NSB light
+      (due to scattering it should be smaller than extinction
+      coefficient for line-of-sight propagation).
+      Value should be on the order of 0.15.
+    unit: dimensionless
+    default: 0.15
+    allowed_range:
+      min: 0.0
+      max: 1.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/nsb_gain_drop_scale.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for nsb_gain_drop_scale 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: nsb_gain_drop_scale
+description: |-
+  This parameter, if non-zero, indicates the pixel p.e. rate at which the
+  gain drops to half the nominal value due to bias resistance and
+  cell capacitance (applicable as such for SiPM cameras). \\
+  \textbf{Example:} 1./(2.4 [kOhm] $\times$ 85 [fF])/1e9 [ns] = 4.90 [GHz].
+short_description: |-
+  Pixel p.e. rate at which the gain drops to half the nominal value due to
+  bias resistance and cell capacitance (SiPM cameras).
+data:
+  - type: double
+    unit: GHz
+    default: 0.0
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraGainsAndEfficiency
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray