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

simtools/schemas/model_parameters/nsb_offaxis.schema.yml

@@ -0,0 +1,79 @@
+%YAML 1.2
+---
+title: Schema for nsb_offaxis model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: nsb_offaxis
+description: |-
+  Fall-off of NSB with off-axis angle due to change of effective optical
+  area across the field of view (partly covered by
+  par:telescope-transmission).  The first parameter is the function
+  number. Function zero is a constant (all following parameters ignored),
+  function one is $f = 1/(1 + p_1 * (r/p_2)^{p_3})$ if $p_4=0$ or missing
+  and $f = 1/(1 + p_1 * (r/p_2)^{p_3})^{p_4}$ if $p_4\ne0$ where
+  $r$ is the ($x$/$y$ projected) pixel off-axis radius and $p_1$ to
+  $p_4$ are the second to fifth parameter, with $p_2$ understood as a
+  camera reference radius for the purpose of this function.
+short_description: |-
+  Fall-off of NSB with off-axis angle due to off-axis angle-dependent
+  effective optical area.
+data:
+  - name: nsb_offaxis_function
+    required: false
+    type: double
+    description: |
+      Function identifier.
+    default: 0
+    allowed_range:
+      min: 0
+      max: 1
+    unit: dimensionless
+  - name: nsb_offaxis_p1
+    description: |
+      NSB off-axis factor $p_1$.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+  - name: reference_radius_p2
+    description: |
+      Camera reference radius $p_2$.
+    required: false
+    type: double
+    default: 0.0
+    unit: cm
+  - name: nsb_offaxis_p3
+    description: |
+      NSB off-axis factor $p_3$.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+  - name: nsb_offaxis_p4
+    description: |
+      NSB off-axis factor $p_4$.
+    required: false
+    type: double
+    default: 0.0
+    unit: dimensionless
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetNightSkyBackgroundRate
+    - SetParameterFromExternal
+  validation:
+    - ValidatePedestalEvents
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/nsb_pixel_rate.schema.yml

@@ -0,0 +1,47 @@
+%YAML 1.2
+---
+title: Schema for nightsky_background model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: nsb_pixel_rate
+description: |-
+  'Number of photo-electrons per nanosecond per pixel due to night-sky
+  background. Note that the number here takes into account all
+  photo-electrons, including those not properly amplified or lost at the
+  first dynode.  A range of pixels can be given with
+  nightsky_background = (0-1236): 0.2, (1237-1854): 0.15.
+  Alternatively, all pixels can be set with nightsky_background = all: 0.2.'
+short_description: |-
+  Number of photo-electrons per nanosecond per pixel due to nightsky
+  background.
+data:
+  - type: double
+    unit: GHz
+    default: 0.218
+    allowed_range:
+      min: 0.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetNightSkyBackgroundRate
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+    - ValidateTriggerPerformance
+    - ValidateTelescopeSimulationModel
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: nightsky_background

simtools/schemas/model_parameters/nsb_reference_spectrum.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for nsb_reference_spectrum model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/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: nsb_reference_spectrum
+description: |-
+  Nightsky spectrum from Benn & Ellison (astro-ph/9909153),
+  in original units and converted to photons per wavelength interval, time, area, and solid angle.
+  More details can be found within the file.
+  This reference spectrum is expected to be replaced in the future with measured or predicted spectra per observation.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/nsb_reference_value.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for nsb_reference_value model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: nsb_reference_value
+description: |-
+  Reference value for night-sky background flux in the wavelength range
+  from 300-650 nm (corresponding approximately to the extragalactic
+  night sky background level during astronomical darkness)
+short_description: Reference value for night-sky background flux.
+data:
+  - type: double
+    unit: 1/(sr*ns*cm**2)
+    default: 0.24
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/nsb_scaling_factor.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for nsb_scaling_factor model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: nsb_scaling_factor
+description: |-
+  Common scaling of the NSB in all pixels of all telescopes against
+  reference setting.
+short_description: Global NSB scaling factor.
+data:
+  - type: double
+    unit: dimensionless
+    default: 1.0
+    allowed_range:
+      min: 0.0
+      max: 1000.0
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/nsb_skymap.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for nsb_sky_map model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/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: nsb_sky_map
+description: |-
+  An optional sky map (Az/Alt) of NSB enhancement factors, counted on top
+  of the configured pixel NSB p.e. rates and other scaling factors
+  mentioned in this section, but not any starlight which might get
+  added additionally. Recommend is to provide a regular grid in
+  azimuth and altitude. This map will be evaluated for each pixel
+  center pointed back into the sky, using the effective focal length
+  (no explicit ray-tracing), thus is only suitable for changes in
+  sky brightness exceeding the pixel sizes.
+short_description: Sky map (Az/Alt) of NSB enhancement factors.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/nsb_spectrum.schema.yml

