Warning, /acts/docs/examples/howto/digitization_config.md is written in an unsupported language. File is not indexed.
0001 # Generate a configuration file for the smearing digitizer
0002
0003 As a convenience, a simple helper script is provided to help producing JSON configuration files for smearing digitization.
0004 The script is located in the source tree at `Examples/Algorithms/Digitization/scripts/smearing-config.py`.
0005
0006 Each volume configuration is one logical block consisting of the following options:
0007
0008 * `--digi-smear-volume=X`: Specifies the numeric identifier of the
0009 volume configured in the present block. This option also acts as a
0010 delimiter for different blocks.
0011 * `--digi-smear-indices=X[:Y...]`: Specifies the dimensions to be configured in a comma-delimited list
0012 * `--digi-smear-types=X[:Y...]`: Specifies the smearer type for each dimension. The following values are allowed:
0013 * 0: Gaussian
0014 * 1: Truncated gaussian
0015 * 2: Clipped gaussian
0016 * 3: Uniform
0017 * 4: Digital
0018 * `--digi-smear-parameters=X[:Y...]`: Configuration parameters, 1 for Gaussian, 3 for all others (1 parameter, 2 range values)
0019
0020 Such blocks may be repeated as often as needed to configure many volumes, but each block has to begin with `--digi-smear-volume` and must contain all of the above arguments.
0021
0022 ## Example
0023
0024 The following snippet will print a JSON string containing the
0025 configuration for two different volumes. The first volume applies
0026 gaussian smearing to the first two spatial dimensions and uniform
0027 smearing to the time dimension. Correspondingly, the parameter list
0028 for this volume has five entries: two for the simple Gaussians and
0029 three for the uniform smearer. After this, another volume gets only
0030 one spatial dimension smeared by a simple gaussian.
0031
0032 ```bash
0033 Examples/Algorithms/Digitization/scripts/smearing-config.py \
0034 --digi-smear-volume=8 \
0035 --digi-smear-indices=0:1:5 \
0036 --digi-smear-types=0:0:3 \
0037 --digi-smear-parameters=10:20:2.5:-25:25 \
0038 --digi-smear-volume=11 \
0039 --digi-smear-indices=1 \
0040 --digi-smear-types=0 \
0041 --digi-smear-parameters=12.5
0042 ```