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

simtools/schemas/model_parameters/fadc_lg_pedestal.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_pedestal 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_lg_pedestal
+description: (F)ADC pedestal value per time slice (low-gain channels).
+data:
+  - type: double
+    description: |-
+      (F)ADC pedestal value per time slice
+      (for low-gain channel in case of dual-readout chain).
+    unit: count
+    condition: num_gains==2
+    default: -1.
+    allowed_range:
+      min: -2.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+    - ValidatePedestalEvents
+    - ValidateTelescopeSimulationModel
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_lg_sensitivity.schema.yml

@@ -0,0 +1,50 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_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_lg_sensitivity
+developer_note: |-
+  DISCUSS - suggest to fix this to 1. for CTA and enforce
+  that fadc_amplitude is given in the correct units.
+description: |-
+  FADC counts per mV voltage (or whatever unit is used for
+  par:fadc-amplitude; for low-gain channels).  The definition of '1.0' means that ADC
+  amplitudes have to be given directly in units of the average
+  amplitude of a single photo-electron.
+short_description: FADC counts per mV voltage (for low-gain channels).
+data:
+  - type: double
+    description: |-
+      FADC counts per mV voltage.
+      (for low-gain channel in case of dual-readout chain).
+    condition: num_gains==2
+    default: -1.
+    unit: count / mV
+    allowed_range:
+      min: -2.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+    - ValidateReadout
+    - ValidateCameraChargeResponse
+    - ValidateCameraLinearity
+    - ValidateTelescopeSimulationModel
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_lg_sysvar_pedestal.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_sysvar_pedestal 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_lg_sysvar_pedestal
+description: |-
+  Systematic common (e.g. due to temperature) variation of pedestals (ow-gain channels).
+  All reported monitoring data in the same run is offset by the same
+  (random) amount. Parameter determines the Gaussian r.m.s.
+short_description: Systematic common variations of pedestals (low-gain channels).
+data:
+  - type: double
+    description: |-
+      Systematic common variations of pedestals.
+      (for low-gain channel in case of dual-readout chain).
+    condition: num_gains==2
+    default: -1.
+    unit: count
+    allowed_range:
+      min: -2.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_lg_var_pedestal.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_var_pedestal 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_lg_var_pedestal
+description: |-
+  Channel-to-channel (or pixel-to-pixel) variation of the pedestal per FADC
+  time slice (low-gain channels). Value is the r.m.s. of the randomly chosen pedestal values
+  around the FADC pedestal.
+data:
+  - type: double
+    description: |-
+      Pedestal variations
+      (for low-gain channel in case of dual-readout chain).
+    condition: num_gains==2
+    unit: count
+    default: -1.
+    allowed_range:
+      min: -2.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_lg_var_sensitivity.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_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_lg_var_sensitivity
+description: Relative variations in sensitivity (even for FADCs of the same channel; low-gain channels).
+data:
+  - type: double
+    description: |-
+      Relative variations in sensitivity
+      (for low-gain channel in case of dual-readout chain).
+    condition: num_gains==2
+    unit: dimensionless
+    default: -1.
+    allowed_range:
+      min: -2.
+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/fadc_max_signal.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for fadc_max_signal 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_max_signal
+description: |-
+  Maximum value of digitized signal per sample
+  (for high-gain channel for dual-gain readout).
+  For a typical 12-bit ADC this would be 4095.
+short_description: Maximum value of digitized signal per sample.
+data:
+  - type: uint
+    description: |-
+      Maximum FADC signal
+      (for high-gain channel in case of dual-readout chain).
+    unit: count
+    default: 0
+    allowed_range:
+      min: 0
+      max: 65535
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+    - ValidateCameraLinearity
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_max_sum.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for fadc_max_sum 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_max_sum
+developer_note: Not applicable for CTA telescopes.
+description: |-
+  The maximum value of a pulse sum produced by hardware pulse summation,
+  in sum mode rather than recording pulse samples
+  (for high-gain channel for dual-gain readout).
+  Typical limitations are 15 or 16 bits, i.e. 32767 or 65535.
+short_description: |-
+  The maximum value of a pulse sum produced by hardware pulse summation,
+  in sum mode rather than recording pulse samples.
+data:
+  - type: uint
+    description: |-
+      Maximum value of a pulse sum
+      (for high-gain channel in case of dual-readout chain)
+    unit: count
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - None
+activity:
+  setting:
+    - None
+  validation:
+    - None
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_mhz.schema.yml

