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

simtools/schemas/model_parameters/discriminator_var_time_over_threshold.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for discriminator_var_time_over_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: discriminator_var_time_over_threshold
+description: |-
+  Pixel-to-pixel variation of the time over threshold required before logic
+  response switches to true.
+data:
+  - type: double
+    unit: ns
+    default: 0.1
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+      max: 100.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dish_shape_length.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for dish_shape_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: dish_shape_length
+description: |-
+  Dish curvature length, best equal to focal length. For a Davies-Cotton
+  dish, this is the radius of the sphere on which the mirror tiles are
+  positioned. For a parabolic dish, this is the focal length of the
+  paraboloid on which the mirrors are placed. This parameter is only
+  needed when variations to the standard shapes are tried out, e.g.
+  intermediate shapes between parabolic and Davies-Cotton.
+short_description: Dish curvature length, best equal to focal length.
+data:
+  - type: double
+    unit: cm
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 10000.0
+    condition: mirror_class==1
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_clipping.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for dsum_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: dsum_clipping
+description: |-
+  The amplitude level (in ADC counts above pedestal) at which the digitized
+  signal from each pixel (after optional shaping) is clipped for its
+  contribution to the digital sum trigger.
+short_description: Amplitude level at which the digitized signal from each pixel is
+  clipped.
+data:
+  - type: int
+    default: 0
+    unit: count
+    allowed_range:
+      min: 0
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_ignore_below.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for dsum_ignore_below 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: dsum_ignore_below
+description: |-
+  FADC signals (pedestal subtracted and/or shaped) below this value,
+  i.e. in the noise, do not contribute to the digital signal sum and
+  are set to zero.  A value of zero means that no such lower threshold
+  gets applied.
+short_description: FADC signal minimum contribution to digital signal sum.
+data:
+  - type: uint
+    unit: count
+    default: 0
+    condition: default_trigger==DigitalSum
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_offset.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for dsum_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: dsum_offset
+description: |-
+  Offset in time where digital pulse shaping is done. Time intervals at
+  the start and end of the simulated time window that are affected by
+  shaping of missing outside signals are not used for trigger evaluation.
+short_description: Time offset applied before signal processing.
+data:
+  - type: double
+    unit: ns
+    default: 0.0
+    allowed_range:
+      min: 0.0
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_pedsub.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for dsum_pedsub 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: dsum_pedsub
+description: |-
+  Expected pedestal is first subtracted before any
+  shaping, scaling, clipping, etc. operations (if true).
+  Without pedestal subtraction, shaping kernels with non-zero
+  sum are not practical.
+data:
+  - type: boolean
+    default: true
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_pre_clipping.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for dsum_pre_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: dsum_pre_clipping
+description: |-
+  The amplitude level (in ADC counts above pedestal)
+  at which the digitized signal from each pixel (before optional shaping) is
+  clipped for its contribution to the digital sum trigger.
+  A value of zero indicates no clipping is applied.
+  Any such clipping is usually not a good idea, with FADC maximum
+  value defined by fadc_max_signal anyway.
+data:
+  - type: uint
+    unit: count
+    default: 0
+    condition: default_trigger==DigitalSum
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_prescale.schema.yml

@@ -0,0 +1,44 @@
+%YAML 1.2
+---
+title: Schema for dsum_prescale 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: dsum_prescale
+developer_note: TODO - Remove comment on DDSUM_DOUBLE?
+description: |-
+  Shaped signals are scaled by first multiplying with the
+  first value (to integer unless sim\_telarray was compiled with
+  \texttt{DDSUM_DOUBLE}) and then divided by the second value
+  (discarding the remainder).
+  No such scaling is applied if first and second value are equal.
+short_description: Scaling of shaped signals.
+data:
+  - type: uint
+    description: multiplier
+    default: 0
+    unit: dimensionless
+    condition: default_trigger==DigitalSum
+  - type: uint
+    description: divider
+    default: 0
+    unit: dimensionless
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_presum_max.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for dsum_presum_max 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: dsum_presum_max
+description: |-
+  After bit-shifting the pre-sum, the resulting value
+  (zero-clipped, typically) may have the given maximum
+  value to be represented in the available number of bits.
+  A value of zero implies no maximum to be applied.
+short_description: Maximum of pre-sum in available number of bits.
+data:
+  - type: uint
+    unit: dimensionless
+    default: 0
+    condition: default_trigger==DigitalSum
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_presum_shift.schema.yml

@@ -0,0 +1,45 @@
+%YAML 1.2
+---
+title: Schema for dsum_presum_shift 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: dsum_presum_shift
+description: |-
+  After a patch-wise pre-summation, the resulting sum may be
+  right-shifted to reduce the significant number of bits.
+  The presence of patches is indicated for
+  par:trigger_decision_circuitry
+  for the DigitalSumTrigger by e.g.\\
+  \texttt{DigitalSumTrigger * of 1[2,3] 4[5,6]} \\
+  instead of using a plain list of pixel IDs like\\
+  \texttt{DigitalSumTrigger * of 1 2 3 4 5 6}.
+short_description: |-
+  After a patch-wise pre-summation, the resulting sum may be
+  right-shifted to reduce the significant number of bits.
+data:
+  - type: uint
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+      max: 4
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_shaping.schema.yml

