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

simtools/schemas/model_parameters/fadc_var_sensitivity.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for fadc_var_sensitivity 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: fadc_var_sensitivity
+description: |-
+  Relative variations in sensitivity (even for FADCs of the same channel).
+data:
+  - type: double
+    description: |-
+      Relative variations in sensitivity
+      (for high-gain channel in case of dual-readout chain).
+    unit: dimensionless
+    default: 0.02
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+    - ValidateReadout
+    - ValidateCameraChargeResponse
+    - ValidateCameraLinearity
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/flatfielding.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for flatfielding 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: flatfielding
+developer_note: |-
+  This is of integer type in sim_telarray with allowed values 0 and 1.
+  Assigned here as type boolean, discuss if this is correct.
+description: |-
+  If enabled, the gains in pixels are adjusted to achieve the same signal
+  from the same illumination. If disabled, the gains are adjusted to
+  have equal single-p.e. amplitudes.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: boolean
+    unit: dimensionless
+    default: 1
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/focal_length.schema.yml

@@ -0,0 +1,45 @@
+%YAML 1.2
+---
+title: Schema for 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: focal_length
+description: |-
+  Nominal overall focal length of the entire telescope. This defines the
+  image scale near the centre of the field of view. For segmented primary
+  focus telescopes this determines the alignment of the segments and the
+  separation from the reflector, at its centre to the camera. The
+  alignment focus is on the surface determined by the par:focus-offset
+  (see parameter description for details).  For secondary mirror
+  configurations this value is not actually used in the optics simulation
+  but only reported as a nominal value, typically close to the effective
+  focal length.
+short_description: Nominal overall focal length of the entire telescope.
+data:
+  - type: double
+    unit: cm
+    default: 1500.0
+    allowed_range:
+      min: 10.0
+      max: 10000.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/focal_surface_parameters.schema.yml

@@ -0,0 +1,158 @@
+%YAML 1.2
+---
+title: Schema for focal_surface_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: focal_surface_parameters
+description: |-
+  Defines the position of the focal surface along the optical axis and
+  its off-axis shape.  The par:focus-offset still applies, but with a
+  curved focal surface only in the camera centre, such that star light
+  would be focused on the camera lid surface but light from the typical
+  distance of the shower maximum would be focused on the pixel entrance.
+  Note that this offset may be impractically small with secondary mirrors
+  reducing the plate scale.  The direction of the incoming rays is not
+  transformed into the normal plane of the focal surface, thus
+  corresponding to pixels shifted w.r.t.\ to a plane.
+short_description: |-
+  Defines the position of the focal surface along the optical axis and its
+  off-axis shape.
+data:
+  - name: p0
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p1
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p2
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p3
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p4
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p5
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p6
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p7
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p8
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p9
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p10
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p11
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p12
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p13
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p14
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p15
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p16
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p17
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p18
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+  - name: p19
+    type: double
+    description: coefficient describing focal surface
+    required: true
+    unit: cm
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraGeometry
+    - ValidateOpticalPSF
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/focal_surface_ref_radius.schema.yml

@@ -0,0 +1,29 @@
+%YAML 1.2
+---
+title: Schema for focal_surface_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: focal_surface_ref_radius
+description: The length scale to which the focal_surface_parameters apply.
+data:
+  - type: double
+    condition: mirror_class==2
+    unit: cm
+    default: 1.0
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/focus_offset.schema.yml