@@ -0,0 +1,31 @@
+%YAML 1.2
+---
+title: Schema for fadc_mhz 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_mhz
+description: FADC sampling rate.
+data:
+  - type: double
+    default: 1000.
+    unit: MHz
+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/fadc_noise.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for fadc_noise 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_noise
+description: |-
+  Gaussian r.m.s. spread of white noise per time bin in digitisation
+  (for high-gain channel, if different gains are used).
+short_description: Gaussian r.m.s. spread of white noise per time bin in digitisation.
+data:
+  - type: double
+    description: |-
+      Gaussian r.m.s. spread of white noise per time bin in digitisation
+      (for high-gain channel in case of dual-readout chain)
+    unit: count
+    default: 4.0
+    allowed_range:
+      min: 0.0
+      max: 100.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_pedestal.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for fadc_pedestal 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_pedestal
+description: |-
+  (F)ADC pedestal value per time slice (for high-gain channel for dual-gain readout).
+data:
+  - type: double
+    description: |-
+      (F)ADC pedestal value per time slice
+      (for high-gain channel in case of dual-readout chain).
+    unit: count
+    default: 100.
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+    - ValidatePedestalEvents
+    - ValidateTelescopeSimulationModel
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_pulse_shape.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for fadc_pulse_shape 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: fadc_pulse_shape
+description: |-
+  (F)ADC pulse shape (amplitude vs time) for low and high gain
+  readout chain.  The pulse amplitude scale is ignored and the pulses are
+  re-scaled to peak values of par:fadc-amplitude times par:fadc-sensitivity.
+short_description: (F)ADC pulse shape (amplitude vs time).
+data:
+  - type: file
+    unit: dimensionless
+    default: 'unspecified_shape.dat'
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetReadoutPulseShape
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraChargeResponse
+    - ValidateCameraTimeResponse
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_sensitivity.schema.yml

@@ -0,0 +1,50 @@
+%YAML 1.2
+---
+title: Schema for fadc_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_sensitivity
+developer_note: |-
+  DISCUSS - suggest to fix this to 1. for CTA and enforce
+  that fadc_amplitude is given in the correct units.
+description: |-
+  FADC counts per mV voltage (or whatever unit is used for
+  par:fadc-amplitude).  The definition of '1.0' means that ADC
+  amplitudes have to be given directly in units of the average
+  amplitude of a single photo-electron
+  (for high-gain channel for dual-gain readout).
+short_description: FADC counts per mV voltage.
+data:
+  - type: double
+    description: |-
+      FADC counts per mV voltage.
+      (for high-gain channel in case of dual-readout chain).
+    unit: count / mV
+    default: 1.0
+    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:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_sum_bins.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for fadc_sum_bins 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_sum_bins
+description: |-
+  Number of bins summed up in ADC sum data or read out in sampled data.
+  This number corresponds to the experimental length of the readout window.
+  The start of the readout window starts fadc_sum_offset bins
+  before the calculated time of the trigger, as long as the readout window
+  fits fully in the simulated window.  With peak sensing readout, the same
+  interval is used for searching the peak signal.
+short_description: |-
+  Number of bins read out in sampled data or summed up in ADC sum data.
+  Corresponds to the experimental length of the readout window.
+data:
+  - type: uint
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_sum_offset.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for fadc_sum_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: fadc_sum_offset
+description: |-
+  Number of bins before telescope trigger where summing or reading of
+  sampled data starts (see also description of fadc_sum_bins).  With peak
+  sensing readout, the same offset is used for setting the interval for
+  the searching of the peak signal.  For negative values, the summing or
+  reading starts after the trigger.
+short_description: |-
+  Number of bins before telescope trigger where summing or reading of
+  sampled data starts.
+data:
+  - type: int
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: -160
+      max: 160
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_sysvar_pedestal.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for fadc_sysvar_pedestal 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_sysvar_pedestal
+description: |-
+  Systematic common (e.g. due to temperature) variation of pedestals
+  (for high-gain channel for dual-gain readout).
+  All reported monitoring data in the same run is offset by the same
+  (random) amount. Parameter determines the Gaussian r.m.s.
+short_description: Systematic common variations of pedestals.
+data:
+  - type: double
+    description: |-
+      Systematic common variations of pedestals.
+      (for high-gain channel in case of dual-readout chain).
+    unit: count
+    default: 0.04
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_var_pedestal.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for fadc_var_pedestal 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_pedestal
+description: |-
+  Channel-to-channel (or pixel-to-pixel) variation of the pedestal per FADC
+  time slice. Value is the r.m.s. of the randomly chosen pedestal values
+  around the FADC pedestal
+  (for high-gain channel for dual-gain readout.
+data:
+  - type: double
+    description: |-
+      Pedestal variations
+      (for high-gain channel in case of dual-readout chain).
+    unit: count
+    default: 0.75
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidatePedestalEvents
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray