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

simtools/schemas/model_parameters/disc_bins.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for disc_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: disc_bins
+description: |-
+  Number of time bins used for the discriminator or comparator simulation.
+  This trigger simulation might cover a larger time window than the
+  FADC signals.
+short_description: Number of time bins used for the discriminator simulation.
+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
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/disc_start.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for disc_start 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: disc_start
+description: |-
+  Number of time bins by which the discriminator or comparator simulation
+  is ahead of the FADC readout. That is mainly relevant if different time
+  windows are simulated for comparator inputs and digitized ADC values.
+short_description: |-
+  Number of time bins by which the discriminator simulation is ahead of
+  the FADC readout.
+data:
+  - type: uint
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+      max: 159
+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

simtools/schemas/model_parameters/discriminator_amplitude.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for discriminator_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: discriminator_amplitude
+developer_note: |-
+  TODO - Units of mV are always used for CTA. Expect that this will
+  continue to be the case in future.
+  Note - sim_telarray array allows definition with arbitrary units
+  (same definition of units required for discriminator_threshold).
+description: |-
+  Signal amplitude after amplifier per mean p.e. at the input of the
+  discriminators/comparators.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: double
+    unit: mV
+    default: 1.0
+    condition: default_trigger==AnalogSum or default_trigger==Majority
+    allowed_range:
+      min: 0.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_fall_time.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for discriminator_fall_time 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: discriminator_fall_time
+description: |-
+  Fall time of discriminator/comparator output after the logical output
+  is reset to false.
+short_description: |-
+  Fall time of the discriminator output after the logical output is
+  reset to false.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: double
+    unit: ns
+    default: 1.0
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+      max: 100.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_gate_length.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for discriminator_gate_length 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: discriminator_gate_length
+description: |-
+  Effective discriminator gate length. To achieve a comparator-type
+  response this gate length must match the time over threshold below.
+  Use negative values for strict discriminator type, positive values
+  for comparator or updating discriminator type.
+short_description: Effective discriminator gate length.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: double
+    unit: ns
+    default: 2.0
+    condition: default_trigger==Majority
+    allowed_range:
+      min: -100.0
+      max: 100.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_hysteresis.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for discriminator_hysteresis 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: discriminator_hysteresis
+description: |-
+  The switching off of a comparator is normally with some hysteresis to
+  avoid oscillating behavior. As a consequence, the signal has to be
+  below the threshold minus the hysteresis before it switches off.
+short_description: Value of the discriminator hysteresis.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: double
+    unit: mV
+    default: 0.0
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_output_amplitude.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for discriminator_output_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: discriminator_output_amplitude
+description: |-
+  The nominal output amplitude of a pixel discriminator or comparator as
+  seen at the sector (trigger group) coincidence unit.
+short_description: |-
+  The nominal output amplitude of a pixel discriminator as seen at the
+  trigger group coincidence unit.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: double
+    unit: mV
+    default: 42.0
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_output_var_percent.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for discriminator_output_var_percent 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: discriminator_output_var_percent
+description: |-
+  Channel-to-channel variation (Gaussian r.m.s.) of the output amplitude
+  of a pixel discriminator or comparator.
+short_description: |-
+  Channel-to-channel variation (Gaussian r.m.s.) of the output amplitude
+  of a pixel discriminator.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+data:
+  - type: double
+    unit: pct
+    default: 10.0
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+      max: 50.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_pulse_shape.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for discriminator_pulse_shape 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: discriminator_pulse_shape
+description: Pulse shape at the discriminator/comparator of an individual pixel.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'unspecified_shape.dat'
+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/discriminator_rise_time.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for discriminator_rise_time 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: discriminator_rise_time
+description: |-
+  Rise time of the discriminator/comparator output. After the
+  discriminator/comparator logical output is set true, the output
+  signal linearly rises from 0 to 100\% within the given time period.
+short_description: |-
+  Rise time of the discriminator output. The output signal rises linearly
+  within time frame.
+data:
+  - type: double
+    unit: ns
+    default: 1.0
+    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:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_scale_threshold.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for discriminator_scale_threshold 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: discriminator_scale_threshold
+description: |-
+  Scale factor for discriminator or comparator threshold
+  and its variations.
+short_description: Discriminator/comparator threshold scale factor.
+data:
+  - type: double
+    default: 1.0
+    unit: dimensionless
+    allowed_range:
+      min: 0.5
+      max: 2.
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_sigsum_over_threshold.schema.yml

@@ -0,0 +1,44 @@
+%YAML 1.2
+---
+title: Schema for discriminator_sigsum_over_threshold 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: discriminator_sigsum_over_threshold
+developer_note: |-
+  Intended as mV * ns, but if unit of
+  discriminator_time_over_threshold is not mV,
+  it scales accordingly.
+description: |-
+  Integrated signal required over threshold. See also
+  discriminator_time_over_threshold above for combined effects. If
+  discriminator_time_over_threshold is not mV, it scales
+  accordingly.
+short_description: Integrated signal required over threshold.
+data:
+  - type: double
+    unit: mV * ns
+    condition: default_trigger==Majority
+    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:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_threshold.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for discriminator_threshold 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: discriminator_threshold
+description: Discriminator/comparator threshold.
+data:
+  - type: double
+    unit: mV
+    default: 4.0
+    allowed_range:
+      min: 0.0
+    condition: default_trigger==Majority
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetTriggerThresholdsFromRateScan
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_time_over_threshold.schema.yml

@@ -0,0 +1,45 @@
+%YAML 1.2
+---
+title: Schema for discriminator_time_over_threshold 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: discriminator_time_over_threshold
+description: |-
+  Time over threshold required before logic response switches to true.
+  To achieve a comparator-type response this time must match the gate
+  length above.  Note that in addition a minimum signal integral
+  discriminator_sigsum_over_threshold may be set up. If so, both time over
+  threshold and signal integral conditions have to be met before a `true'
+  output signal starts. Normally, either of them being non-zero should be
+  sufficient.
+short_description: Time over threshold required before logic response switches to
+  true.
+data:
+  - type: double
+    unit: ns
+    default: 1.5
+    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:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_var_gate_length.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for discriminator_var_gate_length 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: discriminator_var_gate_length
+description: |-
+  Variation of gate length (Gaussian r.m.s.). In comparator-type
+  response, this variable is not used but only
+  discriminator_var_time_over_threshold.
+short_description: Variation of gate length (Gaussian r.m.s).
+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:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_var_sigsum_over_threshold.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for discriminator_var_sigsum_over_threshold 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: discriminator_var_sigsum_over_threshold
+developer_note: |-
+  Intended as mV * ns, but if unit of
+  discriminator_time_over_threshold is not mV,
+  it scales accordingly.
+description: |-
+  Gaussian r.m.s. spread of discriminator_sigsum_over_threshold
+  (Pixel-to-pixel variation).
+data:
+  - type: double
+    unit: mV * ns
+    default: 0.0
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Observation execution
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/discriminator_var_threshold.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for discriminator_var_threshold 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: discriminator_var_threshold
+description: |-
+  Channel-to-channel variations (random Gaussian r.m.s.) of
+  discriminator/comparator threshold.
+short_description: Channel-to-channel variation of discriminator threshold.
+data:
+  - type: double
+    unit: mV
+    default: 0.2
+    condition: default_trigger==Majority
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray