Make the Vertex have a proper `type` bitfield instead of a `primary` field

tmadlener commented 3 months ago

BEGINRELEASENOTES

Rename the Vertex primary field to type and make it a 32 bit unsigned integer
Introduce 3 reserved bits and accompanying utility / ExtraCode functionality for checking primary, secondary or tertiary vertex
Introduce setBit and checkBit utility functionality and also use that for the MCParticle extra code

ENDRELEASENOTES

Fixes #328

[x] Needs check / changes for downstream consumers (these have to go in simultaneously)
- https://github.com/key4hep/k4EDM4hep2LcioConv/pull/74 (ready for merge)
- https://github.com/HEP-FCC/FCCAnalyses/pull/382 (under review)

Zehvogel commented 3 months ago

LCFIPlus already distinguishes between secondary (tertiary etc.) vertices and V0 vertices (although by writing them into different collections). We could add V0 another bit for V0 directly imo.

tmadlener commented 3 months ago

Does LCFIPlus only split the collections between V0 and non-V0, or also between primary, secondary (, tertiary)?

Zehvogel commented 3 months ago

3 collections: primary, buildup, buildup_V0

key4hep / EDM4hep

Make the Vertex have a proper `type` bitfield instead of a `primary` field #329