Skip to content

Update Readme and template config #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SusanneGlaessel merged 1 commit into from
Mar 27, 2026
Merged

Update Readme and template config #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,19 @@ make -j install
The program is configured with a JSON config file which contains various settings related to input and output as well as the decays to reconstruct. In the following, the different blocks and fields are explained. In `at_interface/config/config_template.json` all available JSON fields are listed.

### io
| Key | Description |
| --------------------------| --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `input_treename` | name of the input AnalysisTree (for standard analysistree `rTree`, after running PID framework `pTree`) |
| `rectracks_branchname` | branchname of reconstructed tracks in input analysistree, default names: `VtxTracks` for standard analyistree, `RecParticles` after running Pid-framework |
| `n_events` | number of events to be processed, set to `-1` to process all events |
| `save_options` (optional) | defines save options for the candidates of all decays in this config (see next table) |

| `save_options` Flag | Description |
| --------------------------| --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `make_plain_tree` | normal root tree containing the candidates is written besides the default output tree in AnalysisTree format |
| `signal_only` | save only mc-true signal candidates |
| `write_detailed_bg` | detailed background information in output variable `generation`* |
| Key | Description |
| ----------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `input_treename` | name of the input AnalysisTree (for standard analysistree `rTree`, after running PID framework `pTree`) |
| `rectracks_branchname` | branchname of reconstructed tracks in input analysistree, default names: `VtxTracks` for standard analyistree, `RecParticles` after running Pid-framework |
| `receventheader_branchname` | branchname of reconstructed event header in input analysistree, default names: `RecEventHeader` for standard analyistree, `AnaEventHeader` after running centrality-framework |
| `n_events` | number of events to be processed, set to `-1` to process all events |
| `save_options` (optional) | defines save options for the candidates of all decays in this config (see next table) |

| `save_options` Flag | Description |
| ----------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `make_plain_tree` | normal root tree containing the candidates is written besides the default output tree in AnalysisTree format |
| `signal_only` | save only mc-true signal candidates |
| `write_detailed_bg` | detailed background information in output variable `generation`* |

*Format of detailed background information in the `generation` variable:

Expand Down
1 change: 1 addition & 0 deletions at_interface/configs/config_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"io" : {
"input_treename" : "name_tree", // "rTree" for standard analysistree, "pTree" after running PID-framework (for pid_mode > 2)
"rectracks_branchname" : "name_tracks", // "VtxTracks" for standard analyistree, "RecParticles" after running Pid-framework (for pid_mode > 2)
"receventheader_branchname" : "name_eh", // "RecEventHeader" for standard analyistree, "AnaEventHeader" after running centrality-framework
"n_events" : -1,
"save_options": ["make_plain_tree", "write_detailed_bg" , "signal_only"]
},
Expand Down
Loading