Missing status and mother_id in offline reader

I see that some members from the km3net-dataformat data are not yet implemented in km3io. For example, in the list of methods for class Trk, there's the Trk::status which is not implemented in km3io. By the way, I could only figure this out by inspecting the code and not from the documentation (see issue #79 (closed)).

In this particular case, I see that the member is marked as TODO. Is there a problem with its implementation? I see that for other methods there are some issues related to uproot. I could help to implement this.

Thanks! I just uncommented that (including the mother_id) and it seems to work:

>>> from km3net_testdata import data_path

>>> import km3io

>>> f = km3io.OfflineReader(data_path("offline/km3net_offline.root"))

>>> f.events.mc_tracks.status
<Array [[], [], [], [], ... [], [], [], []] type='10 * var * int32'>

>>> f.events.mc_tracks.mother_id
<Array [[], [], [], [], ... [], [], [], []] type='10 * var * int32'>

We just need some test data which has meaningful numbers for cross-checks (recent gSeaGen files).

added enhancement label

Thanks! I can do this check with the gSeaGen files that I'm looking at. Stay tuned

It would be nice to add a newer file to the km3net-testdata, so that we can include those in the test suite

Ah, we already have a file:

>>> import km3io

>>> from km3net_testdata import data_path

>>> f = km3io.OfflineReader(data_path("gseagen/gseagen_v7.0.0_numuCC_diffuse.aa.root"))

>>> f.events.mc_tracks.status
<Array [[100, 5, 11, 15, 1, ... -1, -1, -1, 1]] type='82 * var * int32'>

>>> f.events.mc_tracks.mother_id
<Array [[-1, -1, 1, 1, 0, ... 20, 24, 24, 4]] type='82 * var * int32'>

So we only need to add tests and then uncomment the two lines.

Do you want to take over? I am busy until the evening and only can do quick checks here and there... (like now)

I can take over, but I'm also busy until the evening. I can do it before the end of this week, but probably not today.

changed title from Missing methods to Missing status and mother_id in offline format

changed title from Missing status and mother_id in offline format to Missing status and mother_id in offline reader

created merge request !54 (merged) to address this issue

mentioned in merge request !54 (merged)

I created a merge request and activated those two lines. We only need to add some basic test to verify that the readout is correct.

On what kind of data would you perform this test? For example, a ROOT file produced by gSeaGen could be OK. The test could simply be to check that the status for particles with ID = "neutrino pdg code" have status = "primary", and that any othher particle is not primary.

In practice doing this is not easy at the moment. If I look at the documentation of KM3NET-dataformat, I see that status is an integer, but I still didn't find there what are the possible values and their meanings. Only by inspecting the code I could see that there some possible values for the status variable are TRK_ST_UNDEFINED, TRK_ST_PRIMARYNEUTRINO, TRK_ST_PRIMARYCOSMIC or TRK_ST_FINALSTATE. But I couldn't find their integer values documented, and these are neither part of km3io.

I opened an issue in km3net dataformat. We then probably need to add these also to km3io, and then add this test.

@rgracia the possible values are stored here: https://git.km3net.de/common/km3net-dataformat/-/blob/master/definitions/trkmembers.csv

Thanks!

np :)

Everything is there already, see above (#80 (comment 25284)) the tests should just check if the status values and mother IDs are the ones we expect, that's it.

Yeah, what I meant is that to check that the values are what we expect, we need to know what's the meaning of each value. I can work with the list provided by @pkalaczynski above.

@tgal , can you give me permissions to create a merge request here?

Yep!

closed with merge request !54 (merged)

mentioned in commit 5f4b5e02