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

simtools/schemas/model_parameters/pm_average_gain.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for pm_average_gain 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: pm_average_gain
+description: |-
+  Photo detector average gain. Used to determine the DC currents
+  from night-sky background (NSB) pixel rates.
+data:
+  - type: double
+    default: 40000.0
+    allowed_range:
+      min: 10000.0
+      max: 30000000.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateNightSkyBackgroundMeasurement
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pm_collection_efficiency.schema.yml

@@ -0,0 +1,40 @@
+%YAML 1.2
+---
+title: Schema for pm_collection_efficiency 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: pm_collection_efficiency
+developer_note: Always set to 1. for CTA cameras.
+short_description: |-
+  Photoelectron collection efficiency at the first stage of the photo
+  detector.
+description: |-
+  Photoelectron collection efficiency at the first stage of the photo
+  detector. The default value is 1.0 since in most cases the non-amplified
+  photo-electrons are included in the amplitude distribution of the
+  single-p.e. spectrum.
+data:
+  - type: double
+    unit: dimensionless
+    allowed_range:
+      min: 0.01
+      max: 1.0
+    default: 1.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pm_gain_index.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for pm_gain_index 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: pm_gain_index
+description: |-
+  PMT gain g and voltage U are assumed to be related by
+  the PMT gain index p through $g \propto U^{p}$.
+  Used only for PMT timing.
+data:
+  - type: double
+    unit: dimensionless
+    default: 4.0
+    allowed_range:
+      min: 0.0
+      max: 15.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraTimeResponse
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pm_photoelectron_spectrum.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for pm_photoelectron_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: pm_photoelectron_spectrum
+description: |-
+  Single photoelectron (p.e.) response distribution
+  (takes into account afterpulsing and the photoelectron collection
+  efficiency for PMT cameras).
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_pe_spectrum.dat'
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetSinglePhotoElectronResponse
+  validation:
+    - ValidateParameterByExpert
+    - ValidateSinglePhotoElectronResponse
+    - ValidateCameraChargeResponse
+    - ValidateCameraLinearity
+    - ValidateCameraGainsAndEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pm_transit_time.schema.yml

@@ -0,0 +1,63 @@
+%YAML 1.2
+---
+title: Schema for pm_transit_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: pm_transit_time
+description: Total transit time of the photodetector at the average voltage.
+data:
+  - name: pm_transit_time_at_average_voltage
+    type: double
+    description: Total transit time of the PMT at the average voltage.
+    unit: ns
+    default: 20.
+    allowed_range:
+      min: 0.0
+  - name: pm_transit_time_to_first_dynode
+    type: double
+    description: |-
+      Fixed transit time between cathode and first dynode, in case of
+      the first dynode being stabilized. Use zero for a passive divider.
+    unit: ns
+    default: 9.7
+    allowed_range:
+      min: 0.0
+  - name: fixed_voltage_first_dynode
+    type: double
+    description: |-
+      The fixed voltage (or fraction of total nominal voltage) applied to
+      a stabilized first dynode. Use zero for a passive divider.
+    unit: V
+    default: 300.
+    allowed_range:
+      min: 0.0
+    developer_note: "This parameter can describe in sim_telarray the fraction of total\n\
+      nominal voltage in case total nominal voltage is set to zero."
+  - name: total_nominal_voltage
+    type: double
+    default: 1100.
+    description: Total nominal voltage.
+    unit: V
+    allowed_range:
+      min: 0.0
+    developer_note: "If zero (or one), the third value of the fixed voltage is assumed\
+      \ to\nrepresent the fraction of the total nominal voltage in sim_telarray."
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTS
+    - MSTN
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraTimeResponse
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/pm_voltage_variation.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for pm_voltage_variation 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: pm_voltage_variation
+short_description: |-
+  Fractional high voltage variation, used to adjust the transit time
+  variations ($\propto 1/\sqrt(V)$).
+description: |-
+  Fractional high voltage variation, used to adjust the transit time
+  variations ($\propto 1/\sqrt(V)$).  The parameter sets the Gaussian
+  r.m.s. spread of random voltage fluctuations,
+  \texttt{V = RandGaus(1., pm_voltage_variation)}.
+data:
+  - type: double
+    unit: dimensionless
+    default: 0.03
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraTimeResponse
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/primary_mirror_degraded_map.schema.yml

@@ -0,0 +1,42 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_degraded_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. Accepted range is 0 to 1
+name: primary_mirror_degraded_map
+description: |-
+  Position-dependent map of degradation factors for the primary mirror.
+  This degradation gets applied on top of mirror_degraded_reflection.
+  Note that the impact of it on the nightsky background is not automatically
+  accounted for and must be evaluated separately and included in the
+  configured NSB pixel p.e. rates. It is recommended to use a map with an
+  average efficiency of 1.0 and use mirror_degraded_reflection
+  for the overall degradation.  Tables with equidistant spacing in both x and
+  y are highly recommended because the interpolation is faster.
+short_description: |-
+  Position-dependent map of degradation factors for the primary mirror.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateTelescopeShadowing
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: primary_degraded_map

