Skip to content

User guide

Liam P. Gaffney edited this page Apr 9, 2025 · 3 revisions

Quick Start

This section provides a quick overview of how to use ISSSort after installation — from configuring the necessary input files to running your first sorting job and checking the output. It assumes that ISSSort has already been compiled and that a working ROOT installation with MathMore support is available, as described in the Installation section.

Example input files

The input files used in the example below (test_ruther_lume_10_89_deg_C12_only_c2d4_pdg.ebye, settings.dat, calibration.dat, and reaction.dat) can be downloaded from the following link: https://fy.chalmers.se/subatom/ebye_example/

You can use them for testing or as a reference for formatting your own files.

Running the sorter

To execute ISSSort, use the following command line:

iss_sort

or

./bin/iss_sort

If no flags are provided, the program will launch the GUI. To run in batch mode, simply provide at least one input file using the -i flag. The supported format for input data files is .ebye. A typical sorting command is:

./bin/iss_sort -i test_ruther_lume_10_89_deg_C12_only_c2d4_pdg.ebye -s settings.dat -c calibration.dat -r reaction.dat

The -s, -c, and -r flags specify the settings file, calibration file, and reaction file, respectively. The order of the flags is not important.

If ISSSort runs correctly, four output files will be created in the sorted/ directory, named after the input file:

  • <input_filename>.root: converted version of the .ebye file, containing raw or calibrated data and a ROOT tree.
  • <input_filename>_events.log: log file with information from the event-building process.
  • <input_filename>_events.root: time-sorted, structured event data accessible via the ISSEvts class.
  • <input_filename>_hists.root: standard physics histograms created using the reaction file.

Inspecting output files

Navigate to the sorted/ directory and start ROOT with:

root -l test_ruther_lume_10_89_deg_C12_only_c2d4_pdg_events.root

At the ROOT prompt, you can display a simple 2D histogram with:

evt_tree->Draw("lume_event.be:lume_event.x>>h(100,-1.1,1.1,200,,)","lume_event.id==2","colz")

This shows the deposited energy vs. hit position (with x=1 being the most upstream edge of the detector) in the third LUME detector.

Alternatively, you can explore the contents using the ROOT browser:

new TBrowser

Running a full analysis

Clone this wiki locally