feat: Introduce vertex performance writer #776

baschlag · 2021-04-15T09:39:54Z

This PR introduces a vertex performance writer to the examples which enables a full reconstruction chain (with truth tracking) from event generation to vertex reconstruction including vertexing performance writing at the very end.

The changes include:

RootTrajectoryParametersReader has been added.
RootTrajectoryParametersWriter writes tracks now per event to root file.
RootVertexPerformanceWriter added which saves quantities such a number of reco vertices, number of truth vertices and number of max. vertices in acceptance per event. Also x/y/z vertex resolutions.
New TrackReaderVertexingPerformanceWriterExample has been added.
Adds a setter method for Barcodes to the Particle class.

//edit: A more sophisticated reco/true vertex match scheme has been added for the position resolution plots. True and reco vertices are now matched if at least 50% (default) of their tracks coincide.

A full reco chain could e.g. look like this:

# ttbar event generation
./ActsExamplePythia8  --events=200  --output-dir=data/gen/ttbar_mu200 --output-csv  --gen-cms-energy-gev=14000 --gen-hard-process=Top:qqbar2ttbar=on --gen-npileup=200

# simulation
./ActsExampleFatrasGeneric --input-dir=data/gen/ttbar_mu200   --output-dir=data/sim_generic/ttbar_mu200  --output-csv  --select-eta=-2.5:2.5 --select-pt-gev=0.4: --fatras-pmin-gev 0.4 --remove-neutral  --bf-constant-tesla=0:0:2

# truth tracking
./ActsExampleTruthTracksGeneric --input-dir=data/sim_generic/ttbar_mu200 --output-dir=data/reco_generic/ttbar_mu200 --bf-constant-tesla=0:0:2 --digi-config-file ../../Examples/Algorithms/Digitization/share/default-smearing-config-generic.json

# vertexing + performance writing
./bin/ActsExampleVertexFinderTrackReaderPerformanceWriter  --bf-constant-tesla=0:0:2 --input-dir=data/reco_generic/ttbar_mu200 --output-dir=data/vertexing/ttbar_mu200

HadrienG2 · 2021-04-15T10:13:28Z

A full reco chain could e.g. look like this:

# ttbar event generation
./ActsExamplePythia8  --events=200  --output-dir=data/gen/ttbar_mu200 --output-csv  --gen-cms-energy-gev=14000 --gen-hard-process=Top:qqbar2ttbar=on --gen-npileup=200

# simulation
./ActsExampleFatrasGeneric --input-dir=data/gen/ttbar_mu200   --output-dir=data/sim_generic/ttbar_mu200  --output-csv  --select-eta=-2.5:2.5 --select-pt-gev=0.4: --fatras-pmin-gev 0.4 --remove-neutral  --bf-constant-tesla=0:0:2

# truth tracking
./ActsExampleTruthTracksGeneric --input-dir=data/sim_generic/ttbar_mu200 --output-dir=data/reco_generic/ttbar_mu200 --bf-constant-tesla=0:0:2 --digi-config-file ../../Examples/Algorithms/Digitization/share/default-smearing-config-generic.json

# vertexing + performance writing
./bin/ActsExampleVertexFinderTrackReaderPerformanceWriter  --bf-constant-tesla=0:0:2 --input-dir=data/reco_generic/ttbar_mu200 --output-dir=data/vertexing/ttbar_mu200

Since you took the time to collect these commands, may I ask you to integrate them into the CI/run_examples.sh script, so that continuous integration runs these examples, which will give us a stronger guarantee that they keep working across future ACTS evolutions?

(I think we already have a Pythia8 job, which could be adapted to your needs, but the other examples are not covered yet)

codecov · 2021-04-15T10:23:07Z

Codecov Report

Merging #776 (d7ee0d5) into main (df7b197) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #776   +/-   ##
=======================================
  Coverage   48.64%   48.64%           
=======================================
  Files         328      328           
  Lines       16898    16898           
  Branches     7934     7934           
=======================================
  Hits         8220     8220           
  Misses       3080     3080           
  Partials     5598     5598

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update df7b197...d7ee0d5. Read the comment docs.

baschlag · 2021-04-15T12:22:41Z

A full reco chain could e.g. look like this:
# ttbar event generation
./ActsExamplePythia8  --events=200  --output-dir=data/gen/ttbar_mu200 --output-csv  --gen-cms-energy-gev=14000 --gen-hard-process=Top:qqbar2ttbar=on --gen-npileup=200

# simulation
./ActsExampleFatrasGeneric --input-dir=data/gen/ttbar_mu200   --output-dir=data/sim_generic/ttbar_mu200  --output-csv  --select-eta=-2.5:2.5 --select-pt-gev=0.4: --fatras-pmin-gev 0.4 --remove-neutral  --bf-constant-tesla=0:0:2

# truth tracking
./ActsExampleTruthTracksGeneric --input-dir=data/sim_generic/ttbar_mu200 --output-dir=data/reco_generic/ttbar_mu200 --bf-constant-tesla=0:0:2 --digi-config-file ../../Examples/Algorithms/Digitization/share/default-smearing-config-generic.json

# vertexing + performance writing
./bin/ActsExampleVertexFinderTrackReaderPerformanceWriter  --bf-constant-tesla=0:0:2 --input-dir=data/reco_generic/ttbar_mu200 --output-dir=data/vertexing/ttbar_mu200
Since you took the time to collect these commands, may I ask you to integrate them into the CI/run_examples.sh script, so that continuous integration runs these examples, which will give us a stronger guarantee that they keep working across future ACTS evolutions?

(I think we already have a Pythia8 job, which could be adapted to your needs, but the other examples are not covered yet)

Hi,

so currently there's still some problems with running some of these example (see e.g. #774 ) and especially the truth tracking part would sometimes just segfault. I guess this should be fixed before adding it to the CI script, right? But I agree that it would be nice to have it in there

…t vertex performance

…ctor acceptance and acceptance+tracking efficiency number of vertices

XiaocongAi

Hi @baschlag , the PR looks nice to me. I have some naming suggestions. Also, for the Root based writer and reader, I find it's always helpful to add some description of what is exactly read in or written out, in particular what one entry in the tree represents.

Examples/Io/Root/include/ActsExamples/Io/Root/RootTrajectoryParametersWriter.hpp

Examples/Io/Root/include/ActsExamples/Io/Root/RootVertexPerformanceWriter.hpp

Examples/Io/Root/src/RootParticleReader.cpp

Examples/Io/Root/src/RootVertexPerformanceWriter.cpp

…riter

…umber of entries in vertex performance writer

baschlag · 2021-05-03T16:01:49Z

Hi @XiaocongAi, thanks for your comments! I've addressed all of them and I hope the PR is now good to go in. Cheers, Bastian

XiaocongAi

Hi @baschlag , thank you for the update. I have a few minor follow-up comments which should be easy to address.

Examples/Io/Root/include/ActsExamples/Io/Root/RootTrajectoryParametersWriter.hpp

Examples/Io/Root/include/ActsExamples/Io/Root/RootTrajectoryParametersReader.hpp

Examples/Io/Root/src/RootTrajectoryParametersReader.cpp

baschlag

Hi @XiaocongAi, thanks again for your comments. All of them have been addressed. Please have a look again, thanks!

XiaocongAi

Thank you! I will approve.

baschlag added 🚧 WIP Work-in-progress Component - Examples Affects the Examples module Feature Development to integrate a new feature labels Apr 15, 2021

baschlag added this to the next milestone Apr 15, 2021

baschlag changed the title ~~Feat: Introduce vertex performance writer~~ feat: Introduce vertex performance writer Apr 15, 2021

baschlag force-pushed the introduce_vertexperformance_writer branch from 4f27924 to 027c5b9 Compare April 16, 2021 14:22

baschlag added 18 commits April 16, 2021 16:34

change RootTrajectoryParametersWriter to output one event at a time

8625a7d

add root trajectory parameter reader

8752fa2

add barcode setter to Particle.hpp

65e8a3c

make amvf algorithm output also list of Acts::Vertex objects

f7d2308

make RootTrajectoryParametersWriter properly write out barcodes

4f3c575

add first versoin of vertex performance writer

09c7a0a

introduce new example for reading in truth fitted tracks and write ou…

7a0caa7

…t vertex performance

add particle barcode reading to RootTrajectoryParametersReader

af694f5

remove debug statements and minor bug fixes

a3a3010

add configurable input and output dir and mutex for tread-safe writing

68f4e73

change AMVF algorithm info to debug output

74656b9

make RootParticleWriter fill tree per event

9317334

add RootParticleReader

4b0ab2d

add setter for charge to Fatras::Particle

f947391

add total momentum to RootParticleWriter output

6b6b146

add charge and total momentum to RootParticleReader

7c1c296

make TrackReaderVertexingPerformanceWriterExample compute truth, dete…

5bc3b87

…ctor acceptance and acceptance+tracking efficiency number of vertices

fix format

a6941f1

baschlag force-pushed the introduce_vertexperformance_writer branch from 027c5b9 to a6941f1 Compare April 16, 2021 14:34

baschlag added 2 commits April 26, 2021 12:18

add track=ck-based reco/true vtx matching in RootVertexPerformanceWriter

47220a5

fix format

e394a0a

baschlag requested a review from XiaocongAi April 26, 2021 10:21

baschlag removed the 🚧 WIP Work-in-progress label Apr 26, 2021

add missing & in track iteration

9b67af3

XiaocongAi reviewed Apr 27, 2021

View reviewed changes

baschlag added 11 commits May 3, 2021 17:22

update docs in RootTrajectoryParametersWriter

6edf2b6

update docs in RootVertexPerformanceWriter

311244d

update more docs

0033bb6

update docs in RootParticleReader

f93d6b5

update collection names and docs in RootTrajectoryParametersReader

8dc3da1

rename allFittedTracks to inputFittedTracks in RootVertexPerformanceW…

b31b0ae

…riter

add check if fitted tracks and associated truth particles have same n…

e542b5f

…umber of entries in vertex performance writer

fix format

35ab3bf

resolve merge conflicts

e8f92b8

resolve merge conflict

d474908

fix format

6147860

baschlag requested a review from XiaocongAi May 3, 2021 16:02

use const ref for track iteration in vertex performance writer

6af7d68

XiaocongAi reviewed May 5, 2021

View reviewed changes

baschlag added 3 commits May 10, 2021 09:24

update docs

c01c68e

rename RootTrajectoryParametersReader track and particle collections

5b8dd22

fix format

f529cd9

baschlag commented May 10, 2021

View reviewed changes

Merge branch 'main' into introduce_vertexperformance_writer

8d63c18

XiaocongAi self-requested a review May 10, 2021 07:50

XiaocongAi approved these changes May 10, 2021

View reviewed changes

Merge branch 'main' into introduce_vertexperformance_writer

d7ee0d5

asalzburger merged commit 3a8bfa1 into acts-project:main May 12, 2021

paulgessinger modified the milestones: next, v8.3.0 May 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Introduce vertex performance writer #776

feat: Introduce vertex performance writer #776

baschlag commented Apr 15, 2021 •

edited

HadrienG2 commented Apr 15, 2021 •

edited

codecov bot commented Apr 15, 2021 •

edited

baschlag commented Apr 15, 2021

XiaocongAi left a comment

baschlag commented May 3, 2021

XiaocongAi left a comment

baschlag left a comment

XiaocongAi left a comment

feat: Introduce vertex performance writer #776

feat: Introduce vertex performance writer #776

Conversation

baschlag commented Apr 15, 2021 • edited

HadrienG2 commented Apr 15, 2021 • edited

codecov bot commented Apr 15, 2021 • edited

Codecov Report

baschlag commented Apr 15, 2021

XiaocongAi left a comment

Choose a reason for hiding this comment

baschlag commented May 3, 2021

XiaocongAi left a comment

Choose a reason for hiding this comment

baschlag left a comment

Choose a reason for hiding this comment

XiaocongAi left a comment

Choose a reason for hiding this comment

baschlag commented Apr 15, 2021 •

edited

HadrienG2 commented Apr 15, 2021 •

edited

codecov bot commented Apr 15, 2021 •

edited