@@ -0,0 +1,50 @@
+%YAML 1.2
+---
+title: Schema for night_sky_background_spectrum model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: nsb_background_spectrum
+developer_note: |
+  TODO - check that wavelength range is sufficient
+  TODO - add possible zenith / azimuth dependence
+  (see Granada talk by C. Righi)
+description: Intensity of night-sky background light as function of wavelength.
+instrument:
+  class: Site
+  type:
+    - Atmosphere
+  site:
+    - North
+    - South
+data:
+  - type: data_table
+    table_columns:
+      - name: wavelength
+        description: Wavelength
+        required: true
+        unit: nm
+        type: double
+        required_range:
+          min: 300.0
+          max: 700.0
+        input_processing:
+          - remove_duplicates
+          - sort
+      - name: intensity
+        description: Intensity of the night-sky background
+        required: true
+        unit: photons / arcsec**2 m**2 s** micron
+        type: double
+        required_range:
+          min: 0.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/num_gains.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for num_gains model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: num_gains
+description: Number of different gains the input signal gets digitized.
+data:
+  - type: int
+    unit: dimensionless
+    default: 2
+    allowed_range:
+      min: 1
+      max: 2
+instrument:
+  class: Camera
+  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/only_triggered_telescopes.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for only_triggered_telescopes model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: only_triggered_telescopes
+description: |-
+  Triggered telescopes are read out only (if true), otherwise
+  non-triggered telescopes are also read out.
+short_description: Switch to read out non-triggered telescopes.
+data:
+  - type: boolean
+    default: true
+instrument:
+  class: Camera
+  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/optics_properties.schema.yml

@@ -0,0 +1,31 @@
+%YAML 1.2
+---
+title: Schema for optics_properties model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/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: optics_properties
+description: |-
+  Derived properties of the telescope optics.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_file.dat'
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - SimPipe Derived

simtools/schemas/model_parameters/parabolic_dish.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for parabolic_dish model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: parabolic_dish
+description: |-
+  Parabolic dish.
+  Mirror tiles still have spherical shape (similar to the Davies-Cotton
+  optics), but their focal lengths are adapted to the distance from the
+  focus (since the geometric mean of minimum and maximum radius of
+  curvature of the paraboloid is very close to that distance).
+short_description: Parabolic dish shape is used.
+data:
+  - type: boolean
+    default: false
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pedestal_events.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for pedestal_events model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: pedestal_events
+description: |-
+  Number of pedestal events at start of run with camera lid open (same NSB as for normal events).
+short_description: |-
+  Number of pedestal events at start of run with camera lid open (same NSB as for normal events).
+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

simtools/schemas/model_parameters/photon_delay.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for photon_delay model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: photon_delay
+developer_note: |-
+  Type corrected with respect to the sim_telarray manual
+  (double, not int)
+description: |-
+  Additional delay added to the arrival times
+  of all photons at the photo sensors.
+data:
+  - type: double
+    unit: ns
+    default: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetPhotonDelay
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraTimeResponse
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/photons_per_run.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for photons_per_run model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: photons_per_run
+description: |-
+  Number of total emitted photons by the calibration light source per run.
+short_description: |-
+  Number of photons per run.
+data:
+  - type: double
+    unit: dimensionless
+    default: 1e10
+    allowed_range:
+      min: 1
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pixel_cells.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for pixel_cells model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: pixel_cells
+description: |-
+  Modeling of pixel saturation. Value corresponds to the
+  limited number of cells in a pixel (of SiPM type) which each can only
+  fire once during the typical arrival time spread of Cherenkov photons.
+  The presence of a non-zero value does not imply any microscopic model
+  of the pixel structure.
+data:
+  - type: int
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraChargeResponse
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pixels_parallel.schema.yml

@@ -0,0 +1,54 @@
+%YAML 1.2
+---
+title: Schema for pixels_parallel model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: pixels_parallel
+description: |-
+  Parameter controlling the orientation of the pixels, setting it to be
+  aligned with the optical axis or the focal surface normal.
+  A value of 0 indicates that the pixel is oriented such that the surface
+  is aligned with the focal surface (pixel axis parallel to focal surface
+  normal).
+  A value of 1 indicates, that pixels are only shifted parallel to the
+  optical axis. Pixel surfaces remain perpendicular to the optical axis.
+  A value of 2 places all pixels belonging to the same module
+  (as configured in the ``Pixels'' lines in the par:camera-config-file)
+  on a common plane, with its orientation along the normal to the focal
+  surface in the module center (c.o.g. of pixels) and with zero mean
+  displacements of pixels along the $z$ axis.
+  A value of 3 (=2+1) has all pixels in a common plane per module and
+  all of the modules (and thus all of the pixels) looking parallel to
+  the optical axis. The 'height' (in z) of the module is again the
+  average of where individually placed pixels would be (zero mean
+  displacement in module).
+  An extension to the camera definition file even allows for pixels to be
+  configured individually and not exactly following the focal surface
+  (in both height and orientation).
+short_description: |-
+  Parameter controlling the orientation of the pixels, setting it to be
+  aligned with the optical axis or the focal surface normal.
+data:
+  - type: uint
+    default: 1
+    allowed_range:
+      min: 0
+      max: 3
+    condition: mirror_class==2
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraGeometry
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pixeltrg_time_step.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for pixeltrg_time_step model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: pixeltrg_time_step
+description: |-
+  If non-zero, the time between the telescope trigger and the time
+  when the pixel discriminator/comparator fired is recorded under
+  the telescope event in the given time steps (negative for
+  pixels fired before the telescope trigger; possible delays involved
+  in a real instrument are not accounted for).
+short_description: Time difference between telescope and pixel trigger recording.
+data:
+  - type: double
+    unit: ns
+    default: 0.0
+    allowed_range:
+      min: 0.0
+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