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