Utility Modules

I3EHEEventDigest

I3EHEEventDigest is an I3Module to print out information of MC particle generated by JULIeT (I3MCTree and I3JulietParamsTree), I3PortiaPulse and I3OpheliaFirstGuessTrack. Using this output, one can build JULIeT-originated I3Particle which is a data class for analysis package of JULIeT.

I3EHEEventSelector

I3EHEEventSelector is an I3Module to select only events meeting given conditions. This module considers criteria on I3MCTree, I3DOMLaunch, I3PortiaPulse and I3OpheliaFirstGuessTrack.

Usage

C++ I3Modules

I3EHEEventSelector (C++ I3Module)

Parameters:
AzimuthMax

Default : 6.283185307179586

AzimuthMin

Default : 0.0

EHECriteriaFileName

Default : ‘’

IcePickServiceKey

Description : Key for an IcePick in the context that this module should check before processing physics frames. Default : ‘’

If

Description : A python function… if this returns something that evaluates to True, Module runs, else it doesn’t Default : None

InputPortiaEventName

Default : ‘PortiaEvent’

baseTimeWindowCleaning

Default : True

cosZenithMax

Default : 1.0

cosZenithMin

Default : -1.0

distanceOfCOB

Default : 10000.0

distanceOfCascade

Default : 10000.0

energyMax

Default : 1000000000000.0

energyMin

Default : 100000.0

firstGuessAzimuthMax

Default : 6.283185307179586

firstGuessAzimuthMin

Default : 0.0

firstGuessBDOMZMax

Default : 500.0

firstGuessBDOMZMin

Default : -500.0

firstGuessCoGZMax

Default : 500.0

firstGuessCoGZMin

Default : -500.0

firstGuessCosZenithMax

Default : 1.0

firstGuessCosZenithMin

Default : -1.0

firstGuessVelocity

Default : 0.0

highestNPEs

Default : 100000000.0

inAtwdPortiaName

Default : ‘ATWDPortiaPulse’

inFadcPortiaName

Default : ‘FADCPortiaPulse’

inFirstguessName

Description : Default : ‘OpheliaFirstGuessBaseTimeWindow’

inInIceDOMLaunchName

Default : ‘CleanInIceRawData’

lowestNPEs

Default : 10.0

numberOfDOMs

Default : 50

numberOfDOMsWithLaunch

Default : 50

particleType

Default : 13

setCriteriaOnEHEFirstGuess

Default : False

setCriteriaOnEventHeader

Default : False

setCriteriaOnInIceDOMLaunch

Default : False

setCriteriaOnJulietParticle

Default : False

setCriteriaOnPortiaPulse

Default : False

setEHECriteria

Default : False

I3EHESpotVelocity (C++ I3Module)

Parameters:
FADCWaveformName

Description : input FADC waveform name Default : ‘CalibratedFADC’

IcePickServiceKey

Description : Key for an IcePick in the context that this module should check before processing physics frames. Default : ‘’

If

Description : A python function… if this returns something that evaluates to True, Module runs, else it doesn’t Default : None

InputFadcPulseName

Default : ‘FADCPortiaPulse’

InputPortiaEventName

Default : ‘PortiaEvent’

LCOption

Description : if non-zero use only LC pulse Default : 0

MinimumNumberPulseDom

Default : 3

OutputSpotTrackName

Default : ‘OpheliaSpotTrack’

I3EHEStaticTWC (C++ I3Module)

Parameters:
IcePickServiceKey

Description : Key for an IcePick in the context that this module should check before processing physics frames. Default : ‘’

If

Description : A python function… if this returns something that evaluates to True, Module runs, else it doesn’t Default : None

InputPortiaEventName

Default : ‘PortiaEvent’

InputPulseName

Default : ‘ATWDPortiaPulse’

OutputPulseName

Default : ‘ATWDPortiaPulseTWC’

TimeInterval

Default : 10000.0

TimeWidnowNegative

Default : -4400.0

TimeWindowPositive

Default : 6400.0

I3OpheliaConvertFirstGuessTrack

I3OpheliaConvertFirstGuessTrack is an I3Module to convert I3OpheliaFirstGuessTrack to I3Particle.

Usage

I3OpheliaConvertFirstGuessTrack (C++ I3Module)

Parameters:
IcePickServiceKey

Description : Key for an IcePick in the context that this module should check before processing physics frames. Default : ‘’

If

Description : A python function… if this returns something that evaluates to True, Module runs, else it doesn’t Default : None

InputOpheliaFGTrackName

Description : Input name of I3OpheliaFirstGuessTrack Default : ‘OpheliaFirstGuess’

OutputParticleName

Description : Output name of I3Particle Default : ‘OpheliaFirstGuessConverted’

I3OpheliaConvertJulietParticle

I3OpheliaConvertJulietParticle is an I3Module to convert a primary particle in MCTree to I3Particle. If number of primary particle is more than 1, the primary at the head of vector is taken. One do not have to run juliet before this module because the input is MCTree.

Usage

I3OpheliaConvertJulietParticle (C++ I3Module)

Parameters:
IcePickServiceKey

Description : Key for an IcePick in the context that this module should check before processing physics frames. Default : ‘’

If

Description : A python function… if this returns something that evaluates to True, Module runs, else it doesn’t Default : None

InputMCTreeName

Description : Input name of I3MCTree Default : ‘I3MCTree’

OutputParticleName

Description : Output name of I3Particle Default : ‘ConvertedJulietParticle’

I3OpheliaConvertPortia

I3OpheliaConvertPortiaPulse is an I3Module to convert dataclasses derived from portia project to general dataclass.

Usage

I3OpheliaConvertPortia (C++ I3Module)

Parameters:
IcePickServiceKey

Description : Key for an IcePick in the context that this module should check before processing physics frames. Default : ‘’

If

Description : A python function… if this returns something that evaluates to True, Module runs, else it doesn’t Default : None

InputPortiaEventName

Description : Input name of I3PortiaEvent Default : ‘PortiaEvent’

InputPortiaPulseName

Description : Input name of I3PortiaPulseMap Default : ‘ATWDPortiaPulse’

OutputRecoPulseName

Description : Output name of I3RecoPulseSeriesMap Default : ‘’

outputPortiaEventMapName

Description : Output name of I3MapStringDouble Default : ‘’