@@ -0,0 +1,44 @@
+%YAML 1.2
+---
+title: Schema for dsum_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: dsum_shaping
+description: |-
+  Shaping (convolution) parameters for a digitized detector signal
+  (time step of ADC time slices) to the resulting signal from which a
+  digital-sum trigger decision may be derived. The values are a digital
+  signal processing kernel.  For example, a file containing
+  $\left( \begin{smallmatrix} 0 & 1\\ 1&-1 \end{smallmatrix} \right)$
+  would be a simple differencing filter,
+  $b[n] = a[n] - a[n-1]$.
+  The first column is in ADC bins behind current interval, the second
+  value is the factor applied to the corresponding ADC value.
+short_description: |-
+  Shaping (convolution) parameters for a digitized detector signal
+  to the resulting signal from which a digital-sum trigger decision may be
+  derived.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: dsum_shaping_file

simtools/schemas/model_parameters/dsum_shaping_renormalize.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for dsum_shaping_renormalize 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: dsum_shaping_renormalize
+description: |-
+  The positive part of the shaping kernel is auto-normalized
+  to a sum of 1.0 (if true). If false, the shaping kernel is used as-is.
+data:
+  - type: boolean
+    default: false
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_threshold.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for dsum_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: dsum_threshold
+description: |-
+  The amplitude level above pedestal sum above which a
+  digital sum leads to a telescope trigger.
+  Note that, like for discriminator/comparator and analog sum, the signal
+  must exceed (\'>\') the threshold here before we declare the telescope
+  triggered. The assigned threshold value would have to be one count lower
+  than in a camera-internal trigger implementation (like MSTS) where
+  reaching (\'>=\') the threshold is enough.
+short_description: Amplitude level above which a digital sum leads to a telescope
+  trigger.
+data:
+  - type: double
+    unit: count
+    default: 0.0
+    allowed_range:
+      min: 0.0
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTriggerThresholdsFromRateScan
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/dsum_zero_clip.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for dsum_zero_clip 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: dsum_zero_clip
+description: |-
+  With a value of 1, any negative shaped signals are clipped at zero
+  (which a non-zero dsum_ignore_below does anyway).
+  With a value of $-1$, negative signals are not clipped immediately
+  but together with patch-wise pre-summation they are clipped at zero
+  after pre-summation.
+  A value of zero means that negative shaped signals are preserved
+  for the final digital sum.
+short_description: Clipping of negative shaped signals.
+data:
+  - type: int
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: -1
+      max: 1
+    condition: default_trigger==DigitalSum
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/effective_focal_length.schema.yml

@@ -0,0 +1,61 @@
+%YAML 1.2
+---
+title: Schema for effective_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: effective_focal_length
+developer_note: |-
+  Not a simulation model parameter but used for the analysis only.
+  Should be discussed further if this is the right place.
+description: |-
+  Due to asymmetric image aberrations, in particular for single-reflector
+  telescope, segmented or not, the inverse image 'plate scale' or, more
+  precisely, the ratio of off-center distance in the focal plane
+  (projection for curved focal surface) to the tangent of the off-axis
+  angle, does not match the nominal focal plane very well. This effective
+  value here should be better suitable for shower reconstruction than the
+  nominal focal length and is supposed to be based on ray-tracing
+  simulations of point sources, at distances typical of showers and
+  imaged onto the actual focal surface at the level of the pixel entrances.
+  Non-zero values will be reported as-is in the output data and
+  may be used for the built-in reconstruction in sim_telarray. If no value is given,
+  sim_telarray may estimate a value, based on optics type and f/D ratio, for its
+  internal purpose but will not report such an estimate in the output data.
+  Due to subtle effects of image cleaning (and thus image intensity) on
+  cutting off parts of the asymmetric point-spread function, analysis
+  programs should use this value or, if not available, an estimate of it
+  only as a starting point and evaluate the actual analysis specific
+  and perhaps image intensity and NSB dependent real effective focal length
+  by itself.
+short_description: |-
+  Effective focal length.
+  Only to be used for image analysis, has no effect on the simulation.
+data:
+  - type: double
+    unit: cm
+    default: 0.0
+    allowed_range:
+      min: 0.0
+      max: 10000.0
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetEffectiveFocalLength
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraPlateScale
+source:
+  - SimPipe Derived
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/epsg_code.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for epsg_code 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: epsg_code
+developer_note: |-
+  Obtained from https://epsg.io/32628 and
+  https://epsg.io/32719
+description: |-
+  EPSG code to describe geodetic datums, spatial reference
+  system, and Earth ellipsoids at the site.
+short_description: Site EPSG code
+data:
+  - type: int
+    unit: dimensionless
+    allowed_range:
+      min: 1024
+      max: 32767
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup