Migrating track length code from TOFEstimators into separate processor

iLCSoft / MarlinReco

GNU General Public License v3.0

4 stars 40 forks source link

Migrating track length code from TOFEstimators into separate processor #104

Closed dudarboh closed 2 years ago

dudarboh commented 2 years ago

BEGINRELEASENOTES

Migrated track length and mean harmonic momentum code from TOFEstimators into separate TrackLengthProcessor to save CPU computing time.
NOTE: If you have been using these processors outside of the standard reconstruction chain you will have to update your steering files (see iLCSoft/ILDConfig#133 for the necessary changes)

ENDRELEASENOTES

TODOs:

[x] Finish migrating and cleaning up all relevant code to the TrackLengthProcessor
[x] Do clean up of the TOFEstimators leaving only TOF related methods and output
[x] Test the results with some example script, which uses both processors TOFEstimators and TrackLengthProcessor to calculate the mass distributions.
[x] Update the documentation of both processors accordingly

dudarboh commented 2 years ago

I had a small test script to plot mass distribution.

I used 400 events from a single file: /pnfs/desy.de/ilc/prod/ilc/mc-2020/ild/rec/250-SetA/2f_hadronic_eL_pR/ILD_l5_o1_v02/v02-02/00015161/000/rv02-02.sv02-02.mILD_l5_o1_v02.E250-SetA.I500010.P2f_z_h.eL.pR.n001_209.d_rec_00015161_259.slcio

Results before/after splitting the code look identical as it should be. (sorry for slightly different image resolution)...

Code of trackLength and time-of-flight were already very well separated in different methods of TOFEstimators, so I it was very easy to copy whole methods without changing any logic inside so it is hard to mess something up here..

dudarboh commented 2 years ago

Concerning doxygen documentation:

MarlinReco/doc/Doxyfile looks very obsolete and does not include more than half of the processors inside MarlinRecoincluding TOFEstimators and TrackLength now: https://github.com/iLCSoft/MarlinReco/blob/a5ab3762ce8993c1631cdcecd1665503271c7979/doc/Doxyfile#L358

Full file list from iLCSoftDoc web page looks like this:

I would happily update this doxygen if there is a green light...

tmadlener commented 2 years ago

Hi @dudarboh, please go ahead with the doxygen fixes. If it is easily possible, could you put them into a separate PR to not let this one get even larger?

dudarboh commented 2 years ago

"... moving code from one part to another (or did I miss something substantial?)"

You didn't miss anything. It is indeed only moving the code.

And thanks for useful highlight tips :)