A User’s Guide to Template Synthesis¶
Here we give a general overview of how the template synthesis method works. It is not meant as an in-depth description of the algorithm, but rather as a guide to help you understand how to use the package. In The template synthesis algorithm we describe the algorithm on a high-level. For more details, please refer to the publications mentioned on the homepage of the package.
Using Template Synthesis¶
The simplest way to use template synthesis is with the smiet.core.SMIETRun class, which handles all necessary steps (loading origin showers, loading target showers, synthesising them, and extracting relevant quantities). More details can be found in SMIETRun.
If you need to have more control over the synthesis process, you can also use the lower-level classes directly, as described below.
Origin Showers¶
In order to use template synthesis, you can either: - download the origin shower library (~ 13 GB when unpacked) that contains the pre-simulated origin showers on the vx(vxB) arm, or - generate your own origin showers.
Some guidance and general tips on how to do this can be found in Origin Showers.
Synthesising Target Showers¶
Once you have the origin showers, you can use them to synthesise traces from target showers. This is done via TemplateSynthesis class. More details are given in The template synthesis workflow.
- The template synthesis algorithm
- SMIETRun
- Requirements
- Initializing the SMIETRun Object
- (Optional) Generating Templates
- Loading the Templates
- Generating and Setting Target Showers
- Synthesizing the Target Showers
- Extracting Quantities
- Minimal Example
- API documentation
- Origin Showers
- Origin Shower Library
- Generating the origin showers
- The template synthesis workflow
- Transforming synthesised traces on the vxvxB axis to a star-shape antenna layout
- Treating synthesised traces for antennas along the vxB axis