simtools/schemas/model_parameters/primary_mirror_diameter.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_diameter 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: primary_mirror_diameter
+description: |-
+  The outer diameter of the primary reflector.
+  Used only in case mirror_list is not defined (i.e., mirror_list=none).
+data:
+  - name: primary_mirror_diameter
+    type: double
+    unit: cm
+    condition: mirror_list==None&&mirror_class==2
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: primary_diameter

simtools/schemas/model_parameters/primary_mirror_hole_diameter.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_hole_diameter 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: primary_mirror_hole_diameter
+description: |-
+  The diameter of any non-reflective part of the primary mirror.
+data:
+  - name: primary_hole_diameter
+    description: Diameter of central hole in primary mirror.
+    type: double
+    default: 0.
+    unit: cm
+    condition: mirror_class==2
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: primary_hole_diameter

simtools/schemas/model_parameters/primary_mirror_incidence_angle.schema.yml

@@ -0,0 +1,29 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_incidence_angle 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: primary_mirror_incidence_angle
+description: |-
+  Distribution of incidence angle on the SST primary mirror.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_file.dat'
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - SimPipe Derived
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/primary_mirror_parameters.schema.yml

@@ -0,0 +1,168 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_parameters 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: primary_mirror_parameters
+developer_note: |-
+  Note the application of dual_mirror_ref_radius (primary_ref_radius,
+  secondary_ref_radius) this this parameters.
+description: |-
+  Defines the position of the primary mirror along the optical
+  axis and its shape. The first parameter ($p_0$) is the offset of the
+  mirror with respect to the common reference point defined by
+  par:mirror-offset, with positive values indicating that the centre
+  of the primary (assuming it has no central hole) is above the reference
+  point. The secondary mirror looks the other way, i.e. $p_0$ will usually
+  be negative since in the coordinate frame of the secondary, it is
+  below the common reference point.  Apart from that, a parameter $p_i$
+  adds a term $p_i r^{2i}$ to the height of the mirror at
+  radial offset $r$.  A parabolic mirror will have the second parameter
+  ($p_1$) at a positive value and all further parameters at 0.
+  A concave secondary, reducing the focal length if placed between the
+  primary and its focus, will have $p_1 > 0.$.
+  A convex mirror (e.g.~for Cassegrain or Ritchey-Chr\'etien optics),
+  enlarging the focal length, will have $p_1 < 0$.
+short_description: |-
+  Parameters for a polynomial defining the position of the primary mirror
+  along the optical axis and its shape.
+data:
+  - name: p0
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p1
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p2
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p3
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p4
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p5
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p6
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p7
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p8
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p9
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p10
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p11
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p12
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p13
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p14
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p15
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p16
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p17
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p18
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+  - name: p19
+    type: double
+    description: coefficient describing primary mirror
+    required: true
+    unit: cm
+    default: 0.
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateOpticalPSF
+    - ValidateTelescopeEfficiency
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/primary_mirror_ref_radius.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_ref_radius 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: primary_mirror_ref_radius
+description: |-
+  The length scale to which the primary_mirror_parameters apply.
+  Typical values could be 1.0 or the focal length of the
+  primary/secondary.
+short_description: The length scale to which the primary_mirror_parameters apply.
+data:
+  - name: primary_ref_radius
+    description: The length scale to which the primary_mirror_parameters apply.
+    type: double
+    unit: cm
+    default: 1.0
+    condition: mirror_class==2
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: primary_ref_radius

simtools/schemas/model_parameters/primary_mirror_segmentation.schema.yml

@@ -0,0 +1,34 @@
+%YAML 1.2
+---
+title: Schema for primary_mirror_segmentation 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: primary_mirror_segmentation
+description: |-
+  Definition of segments or segment groups of the primary reflector.
+short_description: |-
+  Definition of segments or segment groups of the primary reflector.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeStructure
+    - ValidateTelescopeShadowing
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray
+    internal_parameter_name: primary_segmentation

simtools/schemas/model_parameters/qe_variation.schema.yml

@@ -0,0 +1,43 @@
+%YAML 1.2
+---
+title: Schema for qe_variation 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: qe_variation
+developer_note: |-
+  DISCUSS - rename to make clear this parameter is used for all
+  photodetectors (not PMTs only).
+description: |-
+  Variation of quantum or photon detection efficiency
+  (Gaussian r.m.s. spread of random fluctuations) between
+  photo detectors in a given camera. Given in fraction of
+  the average quantum or photon detection efficiency; the variation
+  is applied independent of the wavelength.
+data:
+  - type: double
+    unit: dimensionless
+    default: 0.035
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraChargeResponse
+    - ValidateCameraGainsAndEfficiency
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray