v00-99
v00-99 (v01-00 pre-release)
This is a pre-release for the first stable release of EDM4hep. We consider the datatypes that are currently in to be well defined (enough) so that no major changes to the existing datatypes are foreseen in the midterm future. For any potential changes we think that they can be transparently handled by the available schema evolution facilities. We will probably make a few smaller fixes and remove still existing deprecated functionality as well as add more documentation before we plan to release v01-00 in a few weeks.
Note
There have been many breaking changes in the definition of the datatypes in EDM4hep. Hence files written with an earlier version of EDM4hep are almost certainly not readable with this version.
Changes wrt v00-10-05
-
2024-07-31 tmadlener (PR#349)
- Update the
Link
names in the diagram after #341
- Update the
-
2024-07-30 tmadlener (PR#350)
- Include the user handle types in the
Collection.h
legacy header files such that they can truly be used transparently.
- Include the user handle types in the
-
2024-07-30 tmadlener (PR#348)
- CI: Make sure to use the python bindings of podio that we build in CI
-
2024-07-30 jmcarcell (PR#347)
- Covariance matrices: Check for the size of the input for one of the constructors
static_cast
the inputs tofloat
- Covariance matrices: Check for the size of the input for one of the constructors
-
2024-07-30 tmadlener (PR#345)
- Bump the schema version of EDM4hep to 2 to have a way to differentiate between before pre-release and afterwards
-
2024-07-30 tmadlener (PR#341)
- Rename the members of the associations to
from
andto
in preparation for a transparent introduction of templated associations in podio (AIDASoft/podio#257)- Add (immediately deprecated) compatibility getters and setters that keep the current behavior on the API side.
- Rename
Association
toLink
and make naming more consistent- Add (immediately deprecated) compatiblity typedefs and headers to keep the current behavior.
- Rename the members of the associations to
-
2024-07-30 Federico Meloni (PR#337)
- edm4hep::Track: Added Nholes and subdetectorHoleNumbers
-
2024-07-29 jmcarcell (PR#346)
- Update LCG workflow to use LCG_106 instead of LCG_104
-
2024-07-28 jmcarcell (PR#272)
- Add a script to create an EDM4hep file. The script is in python and can be called like
python createEDM4hepFile.py
. I have tried to make use of every member and relation in the data model. The purpose is to have something that can create quickly an EDM4hep file and because the script is in python no compilation is needed, hopefully lowering the barrier to get to an EDM4hep file. People can adapt it to their needs or use it as an example for testing, debugging, etc.
- Add a script to create an EDM4hep file. The script is in python and can be called like
-
2024-07-19 tmadlener (PR#332)
- Make the
Vertex
have relations to the (decay) particles that were used to build it - Rename the
ReconstructedParticle
relation to aVertex
todecayVertex
(as dicsussed in #320)
- Make the
-
2024-07-16 tmadlener (PR#340)
- Improve the error message of the README links CI check to suggest how to fix it
-
2024-07-16 tmadlener (PR#311)
- Remove the
dQ/dx
information from the Track - Add
TrackPIDHandler
to allow for the reverse lookup
- Remove the
-
2024-07-10 jmcarcell (PR#339)
- Load libraries without the .so suffix to make it work in other OSes
-
2024-07-08 tmadlener (PR#336)
- Switch to EL9 as OS for the
dev4
stack based CI workflow
- Switch to EL9 as OS for the
-
2024-07-08 tmadlener (PR#329)
- Rename the
Vertex
primary
field totype
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
andcheckBit
utility functionality and also use that for theMCParticle
extra code
- Rename the
-
2024-07-08 jmcarcell (PR#326)
- Remove
radiusOfInnermostHit
from tracks
- Remove
-
2024-07-04 tmadlener (PR#334)
- Remove compatibility with podio versions before 1.0
-
2024-06-28 tmadlener (PR#335)
- Remove the association between
TrackerHitPlane
andSimTrackerHit
from the diagram
- Remove the association between
-
2024-06-28 tmadlener (PR#333)
- Remove some of the drift chamber study types that were introduced in #179 again since they need a bit more consideration
- The removed types and components are:
Hypothesis
,HitLevelData
,RecIonizationCluster
,SimPrimaryIonizationCluster
,TrackerPulse
- Keep the types and components that are already in use, mainly
TimeSeries
- The removed types and components are:
- Remove the usage of the removed components from
RecDqdx
to make it a purely reconstruction level type - Fix script that checks that all types are part of the json dumper
- Remove some of the drift chamber study types that were introduced in #179 again since they need a bit more consideration
-
2024-06-28 tmadlener (PR#331)
- Remove the
MCRecoTrackerHitPlaneAssociation
as it is no longer necessary
- Remove the
-
2024-06-28 jmcarcell (PR#324)
- Change probability to ndf in Vertex
-
2024-06-27 tmadlener (PR#330)
- Remove docstring of
Track::type
that is no longer relevant for EDM4hep and was a leftover from LCIO.- EDM4hep does not (yet) reserve any bits in the Track
- Remove docstring of
-
2024-06-25 Wouter Deconinck (PR#327)
- Require podio 1.0
-
2024-06-24 Thomas Madlener (PR#325)
- Introduce a
edm4hep::labels::MCParticles
label to formalize the name of the canonical MCParticle collection
- Introduce a
-
2024-06-18 Benedikt Hegner (PR#310)
- Add
GeneratorEventParameters
andGeneratorPdfInfo
datatypes to store generator related data in a structured and well defined way. - Add a
GeneratorToolInfo
struct and related utility functionality to store some high level metadata on the generator into Frame parameters.
- Add
-
2024-06-17 tmadlener (PR#315)
- Introduce the
edm4hep::labels
namespace to hold the string constants that are used for consistent labeling / naming of collections or parameters.- Use this opportunity to homogenize the naming and capitalization of the variables but leave string constants unchanged
- Deprecate existing string constants
- Introduce the
-
2024-06-12 tmadlener (PR#314)
- Make the python bindings install prefix conform to python conventions by default and allow overriding with the
EDM4HEP_PYTHON_INSTALLDIR
cmake variable- Default prefix is now
<prefix>/lib[64]/pythonX.Y/site-packages
(wherelib
orlib64
is defined from the platform defaults andX.Y
is the python major and minor version).
- Default prefix is now
- Make the python bindings install prefix conform to python conventions by default and allow overriding with the
-
2024-06-11 tmadlener (PR#313)
- Switch to
alma9
image to fix documentation deploys
- Switch to
-
2024-06-11 tmadlener (PR#307)
- To have a more consistent way of filling the
algoType
in theedm4hep::utils::ParticleIDMeta
use the 32 bit version of MurmurHash3 to hash thealgoName
to get toalgoType
. Fixes #298- Make
algoType
a private member but allow read access to it via thealgoType
member function.algoType
has to be filled on construction. It is still possible to set it manually, the hashing will only kick in for the constructor taking only a name.
- Make
- To have a more consistent way of filling the
-
2024-06-11 Juraj Smiesko (PR#283)
- Adding metadata name for event filter statistics.
-
2024-06-04 tmadlener (PR#303)
- Update the schema diagram to reflect the changes from #268
-
2024-06-03 Mateusz Jakub Fila (PR#308)
- Use declarationFile instead of include in CovMatrix to fix generated documentation for covariance matrix components. Fixes #296
-
2024-05-21 tmadlener (PR#302)
- Update the schema diagram to reflect the
TrackerHit
as interface- Add
TrackerHit3D
as new type
- Add
- Fix all arrow heads to be consistently black
- Update the schema diagram to reflect the
-
2024-05-16 tmadlener (PR#305)
- Introduce pre-processor checks to transparently switch to the new
std::optional
return values ofpodio::Frame::getParameter
(introduced with AIDASoft/podio#580)
- Introduce pre-processor checks to transparently switch to the new
-
2024-05-14 jmcarcell (PR#304)
-
2024-05-07 Andre Sailer (PR#300)
- DOC: change association descriptions to allow doxygen to link to respective classes
-
2024-05-02 Mateusz Jakub Fila (PR#297)
- Fix datatypes table formatting. Fix typos
-
2024-05-01 tmadlener (PR#287)
- Introduce
edm4hep::CovMatrix[2,3,4,6}f
components to represent covariance matrices- using
std::array<float, N>
under the hood - Access functionality that works on enums for defining dimensions and some utilities to do the indexing into the underlying storage
- using
- Introduce some
enum class
es for defining dimensions, e.g.TrackParams
orCartesian
- Use these components instead of the raw
std::array
s in datatypes and other components and tie the interpretation of the values to the approriate dimensionenum class
Usage example:
#include "edm4hep/TrackerHit3D.h" void foo(const edm4hep::TrackerHit3D& hit) { const auto covXY = hit.getCovMatrix(edm4hep::Cartesian::x, edm4hep::Cartesian:y); }
- Introduce
-
2024-05-01 tmadlener (PR#268)
- Remove the relations from
Cluster
toParticleID
- Remove the relations from
ReconstructedParticle
toParticleID
- Add a
OneToOneRelation
fromParticleID
to aReconstructedParticle
- This is a breaking change for both existing files and interfaces. There will be no schema evolution for this change
- Add a new
edm4hep::utils::PIDHandler
and some related utility functionality to help with handling the necessary meta data.
- Remove the relations from
-
2024-04-19 tmadlener (PR#295)
- Make sure that the
utils
(currently INTERFACE only) target appears asedm4hepUtils
"on disk" in order to avoid having on overly genericlibutils.so
once it actually becomes a shared library.
- Make sure that the
-
2024-04-19 tmadlener (PR#289)
- Only pass what is strictly necessary as input to doxygen
- Exclude dependencies to avoid generating empty namespaces in the EDM4hep API reference
-
2024-04-08 jmcarcell (PR#294)
- Load Constants.h in python, making some names available like
edm4hep::EventHeaderName
- Load Constants.h in python, making some names available like
-
2024-04-04 tmadlener (PR#293)
- Use non deprecated versions of the
SIOWriter
andSIOReader
- Use non deprecated versions of the
-
2024-04-02 jmcarcell (PR#292)
- Do not try to set the read-only property ALIAS_GLOBAL
-
2024-03-12 tmadlener (PR#286)
- Make sure that
operator[]
of theVectorNx
types return the correct type.
- Make sure that
-
2024-03-12 Mateusz Jakub Fila (PR#285)
- added static asserting vector components' member ordering and padding
-
2024-02-26 tmadlener (PR#282)
- Bump the patch version to 99 in order to keep preprocessor version checks working for current tagged version.
-
2024-02-26 tmadlener (PR#281)
- Add
operator!=
toVectorXY
classes to keep symmetry with updated podio generated code.
- Add
-
2024-02-25 Mateusz Jakub Fila (PR#280)
- Fix readme formatting and links to trackerhit
-
2024-02-23 jmcarcell (PR#279)
- Fix a few compiler warnings, some of them introduced in 1.0 PRs
-
2024-02-23 tmadlener (PR#252)
- Make the
edm4hep::TrackerHit
aninterface
type and use that in theedm4hep::Track
. - Rename the current
edm4hep::TrackerHit
toedm4hep::TrackerHit3D
- This is a breaking change. However, we currently do not plan to implement schema evolution for this
- Make the
-
2024-02-22 jmcarcell (PR#278)
- Remove any path containing /fccanalyses/ for one test to prevent ROOT from loading FCCAnalyses dictionaries
-
2024-02-22 tmadlener (PR#277)
- Use the units explictly in the yaml file to make them appear nicer in the generated docstrings.
-
2024-02-22 BrieucF (PR#276)
-
2024-02-22 jmcarcell (PR#275)
- Remove BITEndpoint from MCParticle
-
2024-02-22 jmcarcell (PR#274)
- Rename EDep to eDep in SimTrackerHit for consistency with other uses of "eDep"
-
2024-02-22 jmcarcell (PR#273)
- Rename type to PDG in ReconstructedParticle
-
2024-02-22 Thomas Madlener (PR#267)
-
2024-02-22 tmadlener (PR#260)
- Remove the
edm4hep::ObjectID
component. Fixes #259 - Remove its usage from the
edm4hep::TrackerHit
andedm4hep::TrackerHitPlane
- This is a breaking change both in code and existing files. Existing usages might switch to use the
podio::ObjectID
to have effectively the same functionality.
- Remove the
-
2024-02-22 tmadlener (PR#256)
- Rename
MCParticle
relations toparticle
inSimTrackerHit
andSimPrimaryIonizationCluster
to avoid clashes with theMCParticle
typename.- Add
getMCParticle
andsetMCParticle
viaExtraCode
to keep everything working. - This will break the reading of existing files via podio utilities
- Add
- Rename
-
2024-02-22 jmcarcell (PR#254)
- Add a
double weight
VectorMember
to theEventHeader
to allow storing multiple weights.- This should not break any existing code as we simply add a new member. However, this will break the possibility of reading existing files through podio.
- Introduce the
edm4hep::EventWeights
constant to have a consistent name for storing / accessing them in file level metadata.
- Add a
-
2024-02-12 tmadlener (PR#269)
- Put the
schema_version
to the correct level for the downstream usage tests to keep it working after [podio#556)(https://github.com/AIDASoft/podio/pull/556)
- Put the