Warning, /EICrecon/src/benchmarks/reconstruction/tof_efficiency/README.md is written in an unsupported language. File is not indexed.
0001 To run this plugin with tracking
0002
0003 ```bash
0004 eicrecon
0005 -Pplugins=tof_efficiency
0006 -Pnthreads=1
0007 -PBTOF:TOFBarrelRawHit:LogLevel=trace
0008 -Ptof_efficiency:LogLevel=trace
0009 -Pjana:debug_plugin_loading=1
0010 -Pjana:nevents=100
0011 -Pjana:timeout=0
0012 -Pdd4hep:xml_files=epic.xml
0013 -Ppodio:output_file=/home/romanov/work/data/eicrecon_test/tof_test.ana.edm4hep.root
0014 -Phistsfile=/home/romanov/work/data/eicrecon_test/tof_test.ana.root
0015 /home/romanov/eic/combined_benchmarks/test_data_generator/2022-11-07_pgun_e-_epic_arches_e0.01-30GeV_alldir_1prt_1000evt.edm4hep.root
0016 ```
0017
0018 Flags explained:
0019 ```bash
0020 #This flag lists plugins(submodules) needed to run tracking reconstruction and analysis
0021 -Pplugins=acts,tracking,BTRK,ECTRK,BVTX,MPGD,tracking_occupancy,tracking_efficiency
0022
0023 # Number of parallel threads. Currently only 1 works.
0024 # It is a limitation of an event model IO and will be fixed later
0025 -Pnthreads=1
0026
0027 # Write exactly what happens when plugins are loading. Good during debugging time.
0028 -Pjana:debug_plugin_loading=1
0029
0030 # Removes self "hang" watchdog.
0031 # Needed during debugging if you pause code execution with breakpoints
0032 -Pjana:timeout=0
0033
0034
0035 # Number of events to process.
0036 # (If events needs to be skipped there is also -Pjana:nskip flag)
0037 -Pjana:nevents=100
0038
0039 # xxx:LogLevel - various plugins/factories logging levels
0040 # trace, debug, info, warn, error, critical, off:
0041 # trace - something very verbose like each hit parameter
0042 # debug - all information that is relevant for an expert to debug but should not be present in production
0043 # info - something that will always (almost) get into the global log
0044 # warning - something that needs attention but results are likely usable
0045 # error - something bad that makes results probably unusable
0046 # critical - imminent software failure and termination
0047 # Logging explained here:
0048 https://github.com/eic/EICrecon/blob/main/docs/Logging.md
0049
0050
0051 # DD4Hep xml file for the detector describing the geometry.
0052 # Can be set by this flag or env. variables combinations: ${DETECTOR_PATH}/${DETECTOR}.xml
0053 -Pdd4hep:xml_files=...
0054
0055 # Example 1: full path to detector.xml
0056 -Pdd4hep:xml_files=/path/to/dd4hep/epic/epic_tracking_only.xml
0057
0058 # Example2: DETECTOR_PATH env var is set in eic_shell, so it could be
0059 -Pdd4hep:xml_files=${DETECTOR_PATH}/epic_tracking_only.xml
0060
0061
0062 # Alternatively it could be set through environment variables to not to add -Pdd4hep:xml_files every run
0063 # Then -Pdd4hep:xml_files flag is not needed. (!) Note that ".xml" is not needed in ${DETECTOR}
0064 export DETECTOR_PATH="/path/to/dd4hep/epic/"
0065 export DETECTOR="epic_tracking_only"
0066
0067 # This makes tracking output data and input MC particles to be written to the output
0068 -Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"
0069
0070 # There is a centralized file where plugins can save their histograms:
0071 -Phistsfile=/home/romanov/work/data/eicrecon_test/tracking_test_gun.ana.root
0072
0073 # all filenames that doesn't start with -<flag> are interpreted as input files
0074 # So this is an input file path
0075 /home/romanov/work/data/eicrecon_test/output.edm4hep.root
0076 ```
0077
0078 ### Saving collections to a file
0079
0080 In order to save podio data to the file one has to provide 2 parameters
0081 defining a list of objects and the output file name:
0082
0083 ```bash
0084 # This makes tracking output data and input MC particles to be written to the output
0085 -Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"
0086
0087 # This sets file path containing output tree
0088 -Ppodio:output_file=/home/romanov/work/data/eicrecon_test/tracking_test_gun.edm4eic.root
0089 ```
0090
0091 One can see the list of data names, when eicrecon is running:
0092
0093 ```
0094 FACTORIES
0095 ----------------------------------------------------------------------------------
0096 Plugin Object name Tag
0097 ----------- ------------------------------------- ------------------------------
0098 ...
0099 tracking.so edm4eic::TrackParameters TrackParameters
0100 tracking.so edm4eic::ReconstructedParticle ReconstructedParticles
0101 ... ^
0102 this name
0103 ```
