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

simtools/schemas/model_parameters/secondary_mirror_parameters.schema.yml

@@ -0,0 +1,168 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_parameters 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_parameters
+developer_note: |-
+  Note the application of dual_mirror_ref_radius (primary_ref_radius,
+  secondary_ref_radius) this this parameters.
+description: |-
+  Defines the position of the secondary mirror along the optical
+  axis and its shape. The first parameter ($p_0$) is the offset of the
+  mirror with respect to the common reference point defined by
+  par:mirror-offset, with positive values indicating that the centre
+  of the primary (assuming it has no central hole) is above the reference
+  point. The secondary mirror looks the other way, i.e. $p_0$ will usually
+  be negative since in the coordinate frame of the secondary, it is
+  below the common reference point.  Apart from that, a parameter $p_i$
+  adds a term $p_i r^{2i}$ to the height of the mirror at
+  radial offset $r$.  A parabolic mirror will have the second parameter
+  ($p_1$) at a positive value and all further parameters at 0.
+  A concave secondary, reducing the focal length if placed between the
+  primary and its focus, will have $p_1 > 0.$.
+  A convex mirror (e.g.~for Cassegrain or Ritchey-Chr\'etien optics),
+  enlarging the focal length, will have $p_1 < 0$.
+short_description: |-
+  Parameters for a polynomial defining the position of the secondary mirror
+  along the optical axis and its shape.
+data:
+  - name: p0
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p1
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p2
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p3
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p4
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p5
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p6
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p7
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p8
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p9
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p10
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p11
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p12
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p13
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p14
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p15
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p16
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p17
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p18
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p19
+    type: double
+    description: coefficient describing secondary mirror
+    required: true
+    unit: cm
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateOpticalPSF
+    - ValidateTelescopeEfficiency
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/secondary_mirror_ref_radius.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_ref_radius 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_ref_radius
+description: |-
+  The length scale to which the secondary_mirror_parameters apply.
+  Typical values could be 1.0 or the focal length of the
+  secondary/secondary.
+short_description: The length scale to which the secondary_mirror_parameters apply.
+data:
+  - name: secondary_ref_radius
+    description: The length scale to which the secondary_mirror_parameters apply.
+    type: double
+    unit: cm
+    condition: mirror_class==2
+    default: 1.
+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_ref_radius

simtools/schemas/model_parameters/secondary_mirror_reflectivity.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for secondary_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: secondary_mirror_reflectivity
+description: |-
+  Secondary mirror reflectivity measured directly on the facet as function of
+  wavelength.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_reflectivity.dat'
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeEfficiency
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTriggerPerformance
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: mirror_secondary_reflectivity

simtools/schemas/model_parameters/secondary_mirror_segmentation.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_segmentation 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_segmentation
+description: |-
+  Definition of segments or segment groups of the secondary reflector.
+  If not active (value "none") then the secondary is assumed
+  to be of one circular piece, with an optional central hole. The inner
+  and outer diameters still apply, even in case of segmentation.
+short_description: |-
+  Definition of segments or segment groups of the secondary reflector.
+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_segmentation

simtools/schemas/model_parameters/secondary_mirror_shadow_diameter.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_shadow_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_shadow_diameter
+description: |-
+  The diameter of any non-reflective but not transparent (black)
+  central part of the secondary mirror in a dual-mirror telescope.
+  A value of $-1$ indicates that the same value as for the
+  reflective diameter of the secondary (par:secondary-diameter) is
+  to be used.
+short_description: |-
+  The diameter of any non-reflective but not transparent (black)
+  central part of the secondary mirror in a dual-mirror telescope.
+data:
+  - type: double
+    unit: cm
+    condition: mirror_class==2
+    default: -1.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeShadowing
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: secondary_shadow_diameter

simtools/schemas/model_parameters/secondary_mirror_shadow_offset.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for secondary_mirror_shadow_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: secondary_mirror_shadow_offset
+description: |-
+  The secondary mirror shadowing element is normally assumed at the level
+  of the edge of the secondary.  If this parameter is non-zero, it can be
+  set at any position above the center of the primary mirror.
+  Even if placed in front of the secondary, it will not be used for
+  photons reflected from the secondary.
+short_description: |-
+  The offset of the shadowing element from the level of the edge of the
+  secondary mirror.
+data:
+  - type: double
+    unit: cm
+    condition: mirror_class==2
+    default: 0.0
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateTelescopeShadowing
+    - ValidateTelescopeEfficiency
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: secondary_shadow_offset

simtools/schemas/model_parameters/store_photoelectrons.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for store_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: store_photoelectrons
+description: |-
+  While the save_photons=2 configuration option will save photo-electron data for all events,
+  this parameter allows to set a lower limit on the number of photo-electrons
+  which must get registered before deciding to store them.
+  Setting it to a value of zero or bigger (default: -1) will automatically enable the corresponding save_photons bit.
+  It should be cross-checked that the min_photons parameter is unlikely to result
+  in fewer than the given number of photo-electrons, as no attempt is made to trace photons through the telescope
+  and produce any photo-electrons if there are too few photons in the first place.
+data:
+  - type: int
+    unit: dimensionless
+    default: -1
+    allowed_range:
+      min: 0
+      max: 10000
+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/tailcut_scale.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for tailcut_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: tailcut_scale
+description: |-
+  The special scheme for selecting pixels belonging to a shower image as implemented in sim_telarray
+  (as opposed to the traditional two-level tailcut scheme) has multiple thresholds
+  for the various levels of confidence that a pixel actually belongs to the shower image.
+  Instead of making them individually configurable, a common scale factor can be applied to all of them.
+data:
+  - type: double
+    unit: dimensionless
+    default: 1
+    allowed_range:
+      min: 0.0
+      max: 10.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraChargeResponse
+    - ValidateCameraGainsAndEfficiency
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/telescope_axis_height.schema.yml

@@ -0,0 +1,31 @@
+%YAML 1.2
+---
+title: Schema for telescope_axis_height 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: telescope_axis_height
+description: Height of telescope elevation axis above ground level.
+data:
+  - type: double
+    unit: m
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidationWorkflowMissing
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/telescope_random_angle.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for telescope_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: telescope_random_angle
+description: |-
+  Random (known) misalignment of the telescope in each axis
+  (Gaussian r.m.s.). The resulting telescope pointing including
+  this misalignment are saved as telescope azimuth and altitude
+  pointing directions.
+data:
+  - type: double
+    unit: deg
+    default: 0.001
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidationWorkflowMissing
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/telescope_random_error.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for telescope_random_error 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: telescope_random_error
+description: |-
+  Random (unknown) alignment error of the telescope in each axis
+  (Gaussian r.m.s.). The resulting telescope pointing including
+  this misalignment is not saved to the simulation output.
+data:
+  - type: double
+    unit: deg
+    default: 0.001
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidationWorkflowMissing
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/telescope_sphere_radius.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for telescope_sphere_radius 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: telescope_sphere_radius
+developer_note: |-
+  Note the axes_offset in the calculation of the sphere radius.
+description: |-
+  Radius of fiducial sphere within which all telescope optical elements
+  are fully contained.
+short_description: Telescope fiducial sphere radius.
+data:
+  - type: double
+    unit: m
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeFiducialSphere
+  validation:
+    - ValidateParameterByExpert
+    - ValidationWorkflowMissing
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/telescope_transmission.schema.yml

@@ -0,0 +1,113 @@
+%YAML 1.2
+---
+title: Schema for telescope_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
+name: telescope_transmission
+developer_note: |-
+  Note 1 - If compiled with the \texttt{RAYTRACING_INTERSECT_RODS} pre-processor
+  definition, the default value is 1.00, as the absorption is
+  calculated explicitly.
+  Note 2 - p0 should be uint
+description: |-
+  Off-axis angle-dependent transmission, accounting for absorption and
+  shadowing by masts.  Two types of functions are available, a constant
+  and a variable one ($T(\theta)$), where the former is selected
+  if transmission_function = 0 and the latter if transmission_function = 1.
+  Two options are available for the variable function, it is defined as
+  \[
+  T(\theta)=p_0/(1.+p_2 ((\sin\theta)/r_3)^{p_4}),
+  \]
+  if $p_5=0$, and as
+  \[
+  T(\theta)=p_0/(1.+p_2 ((\sin\theta)/r_3)^{p_4})^{p_5},
+  \]
+  if $p_5\ne0$.
+  The parameter $r_3$ is defined as $r_3=p_3 \pi/180$ and
+  $p_0$, $p_2$, $p_3$, $p_4$ and $p_5$
+  are the first, third, fourth, fifth and sixth parameters.
+  Default values are $p_4=2$, $p_3=0.5 d/f$ when these are missing/zero.
+  The $p_5$ parameter may not be available/supported and is effectively
+  zero/unused if not.
+  A value of $p_0 = 0.89$ means that 11\% of all light is assumed to be
+  absorbed by masts.
+  Shadowing by camera body is accounted for later
+  (see parameter par:camera-body-diameter and par:camera-depth).
+short_description: |-
+  Off-axis angle-dependent transmission, accounting for absorption and
+  shadowing by masts.
+data:
+  - name: constant_p0
+    type: double
+    description: |
+      Constant transmission factor $p_0$.
+    required: true
+    unit: dimensionless
+    default: 0.89
+    allowed_range:
+      min: 0.0
+      max: 1.0
+  - name: transmission_function
+    required: false
+    type: double
+    description: |
+      Transmission function identifier.
+    default: 0
+    allowed_range:
+      min: 0
+      max: 1
+    unit: dimensionless
+  - name: transmission_p2
+    description: |
+      Transmission factor $p_2$.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+  - name: transmission_p3
+    description: |
+      Transmission factor $p_3$.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+  - name: transmission_p4
+    description: |
+      Transmission factor $p_4$.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+  - name: transmission_p5
+    description: |
+      Transmission factor $p_5.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTelescopeShadowingParameters
+    - SetTelescopeEfficiency
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeShadowing
+    - ValidateTriggerPerformance
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray