graphnet.data.readers.i3reader module

Module containing different I3Reader.

class graphnet.data.readers.i3reader.I3Reader(gcd_rescue, i3_filters, icetray_verbose)[source]

Bases: GraphNeTFileReader

A class for reading .i3 files from the IceCube Neutrino Observatory.

Note that this class relies on IceCube-specific software, and therefore must be run in a software environment that contains IceTray.

Initialize I3Reader.

Parameters:

  • gcd_rescue (str) – Path to a GCD file that will be used if no GCD file is found in subfolder. I3Reader will recursively search the input directory for I3-GCD file pairs. By IceCube convention, a folder containing i3 files will have an accompanying GCD file. However, in some cases, this convention is broken. In cases where a folder contains i3 files but no GCD file, the gcd_rescue is used instead.

  • i3_filters (Union[I3Filter, List[I3Filter], None], default: None) – Instances of I3Filter to filter PFrames. Defaults to NullSplitI3Filter.

  • icetray_verbose (int, default: 0) – Set the level of verbosity of icetray. Defaults to 0.

find_files(path)[source]

Recursively search directory for I3 and GCD file pairs.

Parameters:

path (Union[str, List[str]]) – directory to search recursively.

Return type:

List[I3FileSet]

Returns:

List I3 and GCD file pairs as I3FileSets