@@ -0,0 +1,66 @@
+%YAML 1.2
+---
+title: Schema for focus_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: focus_offset
+description: |-
+  Distance of the starlight focus from the camera pixels (light guides)
+  entry. In telescopes without dynamic focusing capability (either
+  through mirror alignment and camera positioning) this is best set
+  such that starlight gets focused onto the camera lid while showers
+  are focused onto the pixel entry.
+  Zenith angle dependence of the focus offset can be applied and includes
+  the constant value $\Delta_0$ and terms depending on cosine and sine
+  of the zenith angle. The total focus offset is
+  $\Delta = \Delta_0 + \Delta_c + \Delta_s$.
+  Set to zero for all 2M telescope types, as it is already included in
+  the first of the par:focal-surface-parameters values, assuming the
+  design value of that is for a light source at a typical shower maximum
+  distance.
+short_description: |-
+  Distance of the starlight focus from the camera pixels (light guides)
+  entry.
+data:
+  - type: double
+    name: focus_offset
+    description: Constant focus offset $\Delta_0$.
+    unit: cm
+    default: 2.8
+  - type: double
+    description: Zenith angle $\Delta_0$ at which minimum is reached.
+    unit: deg
+    default: 28.0
+  - type: double
+    description: |-
+      Scaling term $k_c$ in
+      $\Delta_c = (\cos(\theta)-\cos(\theta_0)) / k_c$.
+    unit: dimensionless
+    default: 0.0
+  - type: double
+    description: |-
+      Scaling term $k_s$ in
+      $\Delta_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:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateOpticalPSF
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/gain_variation.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for gain_variation 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: gain_variation
+short_description: |-
+  Fractional gain variation between different photo detectors after
+  adjusting the voltage to have approximately the same gain in all channels.
+description: |-
+  Fractional gain variation between different photo detectors after
+  adjusting the voltage to have approximately the same gain in all channels.
+  The parameter sets the Gaussian r.m.s. spread of random fluctuations, used
+  as \texttt{amplitude *= RandGaus(1., gain_variation)}.
+data:
+  - type: double
+    unit: dimensionless
+    default: 0.02
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraChargeResponse
+    - ValidateCameraGainsAndEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/geomag_horizontal.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for geomag_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: geomag_horizontal
+short_description: Horizontal component of geomagnetic field.
+description: |-
+   Horizontal component in direction of magnetic North of the geomagnetic
+   field at given site.
+data:
+  - type: double
+    unit: uT
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetGeomagneticField
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateAtmosphericModel
+    - ValidateTelescopeSimulationModel
+source:
+  - External
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/geomag_rotation.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for geomag_rotation 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: geomag_rotation
+short_description: Rotation angle between geographic South and geomagnetic North.
+description: |-
+   Rotation angle between geographic South and geomagnetic North direction
+   (corresponds to CORSIKA ARRANG parameter).
+data:
+  - type: double
+    unit: deg
+    allowed_range:
+      min: -180.0
+      max: 180.0
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetGeomagneticField
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateAtmosphericModel
+    - ValidateTelescopeSimulationModel
+source:
+  - External
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/geomag_vertical.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for geomag_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: geomag_vertical
+short_description: Vertical component of geomagnetic field.
+description: |-
+   Vertical component in downwards direction of the geomagnetic
+   field at given site.
+data:
+  - type: double
+    unit: uT
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetGeomagneticField
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateAtmosphericModel
+    - ValidateTelescopeSimulationModel
+source:
+  - External
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/hg_lg_variation.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for hg_lg_variation 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: hg_lg_variation
+description: |-
+  Relative pixel-to-pixel variation of the ratio of high-gain to
+  low-gain amplitudes.
+data:
+  - type: double
+    required: false
+    condition: num_gains==2
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 0.25
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/iobuf_maximum.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for iobuf_maximum 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: iobuf_maximum
+description: |-
+  Buffer limits for input and output of eventio data.
+data:
+  - type: int
+    unit: byte
+    default: 200000000
+    allowed_range:
+      min: 100000
+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/iobuf_output_maximum.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for iobuf_output_maximum 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: iobuf_output_maximum
+description: |-
+  The maximum size of the I/O buffer for output data, including raw data for all telescopes.
+data:
+  - type: int
+    unit: byte
+    default: 20000000
+    allowed_range:
+      min: 100000
+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/laser_events.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for laser_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: laser_events
+description: |-
+  Laser (or LED or other pulsed light source) events at start of run, before the first shower event.\
+  The assumed light source would typically be in the center of the dish and is assumed to illuminate all pixels uniformly.\
+  The camera lid is assumed to be open, i.e. events will also be subject to NSB.\
+  A value of zero means that the data will not contain any such events.
+short_description: |-
+  Relative variation of laser shots from shot to shot.
+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