i3calorimetry

Extract all the visible particles entering the volume.

class graphnet.data.extractors.icecube.i3calorimetry.I3Calorimetry(hull, mctree, mmctracklist, extractor_name, daughters, highest_energy_primary, cascade_deposited_only, **kwargs)

Bases: I3Extractor

Event level energy labeling for IceCube data.

This class extracts cumulative energy information from all visible particles entering the detector volume, during the event.

Create a ConvexHull object from the GCD file.

hull: GCD_hull object containing the convex hull of the detector volume. mctree: Name of the I3MCTree in the frame. mmctracklist: Name of the MMCTrackList in the frame. extractor_name: Name of the extractor. daughters: If True, only calculate energies for particles

that are daughters of the primary.

highest_energy_primary: If True, takes into account only the

primary with the highest energy. NOTE: Only makes a difference if daughters is False

and the event is not a Corsika event.

cascade_deposited_only: If True, consider only energies from

cascades that are marked as visible. If False the total energy of a cascade is counted.

Variable explanation: - e_entrance_track: Total energy of tracks entering the hull. - e_deposited_track: Total energy deposited by tracks in the hull. - e_cascade: Total energy of cascade particles in the hull. - e_visible: Total energy of particles entering the hull.

NOTE: if daughters is True, this is the total visible energy of daughter particles of the primary particles. If this is 0 that means that all the light in the detector comes from particles that are daughters of coincident primaries.

• fraction_primary: Fraction of e_visible compared to

  the primary energy.

• fraction_cascade: Fraction of the total energy that is

  deposited by cascade particles compared to the total energy.

Parameters:

• hull (GCD_hull)

• mctree (str)

• mmctracklist (str)

• extractor_name (str)

• daughters (bool)

• highest_energy_primary (bool)

• cascade_deposited_only (bool)

• kwargs (Any)

get_energies(frame, particles, track_lookup)

Get the total energy of cascade particles on entrance.

Return type:

Tuple[float, float, float]

Parameters:

• frame (icecube.icetray.I3Frame)

• particles (List[icecube.dataclasses.I3Particle])

• track_lookup (Dict[icecube.icetray.I3ParticleID, icecube.icetray.I3Particle])

frame_contains_info(frame)

Check if the frame contains the necessary information.

Return type:

bool

Parameters:

frame (icecube.icetray.I3Frame)

is_in_hull(particle)

Check if a particle is in the hull.

Return type:

bool

Parameters:

particle (icecube.dataclasses.I3Particle)