i3truthextractor

I3Extractor class(es) for extracting truth-level information.

class graphnet.data.extractors.icecube.i3truthextractor.I3TruthExtractor(name, borders, mctree, extend_boundary, exclude=[None])[source]

Bases: I3Extractor

Class for extracting truth-level information.

Construct I3TruthExtractor.

Parameters:

  • name (str, default: 'truth') – Name of the I3Extractor instance.

  • borders (Optional[List[ndarray]], default: None) – Array of boundaries of the detector volume as ((x,y),z)- coordinates, for identifying, e.g., particles starting and stopping within the detector. Defaults to hard-coded boundary coordinates.

  • mctree (Optional[str], default: 'I3MCTree') – Str of which MCTree to use for truth values.

  • extend_boundary (Optional[float], default: 0.0) – Distance to extend the convex hull of the detector for defining starting events.

  • exclude (list, default: [None]) – List of keys to exclude from the extracted data.

set_gcd(i3_file, gcd_file)[source]

Extract GFrame and CFrame from i3/gcd-file pair.

Information from these frames will be set as member variables of I3Extractor.

Parameters:

  • i3_file (str) – Path to i3 file that is being converted.

  • gcd_file (Optional[str], default: None) – Path to GCD file. Defaults to None. If no GCD file is given, the method will attempt to find C and G frames in the i3 file instead. If either one of those are not present, RuntimeErrors will be raised.

Return type:

None