i3highesteparticleextractor¶

Extract the highest energy particle in the event.

class graphnet.data.extractors.icecube.i3highesteparticleextractor.I3HighestEparticleExtractor(hull, mctree, mmctracklist, extractor_name, daughters, min_e, **kwargs)[source]¶

Bases: I3Extractor

Extract the highest energy particle in the event.

Initialize the extractor.

Parameters:

hull (GCD_hull) – GCD_hull object
mctree (str, default: 'I3MCTree') – Name of the MCTree object.
mmctracklist (str, default: 'MMCTrackList') – Name of the MMCTrackList object.
extractor_name (str, default: 'HighestEInVolumeParticle') – Name of the extractor.
daughters (bool, default: False) – forces the extractor to only consider daughters of the primary particle.
min_e (float, default: 5) – minimum energy for a particle to be considered, default is 5.
**kwargs (Any) – Additional keyword arguments for I3Extractors.

frame_contains_info(frame)[source]¶

Check if the frame contains the MCTree.

Return type:: bool
Parameters:: frame (icecube.icetray.I3Frame)

get_tracks(frame)[source]¶

Get the tracks from the frame.

Args: frame: I3Frame object

Return type:: Tuple[ndarray, ndarray]
Parameters:: frame (icecube.icetray.I3Frame)

get_pos_dir_length(particles)[source]¶

Get the position, direction and length of the particles.

Args: particles: List of I3Particles

Return type:: Tuple[ndarray, ndarray, ndarray]
Parameters:: particles (icecube.dataclasses.ListI3Particle)

get_bundle_HEP(particles)[source]¶

Get the energy averaged particle of a list of particles.

Args: particles: List of I3Particles

Return type:: Tuple[I3Particle, ndarray, bool]
Parameters:: particles (array)

highest_energy_track(frame, min_e)[source]¶

Get the highest energy track in the event.

Args: frame: I3Frame object checked_id: dict of already checked particle ids min_e: minimum energy for a particle to be considered

Return type:

Tuple[I3Particle, float, float, float, int]

Parameters:

frame (icecube.icetray.I3Frame)
min_e (float)

highest_energy_starting(frame, min_e)[source]¶

Get the highest energy starting particle in the event.

Args: frame: I3Frame object min_e: minimum energy for a particle to be considered

Return type:

Tuple[I3Particle, float, float, int, float, float]

Parameters:

frame (icecube.icetray.I3Frame)
min_e (float)

highest_energy_bundle(frame, min_e)[source]¶

Get the highest energy bundle in the event.

Args: frame: I3Frame object min_e: minimum energy for a particle to be considered

Return type:

Tuple[I3Particle, float, float, float, int]

Parameters:

frame (icecube.icetray.I3Frame)
min_e (float)

get_visible_produced_particles(frame, particle)[source]¶

Get the visible particles produced by a particle.

Produces a list of particles that are produced by the input particle down to the final node particles

Args: frame: I3Frame object particle: I3Particle object

Return type:

ListI3Particle

Parameters:

frame (icecube.icetray.I3Frame)
particle (icecube.dataclasses.I3Particle)

get_descendants(frame, particle)[source]¶

Get the descendants of a particle and the particle as a list.

Parameters:

frame (I3Frame) – I3Frame object
particle (Union[I3Particle, List[I3Particle]]) – I3Particle object

Return type:

ListI3Particle