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

simtools/schemas/model_parameters/fadc_ac_coupled.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for fadc_ac_coupled 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: fadc_ac_coupled
+description: |-
+  AC coupling of the FADCs.  If set to 1, then FADCs are AC coupled.
+  A change in night sky background rate will then only change the pedestal
+  noise but not the average pedestal.
+short_description: AC coupling of the FADCs.
+data:
+  - type: boolean
+    unit: dimensionless
+    default: 1
+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_amplitude.schema.yml

@@ -0,0 +1,46 @@
+%YAML 1.2
+---
+title: Schema for fadc_amplitude 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: fadc_amplitude
+description: |-
+  Peak amplitude at ADC/FADC (for high-gain channel for dual-gain readout).
+  fadc_amplitude are ADC counts maximum amplitude above pedestal
+  (per time slice) for a photo-electron with average (not most probable)
+  signal.  This is after photo detector, preamplifier, cable, and shaper
+  at the input of the ADC or FADC.
+short_description: Peak amplitude above pedestal for a photo electron with average
+  signal.
+data:
+  - type: double
+    description: FADC amplitude (for high-gain channel in case of dual-readout chain).
+    unit: count
+    default: 14.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_bins.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for fadc_bins 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: fadc_bins
+description: |-
+  Number of FADC bins to be simulated.
+  The median of all Cherenkov light photo-electrons will be near 40\% of
+  the interval length determined by fadc_bins, unless shifted by
+  photon_delay. If photon_delay is set to zero, this will be the number of
+  FADC bins read out.
+short_description: Number of FADC bins to be simulated.
+data:
+  - type: uint
+    unit: dimensionless
+    default: 20
+    allowed_range:
+      min: 1
+      max: 160
+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_compensate_pedestal.schema.yml

