Project filterscripts¶
Invoke with: import icecube.filterscripts
C++ I3Modules¶
- I3FilterModule_I3BoolFilter¶
"I3FilterModule<I3BoolFilter>"(C++ I3Module)<undocumented>
- Param BoolKey:
Default =
'FilterDecision', Key of the boolean that will tell us to keep the event or not.- Param DecisionName:
Default =
'I3BoolFilter', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3CascadeFilter_13¶
"I3FilterModule<I3CascadeFilter_13>"(C++ I3Module)<undocumented>
- Param CascadeLlhKey:
Default =
'', Name of the I3Double object where the cascade rllh should be stored. If empty, the cascade rllh will not be stored.- Param cosThetaMax:
Default =
0.21, The cos theta value for separating regions 1 and 2- Param CscdLlhFitParams:
Default =
'cscdllhParams', Name of the I3CscdLlhFitParams in the frame.- Param CscdrLlh1:
Default =
10.7, cascade rllh cut for region 1- Param CscdrLlh2:
Default =
10.5, cascade rllh cut for region 2- Param DecisionName:
Default =
'I3CascadeFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param EvalRatioKey:
Default =
'', Name of the I3Double object where the EvalRatio should be stored. If empty, the EvalRatio will not be stored.- Param HitMultiplicityKey:
Default =
'HitMultiplicity', The I3HitMultiplicityValues in the frame where NString can be found- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param LFVelKey:
Default =
'', Name of the I3Double object where the LineFitVel should be stored. If empty, the LineFitVel will not be stored.- Param LinefitKey:
Default =
'LineFit', Name of the linefit I3Particle object in the frame.- Param LinefitVelocity:
Default =
0.12, Maximum Linefit Velocity for region 2- Param LlhParticleKey:
Default =
'PoleTrackLlhFit', The I3Particle in the frame to be used for getting zenith for above, ie track- llh)- Param minNString:
Default =
2, Minimum number of hit strings- Param TensorOfInertiaFitParams:
Default =
'toiParams', Name of the I3TensorOfInertiaFitParams in the frame.- Param ToIEvalRatio:
Default =
0.05, Minimum Tensor of Inertia Eigenvalue Ratio for region 2- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3CosmicRayFilter_13¶
"I3FilterModule<I3CosmicRayFilter_13>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3CosmicRayFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param IceTopPulseMaskKey:
Default =
'CleanedIceTopTankPulses', Name of the IceTop I3RecoPulseSeriesMapMask in the frame.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration- Param TriggerKey:
Default =
'I3TriggerHierarchy', Name of the I3TriggerHierarchy in the frame.
- I3FilterModule_I3EHEAlertFilter_15¶
"I3FilterModule<I3EHEAlertFilter_15>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3EHEAlertFilter_15', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param EHEFirstGuessName:
Default =
'', Name of the EHEFirstGuess fit parameters in the frame.- Param EHEFirstGuessParticleName:
Default =
'', Name of the EHEFirstGuess particle in the frame.- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param Looser:
Default =
False, Flag to use the looser 2D requirement. Used for heartbeat.- Param Loosest:
Default =
False, Flag to use the loosest 2D requirement. Used for PnF testing.- Param PortiaEventName:
Default =
'EHESummaryPulseInfo', Name of the PortiaEvent in the frame.- Param Skip2DTest:
Default =
False, Flag to turn off 2D requirement. Used for testing.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3EHEFilter_13¶
"I3FilterModule<I3EHEFilter_13>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3EHEFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param PortiaEventName:
Default =
'EHESummaryPulseInfo', Name of the PortiaEvent in the frame.- Param Threshold:
Default =
1000.0, Minimum NPE threshold.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3FSSCandidate_13¶
"I3FilterModule<I3FSSCandidate_13>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3FSSCandidate_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param EventHeaderName:
Default =
'I3EventHeader', Frame name of event header object.- Param IceCubeResponseKey:
Default =
'InitialPulseSeriesReco', Name of the I3RecoPulseSeriesMap in the frame to use.Should contain only IceCube HLC launches, with NFE, DOM Launch Cleaning, and TimeWindow Cleaning already done. This will be used to evaluate the top- and side-vetos.- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param MuonTrackFitName:
Default =
'PoleMuonLineFit', Frame name of the I3Particle object with the muon track fit (SLC+HLC).- Param NSideVetoLayers:
Default =
1, Number of side veto layers (0, 1, 2 or 3). If the earliest pulse of an event occur in a string in any of the side veto layers defined, the entire event will be rejected. (Later pulses in the side veto layer do not affect the filter decision.)- Param NTopVetoLayers:
Default =
5, Number of top veto layers (0-60). If any pulse occur in a non-DeepCore DOM with DOM number less or equal to this threshold, during the full event time, the entire event will be rejected.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3FSSFilter_13¶
"I3FilterModule<I3FSSFilter_13>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3FSSFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param finiteRecoParticleName:
Default =
'', Name of the I3Particle from the finteReco start/stop point reconstruction.- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param polygonCutScale:
Default =
1.0, In case of the polygon-based cut on the x-y position, this is the scale factor by which the polygon is scaled to smaller sizes.It should be a value ranging from 0 to 1.- Param rCut:
Default =
700.0, Radius for the vertex cut [m].- Param scaleAroundString36:
Default =
True, This bool determines, whether you scale the polygon w.r.t. the center of the coordiante system or string 36.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration- Param usePolygonCut:
Default =
False, Defines if a cut is applied on the radius or a polygon area, following the detector geometry- Param zCut:
Default =
1000.0, Z-coordinate for the vertex cut [m]. Events with a reconstructed z-position below zCut are discarded.
- I3FilterModule_I3FilterMinBias¶
"I3FilterModule<I3FilterMinBias>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3FilterMinBias', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3HeseFilter_15¶
"I3FilterModule<I3HeseFilter_15>"(C++ I3Module)<undocumented>
- Param ChargeName:
Default =
'CausalQTot', name of charge I3Double- Param DecisionName:
Default =
'I3HeseFilter_15', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param MinimumCharge:
Default =
1500.0, charge threshold- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration- Param VetoName:
Default =
'VHESelfVeto', name of veto I3Bool
- I3FilterModule_I3HighQFilter_17¶
"I3FilterModule<I3HighQFilter_17>"(C++ I3Module)<undocumented>
- Param ChargeName:
Default =
'Homogenized_QTot', name of charge I3Double- Param DecisionName:
Default =
'I3HighQFilter_17', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param MinimumCharge:
Default =
1000.0, charge threshold- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3LowUpFilter_13¶
"I3FilterModule<I3LowUpFilter_13>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3LowUpFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param ISCrit:
Default =
True, Perform InnerString-Criterion- Param nchanCut:
Default =
4, Filter parameter- Param Pulses:
Default =
'', Name of reco pulse series map to be used- Param RecoTrackNameList:
Default =
[''], List of Track Recos considered by filter (priority ordered; first entry has highest)- Param timeExtensionCut:
Default =
4000.0, Filter parameter- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration- Param zenithCut:
Default =
80.0, Filter parameter- Param zExtensionCut:
Default =
600.0, Filter parameter- Param zMaxCut:
Default =
440.0, Veto everything above this z- Param zTravelCut:
Default =
-10.0, The tuning parameter
- I3FilterModule_I3MeseFilter_15¶
"I3FilterModule<I3MeseFilter_15>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3MeseFilter_15', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3MuonFilter_13¶
"I3FilterModule<I3MuonFilter_13>"(C++ I3Module)<undocumented>
- Param CosZenithZone1:
Default =
[-1.0, 0.2], Vector of minimum zenith angle cuts to be matched with its corresponding Nchan cut for Zone 1. If an event satisfies ANY pair of zenith/Nchan cuts, the event will be kept.- Param CosZenithZone2:
Default =
[0.2, 0.5], Vector of minimum zenith angle cuts to be matched with its corresponding Nchan cut for Zone 2. If an event satisfies ANY pair of zenith/Nchan cuts, the event will be kept.- Param CosZenithZone3:
Default =
[0.5, 1.0], Vector of minimum zenith angle cuts to be matched with its corresponding Nchan cut for Zone 3. If an event satisfies ANY pair of zenith/Nchan cuts, the event will be kept.- Param DecisionName:
Default =
'I3MuonFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IceCubeResponseKey:
Default =
'InitialPulseSeriesReco', Name of the I3RecoHitSeriesMap in the frame to use.Should contain only IceCube Pulses, with NFE, SeededRT, and TimeWindow Cleaning already done.- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param InterceptZone2:
Default =
0.65, Min value of intcharge for Zone 2.- Param InterceptZone3:
Default =
2.3, Min value of intcharge for Zone 3.- Param LLHFitParamsKey:
Default =
'', Name of the LLH Fit Params key in the frame, to use as source for rlogl.- Param LogLZone1:
Default =
8.7, Max value of loglikelihood/(nch -3) for Zone 1.- Param PriParticleKey:
Default =
'ipdfGConvolute', Name of the I3Particle in the frame.- Param SlopeZone2:
Default =
3.9, Min value of intcharge for Zone 2.- Param SlopeZone3:
Default =
0.6, Min value of intcharge for Zone 3.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3OnlineL2Filter_13¶
"I3FilterModule<I3OnlineL2Filter_13>"(C++ I3Module)<undocumented>
- Param CosZenithZone1:
Default =
[-1.0, 0.1391731009600657], Vector with minimum and maximum cos zenith angle of Zone 1 where the PLogL || NDirC || LDirC || QTot cut is applied.- Param CosZenithZone2:
Default =
[0.1391731009600657, 0.4067366430758002], Vector with minimum and maximum cos zenith angle of Zone 2 where the first QTot || (PLogL && QTot) cut is applied.- Param CosZenithZone3:
Default =
[0.4067366430758002, 1.0], Vector with minimum and maximum cos zenith angle of Zone 3 where the second QTot || (PLogL && QTot) cut is applied.- Param DecisionName:
Default =
'I3OnlineL2Filter_13', Name of the filter decision in the Frame- Param DirectHitValues:
Default =
'OnlineL2_BestFitDirectHitsC', Name of the I3DirectHitsValues calculated with CommonVariables (source for NDir and LDir).- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param HitMultiplicityValues:
Default =
'OnlineL2_HitMultiplicityValues', Name of the I3HitMultiplicityValues calculated with CommonVariables (source for NCh).- Param HitStatisticsValues:
Default =
'OnlineL2_HitStatisticsValues', Name of the I3HitMultiplicityValues calculated with CommonVariables (source for NCh).- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param LDirCZone1:
Default =
160.0, Denominator for LDirC for ellipsis cut in Zone 1.- Param LLHFitParamsKey:
Default =
'PoleMuonLlhFitFitParams', Name of the LLH Fit Params key in the frame (source for logl).- Param NDirCZone1:
Default =
9, Denominator for NDirC for ellipsis cut in Zone 1.- Param PLogLParamZone1:
Default =
4.5, Number subtracted from NCh in plogl for Zone 1.- Param PLogLParamZone2:
Default =
4.5, Number subtracted from NCh in plogl for Zone 2.- Param PLogLParamZone3:
Default =
4.5, Number subtracted from NCh in plogl for Zone 3.- Param PLogLZone1:
Default =
8.3, Max value of plogl = loglikelihood/(nch - ploglparam) for Zone 1.- Param PLogLZone2:
Default =
8.3, Max value of plogl = loglikelihood/(nch - ploglparam) for Zone 2.- Param PLogLZone3:
Default =
10.5, Max value of plogl = loglikelihood/(nch - ploglparam) for Zone 3.- Param PriParticleKey:
Default =
'OnlineL2_BestFit', Name of the I3Particle in the frame (source for zenith angle).- Param QTotInterceptZone2:
Default =
1.1300000000000001, Intercept of cos(Zenith) dependent QTot cut for Zone 2.- Param QTotInterceptZone3:
Default =
0.6, Intercept of cos(Zenith) dependent QTot cut for Zone 3.- Param QTotKinkZone3:
Default =
0.5, Value of cos(Zenith) where (in Zone 3) there is a kink in the QTot cut.- Param QTotOrCutZone2:
Default =
2.5, Min value of log10(QTot) for Zone 2.- Param QTotOrCutZone3:
Default =
3.0, Min value of log10(QTot) for Zone 3.- Param QTotSlopeZone2:
Default =
3.3, Slope of cos(Zenith) dependent QTot cut for Zone 2 (before kink).- Param QTotSlopeZone3:
Default =
0.6, Slope of cos(Zenith) dependent QTot cut for Zone 3 (after kink).- Param QTotZone1:
Default =
2.7, Min value of log10(QTot) for Zone 1.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterModule_I3ShadowFilter_13¶
"I3FilterModule<I3ShadowFilter_13>"(C++ I3Module)<undocumented>
- Param AzimuthRange:
Default =
[-1.5707963267948966, 1.5707963267948966], Azimuth range for the ‘shadow window’, specified by two doubles that specify the minimum and maximum azimuth difference w.r.t. the Moon/Sun coordinates.- Param CorrectSolidAngle:
Default =
False, If set, then the behavior of AzimuthRange is slightly changed: the azimuth difference is multiplied with sin(zenith) (zenith of the reconstructed track).- Param CorsikaMJDName:
Default =
'CorsikaMoon', If fake event times are generated for corika events, then the MJD and angular coordinates are stored in the frame. If several Moon filters are defined (e.g. one for conventional data and one for extended DST), then subsequent filters can reuse the generated times and and angles (instead of generating different ones) if the same name is configured for this option.- Param CorsikaMJDRange:
Default =
[], For testing with corsika: give the MJD range (e.g. 29 September 10:00h - 5 October 21:00h (2011): [55833.417,55839.875]Instead of getting the event time from the event header, for each event a random time in the given MJD range will be generated. Default: empty range, i.e. assume exp input data- Param CorsikaRandService:
Default =
'', Name of the random number generator servuce used to generate the event time in the year for corsika events.- Param DecisionName:
Default =
'I3ShadowFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param EventHeaderName:
Default =
'I3EventHeader', Name of the EventHeader in the frame- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param MaximumZenith:
Default =
1.5707963267948966, Maximum zenith for the Moon/Sun (default: horizon)- Param NChannelCut:
Default =
0, The minimum number of hit channels an event should contain in order to be kept by this filter.- Param NStringCut:
Default =
0, The minimum number of strings an event should contain in order to be kept by this filter.- Param ParticleName:
Default =
'', Name of the particle in the frame- Param RecoPulsesName:
Default =
'', Name of the I3RecoPulseSeriesMap that was used by the track reconstruction.- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration- Param WhichShadow:
Default =
'Moon', Shadow from which object (Moon or Sun)?- Param ZenithRange:
Default =
[-0.2617993877991494, 0.2617993877991494], Zenith range for the angular window, specified by two doubles that specify the minimum and maximum zenith difference w.r.t. the Moon/Sun coordinates.
- I3FilterModule_I3VEFFilter_13¶
"I3FilterModule<I3VEFFilter_13>"(C++ I3Module)<undocumented>
- Param DecisionName:
Default =
'I3VEFFilter_13', Name of the filter decision in the Frame- Param DiscardEvents:
Default =
False, Set to ‘true’ if we’re supposed to actually discard events- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param LinefitCut:
Default =
2.9, Remove events that have linefit zenith angle less than this- Param MuonLlhCut:
Default =
2.6, Remove events that have MuonLlh zenith angle less than this- Param PoleMuonLinefit:
Default =
'PoleMuonLinefit', The standard muon linefit- Param PoleMuonLlhFit:
Default =
'PoleMuonLlhFit', The standard log likelihood linefit performed by Muon Group- Param RecoPulsesKey:
Default =
'InitialPulseSeriesReco', Key for all the reco pulses.- Param SingleStringRequirement:
Default =
False, Reject events with pulses on multiple strings.- Param ToplayerDOMcut:
Default =
5, How many layers of DOM’s should be used in the veto cap- Param TriggerEvalList:
Default =
[], List of bools from TriggerCheck that are required for event consideration
- I3FilterRate¶
"I3FilterRate"(C++ I3Module)<undocumented>
- Param DoNTuple:
Default =
False, Bool indicating whether the ntuple text file should be outputted.- Param FilterList:
Default =
[], A list of the filter decisions in the frame that should be studied. These will only be used if the filtermask is not availale.- Param FilterMaskName:
Default =
'filterMask', The name of the I3FilterResultMap in the frame.- Param NEvents:
Default =
10000, Number of frames to process before dumping the rate xml file and clearing the history. (0 for no resultant file).- Param NTupleFileName:
Default =
'filter-ntuple.txt', File where the ntuple text file should be saved.- Param XMLFileName:
Default =
'FilterRate.xml', The name of the resultant xml file.
- TriggerCheck_13¶
"TriggerCheck_13"(C++ I3Module)<undocumented>
- Param DeepCoreSMTConfigID:
Default =
99999, The config ID used for DeepCore SMT Trigger events- Param DeepCoreSMTFlag:
Default =
'DeepCoreSMTTriggered', Name of bool to use when IN_ICE::SMT DeepCore Trigger present- Param DMIceSMTConfigID:
Default =
99999, The config ID used for DM Ice simple multiplicity triggers- Param DMIceSMTTriggerFlag:
Default =
'DMIceSMTTriggered', Name of bool to use when an IN_ICE::SMT DM Ice Trigger is present- Param FaintParticleFlag:
Default =
'FaintParticleTriggered', Name of bool to use when IN_ICE::FAINT_PARTICLE Trigger present- Param FixedRateTriggerFlag:
Default =
'FixedRateTriggered', Name of bool to use when IN_ICE::UNBIASED Trigger present- Param I3TriggerHierarchy:
Default =
'I3TriggerHierarchy', Name of I3TriggerHierarchy in ze frame- Param IceActSMTConfigID:
Default =
99999, The config ID used for IceAct SMT MB passthru trigger- Param IceActSMTTriggerFlag:
Default =
'IceActSMTTriggered', Name of bool to use when IceTop::SMT IceAct MB Trigger is present- Param IceTopSMTFlag:
Default =
'IceTopSMTTriggered', Name of bool to use when ICE_TOP::SMT Trigger present- Param IceTopVolumeTriggerFlag:
Default =
'IceTopVolumeTriggered', Name of bool to use when IN_Top::Volume (2 station trigger) Trigger present- Param InIceSMTFlag:
Default =
'InIceSMTTriggered', Name of bool to use when IN_ICE::SMT Trigger present- Param InIceStringFlag:
Default =
'InIceStringTriggered', Name of bool to use when IN_ICE::String Trigger present- Param PhysMinBiasConfigID:
Default =
99999, The config ID used for PhysicsMinBias Trigger events- Param PhysMinBiasFlag:
Default =
'PhysMinBiasTriggered', Name of bool to use when IN_ICE::MinBias (PhysMinBias) Trigger present- Param ScintMinBiasConfigID:
Default =
99999, The config ID used for IceTop Min Bias Scintillator Trigger events- Param ScintMinBiasTriggerFlag:
Default =
'ScintMinBiasTriggered', Name of bool to use when IN_Top::MinBias Scintillator Trigger present- Param SlowParticleFlag:
Default =
'SlowParticleTriggered', Name of bool to use when IN_ICE::SLOW_PARTICLE Trigger present- Param VolumeTriggerFlag:
Default =
'VolumeTrigTriggered', Name of bool to use when IN_ICE::VOLUME Trigger present
- TriggerReducer¶
"TriggerReducer"(C++ I3Module)<undocumented>
- Param I3TriggerHierarchy:
Default =
'I3TriggerHierarchy', Name of I3TriggerHierarchy to take as input from the frame- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param OutTriggerHierarchy:
Default =
'OutTriggerHierarchy', Name of I3TriggerHierarchy to ouput to the frame- Param TriggerConfigIDList:
Default =
[], Vector of Ints, containing the ConfigIDs of triggers to keep
Python I3Modules¶
- FlaringDOMFilter¶
FlaringDOMFilter(Python I3Module)<undocumented>
- Param additionalDOMs:
Default =
[], OMKey list to add to known offenders- Param causalCut:
Default =
-15.0, Time cut determining whether a hit is causal- Param chargeThreshold:
Default =
30, Minimum charge needed to select an OM for analysis, in PE- Param errataName:
Default =
'LIDErrata', Name of LID errata object- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param maxNonCausalHits:
Default =
1, Cut parameter: Maximum number of non-causal hits relative to first pulse in selected OM- Param minChargeFraction:
Default =
0.7, Cut parameter: Minimum fraction of charge on selected OM- Param mode:
Default =
'CutOffendingDOMEvents', Analysis Mode: “CutOffendingDOMEvents”: Remove flaring events from known offending DOMs; “CutAllEvents”: Remove flaring events from all DOMs- Param pulsesName:
Default =
'SRTInIcePulses', Name of pulse series to analyze- Param sendErrataMoni:
Default =
True, Send Errata moni messages (for use online)
- I3HistogramLLH¶
I3HistogramLLH(Python I3Module)Use a precalcuated S/B-likelihood histogram to calculate the likelihood ratio for each event.
- Param HistFile:
Default =
'', Filename containing the histograms- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param OutputName:
Default =
'', Where to store the result- Param VarNames:
Default =
[], Name of the object(s) with x/y/z values
- I3TimeResidualBooker¶
I3TimeResidualBooker(Python I3Module)This module stores the time residuals of a pulsemap with respect to a given fit.
- Param Geometry:
Default =
'I3Geometry', Name of geometry to use- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param MaxDist:
Default =
200.0, Maximal Distance of OM to track- Param Particle:
Default =
'OnlineL2_SplineMPE', Particle to calculate Time Residuals for- Param Pulsemap:
Default =
'CleanedMuonPulsesIC', Pulsemap to use for time residual calculation- Param TimeWindow:
Default =
[-500.0, 500.0], Time Window for residuals
- I3Vectorize¶
I3Vectorize(Python I3Module)Extend a given frame object to match the length of another vector-like object.
- Param Func:
Default =
<function I3Vectorize.__init__.<locals>.<lambda> at 0x171533ec0>, Optional function to apply on input values- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param Input:
Default =
'', Name of the input object- Param Output:
Default =
'', Name of the output object- Param Vector:
Default =
'', Corresponding vector object to match length
- ReevaluateTriggerOnIceTopSplit¶
ReevaluateTriggerOnIceTopSplit(Python I3Module)<undocumented>
- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param Input:
Default =
'CleanedHLCTankPulses', Name of input pulse series- Param Output:
Default =
'IceTop_TwoStationFilter_Bool', Name of filter decision bool
- LaunchDowngrader¶
LaunchDowngrader(Python I3Module)This module duplicates an IceTopRawData object in the frame. The duplicate is exactly the same as the input except that all launches that have the LC bit off are discarded and those that have the LC bit on are ‘downgraded’, turning the LC bit off.
- Param Launches:
Default =
'IceTopRawData', Input raw data in the frame- Param Output:
Default =
'IceTopRawDataRedundant', Where to put the result
- ChargeCleaning¶
ChargeCleaning(Python I3Module)<undocumented>
- Param ChargeFraction:
Default =
'0.5', Minimal fraction of all DOMs selected for OutputRecoPulses- Param If:
Default =
<function ChargeCleaning.__init__.<locals>.<lambda> at 0x171533e20>,- Param InputRecoPulses:
Default =
'PulseSeriesReco',- Param OutputRecoPulses:
Default =
'HighChargePulseSeriesReco',
- ClipStartStop¶
ClipStartStop(Python I3Module)Run startup is complicated, and data may be recorded before it is complete. As a result, we need to listen to what the DAQ says was the range of times when everything was really up and running, and discard events outside.
- CalculateGaps¶
CalculateGaps(Python I3Module)<undocumented>
- Param EventHeaderName:
Default =
'I3EventHeader', Name of the Event Header- Param MinGapTime:
Default =
30, Minimum time (in seconds) between events to consider as a data gap- Param OutputFileName:
Default =
'', Name of Output Gaps File
- IceTopWaveformSplitter¶
IceTopWaveformSplitter(Python I3Module)<undocumented>
- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param Input:
Default =
'IceTopVEMPulses', Name of input pulse series- Param OutputHLC:
Default =
'IceTopHLCVEMPulses', Name of HLC pulses- Param OutputSLC:
Default =
'IceTopSLCVEMPulses', Name of SLC pulses
- ChargeCleaning¶
ChargeCleaning(Python I3Module)<undocumented>
- Param ChargeFraction:
Default =
'0.5', Minimal fraction of all DOMs selected for OutputRecoPulses- Param If:
Default =
<function ChargeCleaning.__init__.<locals>.<lambda> at 0x171533f60>,- Param InputRecoPulses:
Default =
'PulseSeriesReco',- Param OutputRecoPulses:
Default =
'HighChargePulseSeriesReco',
- PulseMaskShortcutter¶
PulseMaskShortcutter(Python I3Module)Create a copy of a pulse mask, pointing directly to a specific source, leaving out all the intermediate masks. This module loops through the mask sources for the given PulseMaskName until a non-mask source is reached, then it creates a copy of the PulseMaskName pointing directly to the non-mask source, without intermediate steps, put into the frame as ShortcutName. Alternatively, one can name a desired source with OrigSourceName.
- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param OrigSourceName:
Default =
'', Name of the desired source the shortcut should point to. Scans for first non- mask source if not set.- Param PulseMaskName:
Default =
'', Name of the I3RecoPulseSeriesMapMask to create a shortcut for- Param ShortcutName:
Default =
'', Name of the shortcut to put into the frame
I3Tray segments¶
- AlertEventFollowup¶
AlertEventFollowup(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param omit_GCD_diff:
Default =
False,- Param base_GCD_path:
Default =
None,- Param base_GCD_filename:
Default =
None,- Param If:
Default =
<function <lambda> at 0x102b60860>,
- CompressGCD¶
CompressGCD(I3Tray segment)Use frame_object_diff to generate compressed versions of the GCD objects.
- Param base_GCD_path:
Default =
None,- Param base_GCD_filename:
Default =
None,
- OnlineFilter¶
OnlineFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param simulation:
Default =
False,- Param decode:
Default =
False,- Param If:
Default =
<function <lambda> at 0x102b60a40>,- Param SplineRecoAmplitudeTable:
Default =
None,- Param SplineRecoTimingTable:
Default =
None,- Param PathToCramerRaoTable:
Default =
None,- Param GFUBDTUpPath:
Default =
None,- Param GFUBDTDownPath:
Default =
None,- Param sdstarchive:
Default =
False,- Param slop_split_enabled:
Default =
True,- Param vemcal_enabled:
Default =
True,- Param gfu_enabled:
Default =
True,- Param needs_wavedeform_spe_corr:
Default =
True,- Param alert_followup:
Default =
True,- Param alert_followup_omit_GCD_diff:
Default =
False,- Param alert_followup_base_GCD_path:
Default =
'',- Param alert_followup_base_GCD_filename:
Default =
None,- Param forceOnlineL2BadDOMList:
Default =
None,- Param ic79_geometry:
Default =
False,
- BaseProcessing¶
BaseProcessing(I3Tray segment)Decode payloads, calibrate waveforms, extract pulses, and run basic reconstructions.
- Param pulses:
Default =
'MuonPulseSeriesReco',- Param decode:
Default =
False,- Param simulation:
Default =
False,- Param needs_calibration:
Default =
True,- Param needs_superdst:
Default =
True,- Param needs_maskmaker:
Default =
True,- Param needs_trimmer:
Default =
True,- Param needs_wavedeform_spe_corr:
Default =
True,- Param do_slop:
Default =
True,- Param llh_name:
Default =
'PoleMuonLlhFit',- Param linefit_name:
Default =
'PoleMuonLinefit',- Param seededRTConfig:
Default =
None,- Param do_icetop_tankmerger_prep:
Default =
False,
- DAQTrimmer¶
DAQTrimmer(I3Tray segment)Strip launches that were well-represented out of the DAQ payload, leaving only SuperDST for these readouts. Save in ‘Output’ the less-well represented raw readouts.
- Param SuperDST:
Default =
'I3SuperDST',- Param Pulses:
Default =
'UncleanedInIcePulses',- Param Waveforms:
Default =
'CalibratedWaveforms',- Param Errata:
Default =
'CalibrationErrata',- Param Output:
Default =
'I3DAQDataTrimmed',- Param ChiThreshold:
Default =
1000.0,- Param ChargeThreshold:
Default =
10.0,
- SimTrimmer¶
SimTrimmer(I3Tray segment)Save a flag for events with less-well represented raw readouts.
- Param SuperDST:
Default =
'I3SuperDST',- Param Pulses:
Default =
'UncleanedInIcePulses',- Param Waveforms:
Default =
'CalibratedWaveforms',- Param Errata:
Default =
'CalibrationErrata',- Param ChiThreshold:
Default =
1000.0,- Param ChargeThreshold:
Default =
10.0,
- DOMCleaning¶
DOMCleaning(I3Tray segment)Apply DOMLaunch cleaning with permanent bad doms
- Param CleanInIceRawData:
Default =
'CleanInIceRawData',- Param CleanIceTopRawData:
Default =
'CleanIceTopRawData',
- OnlineCalibration¶
OnlineCalibration(I3Tray segment)Apply the Waveform calibration and pulse extraction.
- Param simulation:
Default =
False,- Param WavedeformSPECorrections:
Default =
True,- Param CleanInIceRawData:
Default =
'CleanInIceRawData',- Param CleanIceTopRawData:
Default =
'CleanIceTopRawData',- Param InIcePulses:
Default =
'UncleanedInIcePulses',- Param IceTopPulses:
Default =
'IceTopPulses',- Param Harvesting:
Default =
False,
- SuperDST¶
SuperDST(I3Tray segment)Pack pulses extracted from InIce and IceTop DOMs into a SuperDST payload, and set up aliases pointing to the entire event as well as just to the InIce and IceTop portions.
- Param InIcePulses:
Default =
'InIcePulses',- Param IceTopPulses:
Default =
'IceTopPulses',- Param Output:
Default =
'EventPulses',
- CascadeFilter¶
CascadeFilter(I3Tray segment)This tray segment is a first version of the 2013 cascade filter segment.
- Param pulses:
Default =
'RecoPulses', Name of the I3RecoPulseSeriesMap to work on. This filter has been tested in 2011 with uncleaned pulses, TW, SRT and TW+SRT-cleaned pulses. It does not work too well for TW-cleaned pulses. All other cleanings or no cleaning at all is acceptable.- Param muon_llhfit_name:
Default =
'PoleMuonLlhFit', Name of the I3Particle containing the muon llh reconstruction result from the muon filter.- Param output_pulses_HLC:
Default =
None, Set this to a string to store the HLC cleaned pulses for use by other filters downstream.- Param doCleanup:
Default =
True, Clean up all “internal” reconstruction reuslts after the final filter decision.- Param If:
Default =
<function <lambda> at 0x102b61620>, Python function to use as conditional execution test for segment modules.
- CosmicRayFilter¶
CosmicRayFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'CleanedHLCTankPulses',- Param If:
Default =
<function <lambda> at 0x102b61760>,
- DeepCoreFilter¶
DeepCoreFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
None,- Param seededRTConfig:
Default =
None,- Param If:
Default =
<function <lambda> at 0x102b619e0>,
- DMIceTrigFilter¶
DMIceTrigFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x102b61bc0>,
- DSTFilter¶
DSTFilter(I3Tray segment)Record in compact form limited information from reconstructions, triggers and cut parameters for every triggered event.
- Param dstname:
Default =
'I3DST16',- Param pulses:
Default =
'CleanedMuonPulses',- Param llh_name:
Default =
'PoleMuonLlhFit',- Param linefit_name:
Default =
'PoleMuonLinefit',- Param trigger_name:
Default =
'I3TriggerHierarchy',- Param If:
Default =
<function <lambda> at 0x102b61e40>,
- EHEAlertFilter¶
EHEAlertFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
'CleanedMuonPulses',- Param portia_pulse:
Default =
'EHEBestPortiaPulse',- Param portia_summary:
Default =
'PoleEHESummaryPulseInfo',- Param split_dom_map:
Default =
'splittedDOMMap',- Param If:
Default =
<function <lambda> at 0x102b62160>,
- EHECalibration¶
EHECalibration(I3Tray segment)Run WaveCalibrator w/o droop correction. DeepCore DOMs are omitted. Split waveforms up into two maps FADC and ATWD (highest-gain unsaturated channel)
- Param If:
Default =
<function <lambda> at 0x102b62480>,
- EHEFilter¶
EHEFilter(I3Tray segment)EHEFilter
- Param If:
Default =
<function <lambda> at 0x102b625c0>,- Param QIf:
Default =
<function <lambda> at 0x102b62660>,
- ESTReSFilter¶
ESTReSFilter(I3Tray segment)Traysegment for the Enhanced Starting Track Realtime Stream (ESTReS) Default settings are the recommended settings in Table 1 of the TFT proposal http://icecube. wisc.edu/~kjero/ESTReS_TFT_Proposal/ESTES_Realtime_Filter_Proposal.pdf For a rate around 60 events a day use veto_tresh = 10**-5 distance_tresh = 300. homogonized_charge_cut = 250. vertex_charge_cut = 25. zenith_angle_cut = 180.
- Param pulsesname:
Default =
'RecoPulses',- Param veto_thresh:
Default =
0.001,- Param distance_thresh:
Default =
400,- Param homogonized_charge_cut:
Default =
450,- Param zenith_angle_cut:
Default =
75,- Param vertex_charge_cut:
Default =
25,- Param base_processing_fit:
Default =
'PoleMuonLlhFit',- Param SplineRecoAmplitudeTable:
Default =
None,- Param SplineRecoTimingTable:
Default =
None,- Param If:
Default =
<function <lambda> at 0x102b62a20>,
- ESTReSFollowup¶
ESTReSFollowup(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x102b62d40>,
- FixedRateTrigFilter¶
FixedRateTrigFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x102b62e80>,
- FPFilter¶
FPFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x102b63740>,
- FSSFilter¶
FSSFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
'SplitUncleanedInIcePulses',- Param If:
Default =
<function <lambda> at 0x102b63920>,- Param ic79_geometry:
Default =
False,
- GammaFollowUp¶
GammaFollowUp(I3Tray segment)This tray segment does the 2017 Gamma-Ray Follow-Up filtering.
- Param OnlineL2SegmentName:
Default =
'OnlineL2',- Param BDTUpFile:
Default =
None,- Param BDTDownFile:
Default =
None,- Param KeepDetails:
Default =
False,- Param pulses:
Default =
'CleanedMuonPulses',- Param angular_error:
Default =
True,- Param If:
Default =
<function <lambda> at 0x106fe8ea0>,
- GRECOOnlineFilter¶
GRECOOnlineFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param uncleaned_pulses:
Default =
'SplitUncleanedInIcePulses',- Param bdt:
Default =
'/Users/buildbot/actions-runner/_work/icetray/icetray/filterscripts/resources/data/bdt_greco_online.bdt',- Param bdt_cut:
Default =
0.13,- Param If:
Default =
<function <lambda> at 0x16e948680>,
- DCL3MasterSegment¶
DCL3MasterSegment(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param year:
Default =
'12',
- DeepCoreCuts¶
DeepCoreCuts(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param splituncleaned:
Default =
'SplitInIcePulses',- Param year:
Default =
'13',- Param If:
Default =
<function <lambda> at 0x16e948400>,
- HeseFilter¶
HeseFilter(I3Tray segment)Traysegment for a potential HESE filter. NEW
- Param pulses:
Default =
'RecoPulses',- Param If:
Default =
<function <lambda> at 0x16e948860>,
- HighQFilter¶
HighQFilter(I3Tray segment)Traysegment for a high charge filter (formerly EHE).
- Param pulses:
Default =
'RecoPulses',- Param If:
Default =
<function <lambda> at 0x16e948ae0>,
- IceActTrigFilter¶
IceActTrigFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e948c20>,
- Split_and_Recombine¶
Split_and_Recombine(I3Tray segment)A tray-segment to perform event-splitting and event-recombination at low-level in data processing
- Param OriginalPulses:
Default =
'OfflinePulses', Name of the original pulse in the Q-frame that will be split- Param SplitName:
Default =
'IceHiveSplit', Name of the splitter and therefore the subevent-stream that is delivered- Param SplitPulses:
Default =
'MaskedOfflinePulses', Name of the SplitPulses in the P-frame- Param TriggerHierarchyName:
Default =
'I3TriggerHierarchy', Name of the TriggerHierarchy in the Q-frame- Param LineFitName:
Default =
'LineFit', Name of that the (improved)LineFit reconstruction will be given- Param AddTimeWindow:
Default =
True, Set to True if a time window should be added (needed for EHE filter, I3TriggerSplitter does this too)- Param Clean:
Default =
False, Choose if a round of HiveCleaning (similar to RT-Cleaning) should commence on the output-pulses; improves reconstructability
- IceTopTwoStationFilter¶
IceTopTwoStationFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e948fe0>,
- IceTopFilterSelectedStations¶
IceTopFilterSelectedStations(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param inputRecoPulses:
Default =
'HLCTankPulses',- Param requiredCountsforFilter:
Default =
1,- Param stationList:
Default =
['33', '34', '43'],- Param bothTanksHit:
Default =
False,- Param outHLCCountname:
Default =
'IceTopHLCCount_SW',- Param outFiltername:
Default =
'IceTop_SouthwestNHLCTank1_22',
- ExtractHLCsAsSLCs¶
ExtractHLCsAsSLCs(I3Tray segment)Segment to add a list of HLC pulses that have been processed like SLCs. It starts from the raw data, discards pulses with LC bit off, takes the pulses with LC bit on and turns it off, and extracts the pulses.
- LowUpFilter¶
LowUpFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e949940>,
- MeseFilter¶
MeseFilter(I3Tray segment)Traysegment for the MESE veto filter. NEW
- Param pulses:
Default =
'RecoPulses',- Param If:
Default =
<function <lambda> at 0x16e949bc0>,
- MinBiasFilters¶
MinBiasFilters(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e949da0>,
- ScintMinBiasFilters¶
ScintMinBiasFilters(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e949ee0>,
- MonopoleFilter¶
MonopoleFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
None,- Param seededRTConfig:
Default =
'',- Param keepKeys:
Default =
False,- Param If:
Default =
<function <lambda> at 0x16e94a660>,
- monopoleCV¶
monopoleCV(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param RecoPulses:
Default =
None,- Param ParticleName:
Default =
None,- Param tag:
Default =
'',- Param pretag:
Default =
'',- Param remove:
Default =
[],- Param If:
Default =
<function <lambda> at 0x16e94a200>,
- MuonFilter¶
MuonFilter(I3Tray segment)Traysegment for the 2012 (Dragon processing) muon filter. No nch decision is made as in 2011 (this may change with the SDST decision).
- Param pulses:
Default =
'RecoPulses',- Param If:
Default =
<function <lambda> at 0x16e94a840>,
- InstallTables¶
InstallTables(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param PhotonicsDir:
Default =
'/cvmfs/icecube.opensciencegrid.org/data/photon-tables',
- IceTopCalibration¶
IceTopCalibration(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param InputLaunches:
Default =
'CleanIceTopRawData',- Param OutputPulses:
Default =
'ReextractedIceTopPulses',
- InIceCalibration¶
InIceCalibration(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param InputLaunches:
Default =
'CleanInIceRawData',- Param OutputPulses:
Default =
'ReextractedInIcePulses',- Param WavedeformSPECorrections:
Default =
False,
- OfflineCalibration¶
OfflineCalibration(I3Tray segment)Re-do calibration and feature extraction for those launches that were sent in raw form, unifying the results with the pulses sent as SuperDST only. Also performs bad- DOM cleaning on the final output pulses.
- Param InIceOutput:
Default =
'InIcePulses', Name of output pulse series with in-ice pulses- Param IceTopOutput:
Default =
'IceTopPulses', Name of output pulse series with IceTop pulses- Param BadDOMList:
Default =
'BadDomsListSLC',- Param WavedeformSPECorrections:
Default =
False,- Param pass2:
Default =
False,
- Dehydration¶
Dehydration(I3Tray segment)Use this for PnF files (or online L1) that have not been run through PConverter.
- Rehydration¶
Rehydration(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param dstfile:
Default =
None,- Param mc:
Default =
False,- Param doNotQify:
Default =
True,- Param pass2:
Default =
False,
- EHEWriter¶
EHEWriter(I3Tray segment)EHE Output
- Param Filename:
Default =
None,
- GapsWriter¶
GapsWriter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Filename:
Default =
None,- Param MinGapTime:
Default =
30,
- IceTopWriter¶
IceTopWriter(I3Tray segment)IceTop Output
- Param Filename:
Default =
None,
- RootWriter¶
RootWriter(I3Tray segment)Root Output
- Param Filename:
Default =
None,
- SLOPWriter¶
SLOPWriter(I3Tray segment)SLOP Output
- Param Filename:
Default =
None,
- EHECalibration¶
EHECalibration(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param inPulses:
Default =
'CleanInIceRawData',- Param outATWD:
Default =
'EHECalibratedATWD_Wave',- Param outFADC:
Default =
'EHECalibratedFADC_Wave',- Param If:
Default =
<function <lambda> at 0x16e995120>,
- CascadeHitCleaning¶
CascadeHitCleaning(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'SplitInIcePulses',- Param TWOfflinePulsesHLC:
Default =
'TWOfflinePulsesHLC',- Param If:
Default =
<function <lambda> at 0x16e9954e0>,
- DeepCoreHitCleaning¶
DeepCoreHitCleaning(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'SRTInIcePulses',- Param SRTTWOfflinePulsesDC:
Default =
'SRTTWOfflinePulsesDC',- Param DeepCoreTrig:
Default =
1011,- Param I3TriggerHierarchy:
Default =
'I3TriggerHierarchy',- Param If:
Default =
<function <lambda> at 0x16e995760>,
- HitCleaningEHE¶
HitCleaningEHE(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param inATWD:
Default =
'EHECalibratedATWD_Wave',- Param inFADC:
Default =
'EHECalibratedFADC_Wave',- Param If:
Default =
<function <lambda> at 0x16e995b20>,
- IceTopCoincTWCleaning¶
IceTopCoincTWCleaning(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param VEMPulses:
Default =
'CleanedHLCTankPulses',- Param OfflinePulses:
Default =
'InIcePulses',- Param CleanCoincOfflinePulses:
Default =
'CleanedCoincOfflinePulses',
- BasicCleaning¶
BasicCleaning(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e996200>,- Param suffix:
Default =
'',- Param InputSRTPulses:
Default =
'',- Param TWSRTOfflinePulses:
Default =
'TWSRTOfflinePulses',
- FiniteRecoCleaning¶
FiniteRecoCleaning(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param seededRTConfig:
Default =
None,- Param If:
Default =
<function <lambda> at 0x16e996340>,- Param suffix:
Default =
'',- Param InputPulses:
Default =
'',- Param TWOfflinePulses_FR:
Default =
'TWOfflinePulses_FR',- Param RTTWOfflinePulses_FR:
Default =
'RTTWOfflinePulses_FR',
- WimpHitCleaning¶
WimpHitCleaning(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param seededRTConfig:
Default =
None,- Param Pulses:
Default =
'SplitInIcePulses',- Param SRTPulses:
Default =
'SRTInIcePulses',- Param If:
Default =
<function <lambda> at 0x16e9960c0>,- Param suffix:
Default =
'_WIMP',
- CalibrateAndExtractIceTop¶
CalibrateAndExtractIceTop(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param IceTopPhysicsStream:
Default =
'IceTopSplit',- Param Pulses:
Default =
'',- Param VEMPulses:
Default =
'OfflineIceTopVEMPulses',- Param HLCVEMPulses:
Default =
'OfflineIceTopHLCVEMPulses',- Param SLCVEMPulses:
Default =
'OfflineIceTopSLCVEMPulses',- Param HLCTankPulses:
Default =
'OfflineIceTopHLCTankPulses',- Param BadDOMs:
Default =
'IceTopBadDOMs',- Param BadTanks:
Default =
'IceTopBadTanks',- Param TankPulseMergerExcludedTanks:
Default =
'TankPulseMergerExcludedTanks',- Param ClusterCleaningExcludedTanks:
Default =
'ClusterCleaningExcludedTanks',- Param CleanedHLCTankPulses:
Default =
'CleanedHLCTankPulses',
- OfflineCascadeReco¶
OfflineCascadeReco(I3Tray segment)<undocumented>
- Param If:
Default =
<function <lambda> at 0x16e997e20>, Python function or module for conditional execution of all fits- Param suffix:
Default =
'', Potential suffix to append to the end of all fits, in case of multiple instances- Param SRTPulses:
Default =
'',- Param Pulses:
Default =
'', Name of the I3RecoPulseSeriesMap to work on. (pre-cleaned by cascade hit cleaning)- Param TopoPulses:
Default =
'',- Param CascadeLineFit:
Default =
'CascadeLineFit', Name of the output linefit fit- Param CascadeDipoleFit:
Default =
'CascadeDipoleFit', Name of the output dipolefit fit- Param CascadeLast:
Default =
'CascadeLast', Name of the output clast fit- Param CascadeLlhVertexFit:
Default =
'CascadeLlhVertexFit', Name of the output CascadeLlh fit- Param CascadeLlhVertexFitSplit:
Default =
'CascadeLlhVertexFitSplit',- Param BadDOMListName:
Default =
'BadDomsList', Name of the Bad DOMs list to use in the FillRatio module Should be the list that matches the input pulses (HLC pulses with HLC bad dom list, etc.)- Param CascadeFillRatio:
Default =
'CascadeFillRatio', Name of the output FillRation fit- Param CascadeSplitPulses:
Default =
'CascadeSplitPulses', Basename for the average time split cascade pulses- Param CascadeLineFitSplit:
Default =
'CascadeLineFitSplit', Basename for the linefits based on split pulses- Param CascadeToISplit:
Default =
'CascadeToISplit', Basename for the tensor-of-inertia fits based on split pulses- Param CascadeImprovedLineFit:
Default =
'CascadeImprovedLineFit', Name of the output improved linefit result based on cascade pulses- Param CascadeContainmentTagging:
Default =
'CascadeContainmentTagging',
- TopoSplitFits_Doubles¶
TopoSplitFits_Doubles(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param suffix:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bc400>,
- TopoSplitFits_Singles¶
TopoSplitFits_Singles(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param SRTPulses:
Default =
'SRTInIcePulses',- Param suffix:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bc2c0>,
- OfflineDeepCoreReco¶
OfflineDeepCoreReco(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e997d80>,- Param suffix:
Default =
'',- Param Pulses:
Default =
'',
- ReconstructionEHE¶
ReconstructionEHE(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'EHETWCInIcePulsesSRT',- Param suffix:
Default =
'EHE',- Param LineFit:
Default =
'LineFit',- Param SPEFitSingle:
Default =
'SPEFitSingle',- Param SPEFit:
Default =
'SPEFit12',- Param N_iter:
Default =
12,- Param If:
Default =
<function <lambda> at 0x16e9bc900>,
- IceTopPrefits¶
IceTopPrefits(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param ShowerCOG:
Default =
'ShowerCOG',- Param ShowerPlane:
Default =
'ShowerPlane',- Param SmallShowerDecision:
Default =
'IsSmallShower',- Param SmallShowerNStationName:
Default =
'SmallShowerNStations',- Param If:
Default =
<function <lambda> at 0x16e9bcc20>,
- LaputopSmallShower¶
LaputopSmallShower(I3Tray segment)This is the standard Laputop configuration for small showers from http://code.icecube.wisc.edu/svn/sandbox/IceTop- scripts/trunk/laputop_traysegments/laputop_smallshower_traysegment.py?p=87696
- Param Pulses:
Default =
'',- Param Laputop:
Default =
'LaputopSmallShower',- Param ShowerCOG:
Default =
'ShowerCOG',- Param ShowerPlane:
Default =
'ShowerPlane',- Param SnowFactor:
Default =
-1.0,- Param FixCore:
Default =
False,- Param FitSnow:
Default =
False,- Param BadTanks:
Default =
'ClusterCleaningExcludedTanks',- Param If:
Default =
<function <lambda> at 0x16e9bdda0>,
- LaputopStandard¶
LaputopStandard(I3Tray segment)This is the standard Laputop configuration from $I3_SRC/toprec/python/laputop_standard_traysegment.py
- Param Pulses:
Default =
'',- Param Laputop:
Default =
'LaputopStandard',- Param ShowerCOG:
Default =
'ShowerCOG',- Param ShowerPlane:
Default =
'ShowerPlane',- Param SnowFactor:
Default =
-1.0,- Param FixCore:
Default =
False,- Param BadTanks:
Default =
'ClusterCleaningExcludedTanks',- Param If:
Default =
<function <lambda> at 0x16e9bdc60>,
- OfflineCoincMuonReco¶
OfflineCoincMuonReco(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bdee0>,- Param suffix:
Default =
'',
- ReconstructIceTop¶
ReconstructIceTop(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param CoincPulses:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9be020>,
- MonopoleL2¶
MonopoleL2(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
None,- Param seededRTConfig:
Default =
'',- Param keepKeys:
Default =
True,- Param If:
Default =
<function <lambda> at 0x16e9be700>,
- monopoleCV¶
monopoleCV(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param RecoPulses:
Default =
None,- Param ParticleName:
Default =
None,- Param tag:
Default =
'',- Param pretag:
Default =
'',- Param remove:
Default =
[],- Param If:
Default =
<function <lambda> at 0x16e9be200>,
- MPE¶
MPE(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param Seed:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bd620>,- Param suffix:
Default =
'',- Param MPEFit:
Default =
'MPEFit',- Param MPEFitCramerRao:
Default =
'MPEFitCramerRao',
- MuEX¶
MuEX(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param Seed:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bd760>,- Param suffix:
Default =
'',- Param MuEX:
Default =
'MPEFitMuEX',
- OfflineMuonReco¶
OfflineMuonReco(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bdb20>,- Param suffix:
Default =
'',
- SPE¶
SPE(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param Pulses:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bd4e0>,- Param suffix:
Default =
'',- Param LineFit:
Default =
'LineFit',- Param SPEFitSingle:
Default =
'SPEFitSingle',- Param SPEFit:
Default =
'SPEFit2',- Param SPEFitCramerRao:
Default =
'SPEFit2CramerRao',- Param N_iter:
Default =
2,
- add_hit_verification_info_muon_and_wimp¶
add_hit_verification_info_muon_and_wimp(I3Tray segment)Adds hit information to the frame for verification purposes.
- Param pulses:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bd8a0>,- Param OutputI3HitMultiplicityValuesName:
Default =
'',- Param OutputI3HitStatisticsValuesName:
Default =
'',- Param suffix:
Default =
'',
- add_hit_verification_info_muon_only¶
add_hit_verification_info_muon_only(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
'',- Param If:
Default =
<function <lambda> at 0x16e9bd9e0>,- Param suffix:
Default =
'',
- SLOPLevel2¶
SLOPLevel2(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x16e9bea20>,
- BasicFits¶
BasicFits(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x1712911c0>,- Param suffix:
Default =
'_WIMP',- Param Pulses:
Default =
'',
- FiniteReco¶
FiniteReco(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x171291300>,- Param suffix:
Default =
'',- Param Pulses:
Default =
'',- Param PhotonicsServiceName:
Default =
'PhotonicsServiceFiniteReco',- Param InputTrackName:
Default =
'SPEFit2',- Param FiniteRecoFit:
Default =
'FiniteRecoFit',- Param FiniteRecoLlh:
Default =
'FiniteRecoLlh',- Param FiniteRecoCuts:
Default =
'FiniteRecoCuts',
- WimpReco¶
WimpReco(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param If:
Default =
<function <lambda> at 0x171290a40>,- Param suffix:
Default =
'_WIMP',
- OfflineFilter¶
OfflineFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param dstfile:
Default =
None,- Param mc:
Default =
False,- Param pass2:
Default =
False,- Param doNotQify:
Default =
False,- Param photonicsdir:
Default =
None,- Param If:
Default =
<function <lambda> at 0x171291580>,
- OpticalFollowUp¶
OpticalFollowUp(I3Tray segment)This tray segment is doing the 2014 OpticalFollowUp filtering.
- Param OnlineL2SegmentName:
Default =
'OnlineL2', Name of OnlineL2 segment is needed to fetch variables using appropriate names.- Param BDTFilePath:
Default =
None,- Param testing:
Default =
False, Run this segment in testing mode, not in real Pole conditions.- Param If:
Default =
<function <lambda> at 0x1712914e0>, Python function to use as conditional execution test for segment modules.
- OnlineL2Filter¶
OnlineL2Filter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param pulses:
Default =
'CleanedMuonPulses',- Param linefit_name:
Default =
'PoleMuonLinefit',- Param llhfit_name:
Default =
'PoleMuonLlhFit',- Param SplineRecoAmplitudeTable:
Default =
None,- Param SplineRecoTimingTable:
Default =
None,- Param PathToCramerRaoTable:
Default =
None,- Param forceOnlineL2BadDOMList:
Default =
None,- Param If:
Default =
<function <lambda> at 0x171292020>,
- SplineMPEBootstrapping¶
SplineMPEBootstrapping(I3Tray segment)Perform advanced error estimation using the bootstrapping technique. The pulses are resampled 6 times and the 50% containment radius is calculated from the subsequent fits.
- Param pulses:
Default =
'CleanedMuonPulses',- Param ParametrizationName:
Default =
'Para',- Param MinimizerName:
Default =
'Minuit',- Param If:
Default =
<function <lambda> at 0x171291ee0>,
- SplineMPEParaboloid¶
SplineMPEParaboloid(I3Tray segment)Perform advanced error estimation using the Paraboloid fit.
- Param pulses:
Default =
'CleanedMuonPulses',- Param MinimizerName:
Default =
'Minuit',- Param If:
Default =
<function <lambda> at 0x171291940>,
- audit¶
audit(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param run_id:
Default =
None,
- generate¶
generate(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param run_id:
Default =
None,
- sdst_to_l1¶
sdst_to_l1(I3Tray segment)SDST to L1, the second part of L1
- Param ic79_geometry:
Default =
False,
- raw_to_sdst¶
raw_to_sdst(I3Tray segment)PFRaw to SDST, the first part of L1
- ShadowFilter¶
ShadowFilter(I3Tray segment)Sun and moon filters for 2013-2014 online filter season (and probably also later). Almost identical to the 2012-2013 season. This segment takes only one configuration parameter, namely the “mcseed”, which is the seed for the random number generator used for picking a relevant MJD in corsika simulated data (the simulation does not provide useful event times). - DO NOT SET THIS PARAMETER TO A NONZERO VALUE FOR EXPERIMENTAL DATA! - IF YOU DO SET IT, MAKE SURE TO KEEP THE GENERATED FAKE MJD TIMES
- Param mcseed:
Default =
0,- Param If:
Default =
<function <lambda> at 0x1715332e0>,
- SLOPFilter¶
SLOPFilter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param use_pulses:
Default =
False,- Param If:
Default =
<function <lambda> at 0x171533560>,
- SLOPSplitter¶
SLOPSplitter(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
- Param InputPulses:
Default =
'InIcePulses',
- TopologicalSplitting¶
TopologicalSplitting(I3Tray segment)Applies the topological splitter to the DAQ frame by first doing a SeededRTHitCleaning, then splitting events with the I3TopologicalSplitter.
- Param seededRTConfig:
Default =
None,- Param InputPulses:
Default =
'InIcePulses',- Param OutputPulses:
Default =
'TopoSplitPulses',- Param SplitName:
Default =
'TopologicalSplit',
- VEFFilter¶
VEFFilter(I3Tray segment)This tray segment is the Vertical Event Filter segment.
- Param pulses:
Default =
'RecoPulses',- Param singlestring:
Default =
False,- Param If:
Default =
<function <lambda> at 0x1715337e0>,
- IceTopVEMCal¶
IceTopVEMCal(I3Tray segment)I3Tray segments should have docstrings. This one doesn’t. Fix it.
