examples/howto/gsf_debugger.md

0001 # GSF Debugger
0002
0003 Python utility to visualize the `VERBOSE` log of a GSF track in ACTS. In general, the infrastructure could be used to also display tracks of other fitters with little adjustments.
0004
0005 ## Usage
0006
0007 In order to run, the utility requires a logfile and a geometry description as CSV file (this can be produced using the CSV geometry writer in the examples framework):
0008
0009 ```bash
0010 python3 acts/Examples/Scripts/GsfDebugger/src/main.py --logfile <path-to-logfile> --detector <path-to-detector-csv>
0011 ```
0012
0013 Alternatively, it can also used via piping:
0014 ```bash
0015 ./my_gsf_script.py | acts/Examples/Scripts/GsfDebugger/src/main.py --detector <path-to-detector-csv>
0016 ```
0017
0018 ## Screenshots
0019
0020 This section shows some screenshots of the provided views:
0021
0022 ![gsf_debugger_0](figures/gsf_debugger/gsf_debugger_0.jpg)
0023
0024 ![gsf_debugger_1](figures/gsf_debugger/gsf_debugger_1.jpg)
0025
0026 ![gsf_debugger_2](figures/gsf_debugger/gsf_debugger_2.jpg)
0027
0028 ![gsf_debugger_4](figures/gsf_debugger/gsf_debugger_4.jpg)
0029
0030 ![gsf_debugger_5](figures/gsf_debugger/gsf_debugger_5.jpg)