Add rapidity methods #9
Conversation
Add methods that return the true rapidity of LorentzVectors (E, p) these are defined for both cartesian and cylindrical cases as rap() Add methods for the square of mass and the square of momentum as these can be useful for more specialist calculations (but not exported)
Codecov ReportAll modified lines are covered by tests ✅
📢 Thoughts on this report? Let us know!. |
src/cartesian.jl
Outdated
| mass(lv::LorentzVector) = sqrt(dot(lv, lv)) | ||
| pt(lv::LorentzVector) = sqrt(muladd(lv.x, lv.x, lv.y^2)) | ||
| mass2(lv::LorentzVector) = dot(lv, lv) | ||
| mass(lv::LorentzVector) = mass2(lv) < 0.0 ? sqrt(-mass2(lv)) : sqrt(mass2(lv)) |
There was a problem hiding this comment.
is this negative mass trick universal? what's ROOT's Math::LorentzVector behavior on this
There was a problem hiding this comment.
ROOT adopts this convention for space-like 4-vectors, so that's some precedent
There was a problem hiding this comment.
I'm trying to think if we should err on the side of not silently produce wrong results
There was a problem hiding this comment.
Depends what one thinks of as being wrong. Negative mass is not ambiguous - but it may be surprising. I'm ok with rolling this back.
There was a problem hiding this comment.
Yeah, I guess I mean if we error, it's trivial for user to do what they want. But not the other way, they may silently get wrong results
There was a problem hiding this comment.
I checked in the Python Vector package and it also conforms to this behaviour:
In [1]: import vector
In [2]: ep_vec = vector.obj(x=8.1, y=2.2, z=3.3, E=4.4)
In [3]: ep_vec.mass
Out[3]: -7.87273777030583And I found I missed a - sign on the mass method, oops! Fixed in incoming commit.
This is the same method name as ScikitHEP's Vector package Add a note that we adopt the ROOT convention of returning a negative mass for space-like 4-vectors
graeme-a-stewart
force-pushed
the
add-rapidity
branch
from
e69f963 to
2e3acce
Compare
graeme-a-stewart
force-pushed
the
add-rapidity
branch
from
abcf3d2 to
a5efbeb
Compare
And add test for same
|
Go ahead and merge this when you're ready! |
|
Thanks @Moelf - merge early, merge often! Can we foresee a new release that can be a proper dependency for JetReconstruction.jl? |
Add methods that return the true rapidity of
LorentzVectors (E, p)these are defined for both cartesian and cylindrical cases asrap()rapidity().Add methods for the square of mass and the square of momentum (
mass2,pt2) as these can be useful for more specialist calculations (but not exported).