@@ -0,0 +1,50 @@
+%YAML 1.2
+---
+title: Schema for fadc_compensate_pedestal 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: fadc_compensate_pedestal
+description: |-
+  Emulate FADC pedestal compensation (as e.g., done in camera firmware using FPGAs)
+  to homogenise significant pixel-to-pixel variations of raw pedestals values
+  (for high-gain channel for dual-gain readout).
+  The resulting values are still unsigned integers and no rescaling takes place
+  (pure integer pedestal offset). No compensation takes place for the default value
+  of "-1".  Values greater or equal to zero indicate the compensated pedestal value,
+  rounded to the nearest integer. For DC-coupled sensors, the compensation includes
+  any NSB pedestal shift. For cameras with multiple interlaced FADCs per channel and,
+  therefore, multiple pedestal values, the same integer compensation gets applied to
+  all pedestals of a channel. While the normal pedestal reported in the data includes
+  the compensation, the individual compensations applied for each pixel are reported
+  separately. If individual FADC values would fall below zero through this compensation,
+  they are clipped at zero.
+short_description: Emulation of FADC pedestal compensation.
+data:
+  - type: int
+    unit: dimensionless
+    default: -1
+    allowed_range:
+      min: -1
+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_dev_pedestal.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for fadc_dev_pedestal 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: fadc_dev_pedestal
+developer_note: |-
+  Not applicable for CTA telescopes.
+  TODO - decide if we should list parameters which are not relevant
+  for CTA (don't think we should).
+description: |-
+  Deviation of (F)ADCs pedestals in a single channel.
+  (for high-gain channel in case of dual-readout chain).
+data:
+  - type: double
+    description: |-
+      Deviation of (F)ADCs pedestals
+      (for high-gain channel in case of dual-readout chain).
+    unit: dimensionless
+    default: 0.
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - None
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_err_compensate_pedestal.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for fadc_err_compensate_pedestal 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: fadc_err_compensate_pedestal
+description: |-
+  R.M.S. error on the pedestal evaluation for the compensation step
+  (for high-gain channel for dual-gain readout). Accounts for the
+  inexact pedestal compensation (as camera firmware or server
+  evaluate the actual pedestal from a finite number of samples/events).
+  Used only when fadc_compensate_pedestal is activated.
+short_description: R.M.S. error on the pedestal evaluation for the compensation step.
+data:
+  - type: double
+    unit: dimensionless
+    default: 0.
+    allowed_range:
+      min: 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_err_pedestal.schema.yml

@@ -0,0 +1,49 @@
+%YAML 1.2
+---
+title: Schema for fadc_err_pedestal 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: fadc_err_pedestal
+developer_note: |-
+  TODO - check if this is relevant as this affects only the reported
+  pedestals (which are not used in the reconstruction).
+description: |-
+  Assumed error (Gaussian r.m.s.) in initial calibration of pedestal
+  (for high-gain channel for dual-gain readout).
+  The calibration is based on a limited number of events and therefore the
+  reported pedestal value is not exactly what is used in the simulation.
+  The parameter affects only the reported pedestal
+  (reported as monitoring data), not the true pedestals used in the
+  simulation.
+short_description: |-
+  Assumed error in initial calibration of pedestal
+  (affects only the reported pedestal).
+data:
+  - type: double
+    default: 0.08
+    description: |-
+      Error in pedestal calibration
+      (for high-gain channel in case of dual-readout chain).
+    unit: count
+    allowed_range:
+      min: 0.
+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_lg_amplitude.schema.yml

@@ -0,0 +1,47 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_amplitude 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: fadc_lg_amplitude
+description: |-
+  Peak amplitude at ADC/FADC (low-gain channels).
+  fadc_amplitude are ADC counts maximum amplitude above pedestal
+  (per time slice) for a photo-electron with average (not most probable)
+  signal.  This is after photo detector, preamplifier, cable, and shaper
+  at the input of the ADC or FADC.
+short_description: Peak amplitude above pedestal for a photo electron with average
+  signal (low-gain channels).
+data:
+  - type: double
+    description: FADC amplitude (for low-gain channel in case of dual-readout chain).
+    unit: count
+    condition: num_gains==2
+    default: 1.
+    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_lg_compensate_pedestal.schema.yml

@@ -0,0 +1,51 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_compensate_pedestal 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: fadc_lg_compensate_pedestal
+description: |-
+  Emulate FADC pedestal compensation (as e.g., done in camera firmware using FPGAs)
+  to homogenise significant pixel-to-pixel variations of raw pedestals values
+  (for low-gain channel for dual-gain readout).
+  The resulting values are still unsigned integers and no rescaling takes place
+  (pure integer pedestal offset). No compensation takes place for the default value
+  of "-1".  Values greater or equal to zero indicate the compensated pedestal value,
+  rounded to the nearest integer. For DC-coupled sensors, the compensation includes
+  any NSB pedestal shift. For cameras with multiple interlaced FADCs per channel and,
+  therefore, multiple pedestal values, the same integer compensation gets applied to
+  all pedestals of a channel. While the normal pedestal reported in the data includes
+  the compensation, the individual compensations applied for each pixel are reported
+  separately. If individual FADC values would fall below zero through this compensation,
+  they are clipped at zero.
+short_description: Emulation of FADC pedestal compensation.
+data:
+  - type: int
+    unit: dimensionless
+    default: -1
+    condition: num_gains==2
+    allowed_range:
+      min: -1
+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_dev_pedestal.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_dev_pedestal 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: fadc_lg_dev_pedestal
+developer_note: |-
+  Not applicable for CTA telescopes.
+  TODO - decide if we should list parameters which are not relevant
+  for CTA (don't think we should).
+description: |-
+  Deviation of (F)ADCs pedestals in a single channel (low-gain channels).
+data:
+  - type: double
+    description: |-
+      Deviation of (F)ADCs pedestals (for low-gain channels).
+    unit: dimensionless
+    default: -1.
+    condition: num_gains==2
+    allowed_range:
+      min: -2.0
+instrument:
+  class: Camera
+  type:
+    - None
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateReadout
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_lg_err_compensate_pedestal.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_err_compensate_pedestal 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: fadc_lg_err_compensate_pedestal
+description: |-
+  R.M.S. error on the pedestal evaluation for the compensation step
+  (for low-gain channel for dual-gain readout). Accounts for the
+  inexact pedestal compensation (as camera firmware or server
+  evaluate the actual pedestal from a finite number of samples/events).
+  Used only when fadc_compensate_pedestal is activated.
+short_description: R.M.S. error on the pedestal evaluation for the compensation step.
+data:
+  - type: double
+    unit: dimensionless
+    default: -1.
+    allowed_range:
+      min: -1.
+    condition: num_gains==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_err_pedestal.schema.yml

@@ -0,0 +1,49 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_err_pedestal 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: fadc_lg_err_pedestal
+developer_note: |-
+  TODO - check if this is relevant as this affects only the reported
+  pedestals (which are not used in the reconstruction).
+description: |-
+  Assumed error (Gaussian r.m.s.) in initial calibration of pedestal (low-gain channels).
+  The calibration is based on a limited number of events and therefore the
+  reported pedestal value is not exactly what is used in the simulation.
+  The parameter affects only the reported pedestal
+  (reported as monitoring data), not the true pedestals used in the
+  simulation.
+short_description: |-
+  Assumed error in initial calibration of pedestal
+  (low-gain channels; affects only the reported pedestal).
+data:
+  - type: double
+    description: |-
+      Error in pedestal calibration
+      (for low-gain channel in case of dual-readout chain).
+    unit: count
+    default: -1.
+    condition: num_gains==2
+    allowed_range:
+      min: -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/fadc_lg_max_signal.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_max_signal 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: fadc_lg_max_signal
+description: |-
+  Maximum value of digitized signal per sample (low-gain channels).
+  For a typical 12-bit ADC this would be 4095.
+short_description: Maximum value of digitized signal per sample (low-gain channels).
+data:
+  - type: int
+    description: |-
+      Maximum FADC signal
+      (for low-gain channel in case of dual-readout chain).
+    condition: num_gains==2
+    unit: count
+    default: -1
+    allowed_range:
+      min: -2
+      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_lg_max_sum.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_max_sum 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: fadc_lg_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 (low-gain channels).
+  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 (low-gain channels).
+data:
+  - type: int
+    description: |-
+      Maximum value of a pulse sum
+      (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:
+    - None
+activity:
+  setting:
+    - None
+  validation:
+    - None
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/fadc_lg_noise.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for fadc_lg_noise 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: fadc_lg_noise
+description: |-
+  Gaussian r.m.s. spread of white noise per time bin in digitisation
+  (for low-gain channel, if different gains are used).
+short_description: Gaussian r.m.s. spread of white noise per time bin in digitisation (low-gain channels).
+data:
+  - type: double
+    description: |-
+      Gaussian r.m.s. spread of white noise per time bin in digitisation
+      (for low-gain channel in case of dual-readout chain)
+    condition: num_gains==2
+    unit: count
+    default: 1.3
+    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