Project DomTools¶
Invoke with: import icecube.DomTools
C++ I3Modules¶
- I3Coincify_I3DOMLaunch¶
"I3Coincify<I3DOMLaunch>"
(C++ I3Module)<undocumented>
- Param CoincidenceNeighbors:
Default =
1
, How far to look for neighbors (DEFAULT: nearest only)- Param CoincidenceWindow:
Default =
800.0
, Time window for local coincidence (DEFAULT=800 ns)- 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 InputName:
Default =
''
, Name of the input RecoPulses (no DEFAULT)- Param IsolatedResponseName:
Default =
''
, Name of the output that contains the responses that fail the coincidence condition (DEFAULT=’’)- Param OutputName:
Default =
'Coincified'
, Name of the output RecoPulses (DEFAULT=Coincified)
- I3Coincify_I3MCHit¶
"I3Coincify<I3MCHit>"
(C++ I3Module)<undocumented>
- Param CoincidenceNeighbors:
Default =
1
, How far to look for neighbors (DEFAULT: nearest only)- Param CoincidenceWindow:
Default =
800.0
, Time window for local coincidence (DEFAULT=800 ns)- 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 InputName:
Default =
''
, Name of the input RecoPulses (no DEFAULT)- Param IsolatedResponseName:
Default =
''
, Name of the output that contains the responses that fail the coincidence condition (DEFAULT=’’)- Param OutputName:
Default =
'Coincified'
, Name of the output RecoPulses (DEFAULT=Coincified)
- I3Coincify_I3RecoHit¶
"I3Coincify<I3RecoHit>"
(C++ I3Module)<undocumented>
- Param CoincidenceNeighbors:
Default =
1
, How far to look for neighbors (DEFAULT: nearest only)- Param CoincidenceWindow:
Default =
800.0
, Time window for local coincidence (DEFAULT=800 ns)- 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 InputName:
Default =
''
, Name of the input RecoPulses (no DEFAULT)- Param IsolatedResponseName:
Default =
''
, Name of the output that contains the responses that fail the coincidence condition (DEFAULT=’’)- Param OutputName:
Default =
'Coincified'
, Name of the output RecoPulses (DEFAULT=Coincified)
- I3Coincify_I3RecoPulse¶
"I3Coincify<I3RecoPulse>"
(C++ I3Module)<undocumented>
- Param CoincidenceNeighbors:
Default =
1
, How far to look for neighbors (DEFAULT: nearest only)- Param CoincidenceWindow:
Default =
800.0
, Time window for local coincidence (DEFAULT=800 ns)- 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 InputName:
Default =
''
, Name of the input RecoPulses (no DEFAULT)- Param IsolatedResponseName:
Default =
''
, Name of the output that contains the responses that fail the coincidence condition (DEFAULT=’’)- Param OutputName:
Default =
'Coincified'
, Name of the output RecoPulses (DEFAULT=Coincified)
- I3DOMLaunchCleaning¶
"I3DOMLaunchCleaning"
(C++ I3Module)<undocumented>
- Param CleanedKeys:
Default =
[]
, OMKeys to clean out of the launch map- Param CleanedKeysList:
Default =
''
, Name of frame vector containing the list of OMKeys to clean out of the launch map- Param FirstLaunchCleaning:
Default =
False
, True if you want to clean out all but the first DOM launch- Param IcePickServiceKey:
Default =
''
, Key for an IcePick in the context that this module should check before processing physics frames.- Param IceTopInput:
Default =
'IceTopRawData'
, input icetop DOMLaunches- Param IceTopOutput:
Default =
'CleanIceTopRawData'
, output icetop DOMLaunches- Param If:
Default =
None
, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param InIceInput:
Default =
'InIceRawData'
, input inice DOMLaunches- Param InIceOutput:
Default =
'CleanInIceRawData'
, output inice DOMLaunches
- I3FirstPulsifier¶
"I3FirstPulsifier"
(C++ I3Module)Returns a pulse series map containing only the first pulses, however each first pulse carrying the total charge of all pulses by default.
- 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 InputPulseSeriesMapName:
Default =
'OnlinePulses'
, Name of input pulse series map- Param KeepOnlyFirstCharge:
Default =
False
, Do you want the first pulse to carry only the charge of the first pulse? (default is charge of all pulses)- Param OutputPulseSeriesMapName:
Default =
'OnlinePulsesFirstPulses'
, Name of output pulse series map (or mask)- Param UseMask:
Default =
False
, Do you want the output to be a bit mask (I3RecoPulseSeriesMapMask) with all pulses except for the first one set to False? This implies KeepOnlyFirstCharge = True since with the mask you can’t integrate the charge
- I3IsolatedHitsCutModule_I3RecoPulse¶
"I3IsolatedHitsCutModule<I3RecoPulse>"
(C++ 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 InputResponse:
Default =
''
, Name of the input reco pulse series (no DEFAULT)- Param OutputResponse:
Default =
''
, Name of the output reco pulse series (no DEFAULT)- Param RTMultiplicity:
Default =
1
, reject all pulses that have a smaller count (spacial/temporal) than RTMultiplicity- Param RTRadius:
Default =
nan
, count pulses within this radius towards multiplicity (DEFAULT=NAN) - NAN=no cut on spacial isolation- Param RTTime:
Default =
nan
, count pulses within this time range towards multiplicity (DEFAULT=NAN) - NAN=no cut on temporal isolation- Param Stream:
Default =
icetray.I3Frame.Physics
, Stream on which to run- Param UseWidth:
Default =
-1
, width in ns to be used for calculation (-1 (default): use width of hit object)
- I3LCCleaning¶
"I3LCCleaning"
(C++ 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 InIceInput:
Default =
'InIceRawData'
, input inice DOMLaunches- Param InIceOutput:
Default =
'CleanInIceRawData'
, output inice HLC DOMLaunches- Param InIceOutputSLC:
Default =
''
, output inice SLC DOMLaunches; “” to disable (default)
- I3LCPulseCleaning¶
"I3LCPulseCleaning"
(C++ 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 =
'OfflinePulses'
, Name of input pulse series- Param OutputHLC:
Default =
'OfflinePulsesHLC'
, Name of HLC pulses (blank to disable)- Param OutputSLC:
Default =
'OfflinePulsesSLC'
, Name of SLC pulses (blank to disable)
- I3OMSelection_I3DOMLaunchSeries¶
"I3OMSelection<I3DOMLaunchSeries>"
(C++ I3Module)<undocumented>
- Param BadOMFileName:
Default =
''
, Name of a file containing bad OMKeys- 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 InputOMSelection:
Default =
''
, Name of a previously-existing OMSelection that you’d like to append to- Param InputResponse:
Default =
'input'
, Name of the input response- Param OmittedKeys:
Default =
[]
, OMKeys for OMs that we want to clean out- Param OmittedStrings:
Default =
[]
, Strings for OMs that we want to clean out- Param OutputOMSelection:
Default =
'BadOMSelection'
, Name of the new OMSelection that will be created- Param OutputResponse:
Default =
'output'
, Name of the output response- Param SelectInverse:
Default =
False
, Selects the Inverse of the specified selection- Param Stream:
Default =
icetray.I3Frame.DAQ
, Stream on which to run
- I3OMSelection_I3RecoPulseSeries¶
"I3OMSelection<I3RecoPulseSeries>"
(C++ I3Module)<undocumented>
- Param BadOMFileName:
Default =
''
, Name of a file containing bad OMKeys- 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 InputOMSelection:
Default =
''
, Name of a previously-existing OMSelection that you’d like to append to- Param InputResponse:
Default =
'input'
, Name of the input response- Param OmittedKeys:
Default =
[]
, OMKeys for OMs that we want to clean out- Param OmittedStrings:
Default =
[]
, Strings for OMs that we want to clean out- Param OutputOMSelection:
Default =
'BadOMSelection'
, Name of the new OMSelection that will be created- Param OutputResponse:
Default =
'output'
, Name of the output response- Param SelectInverse:
Default =
False
, Selects the Inverse of the specified selection- Param Stream:
Default =
icetray.I3Frame.Physics
, Stream on which to run
- I3ResponseMapSplitter¶
"I3ResponseMapSplitter"
(C++ I3Module)hit set splitteer
- Param DoBrightSt:
Default =
False
, Sort hits according to proximity to brightest string (default FALSE).- Param DoKmeans:
Default =
False
, Sort hits according to kmeans algorithm (default FALSE).- Param DoTMedian:
Default =
False
, Time-split pulses on the median instead of the mean time (default FALSE).- Param DoTRes:
Default =
False
, Sort hits according to time residual (default FALSE).- Param I3GeometryName:
Default =
'I3Geometry'
, Name of (alternative) I3Geometry 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 InputPulseMap:
Default =
''
, Name of pulse map (or pulse mask) to split- Param InputTrackName:
Default =
''
, Name of a trackfit; hit/pulse maps are split geometrically, either using the plane perpendicular to the track and through the COG as a divider OR the time residual of the hit relative to the track (if doTRes is set).If no track name is specified, or the fit had failed, then the hit/pulses are split by comparing their time tothe average hit/pulse time.- Param maxDBrightSt:
Default =
150.0
, Maximum radial distance from brightest track (default 150.).- Param MaxTRes:
Default =
1000.0
, Maximum time residual relative to fit track (default 1000.).- Param MinimumNch:
Default =
2
, minimum number of DOMs with hits- Param MinTRes:
Default =
0.0
, Minimum time residual relative to fit track (default 0.).- Param SplitEvents:
Default =
False
, Run as an event splitter. If True, the module will run on DAQ frames and emit two Physics frames containing the halves of the event.- Param SubEventStreamName:
Default =
''
, The name of the SubEvent stream.- Param TSplitWeight:
Default =
'OLD'
, Time-split pulse weighting for split-time (median or mean): ‘OLD’: use all pulses with equal weight ‘Charge’: use all pulses, weighted with charge ‘DOM’: use only first pulse in each DOM, ignore charge.- Param WantRotated:
Default =
False
, Sort hits according to kmeans algorithm, rotated around track (default FALSE).
- I3TimeWindowCleaning_I3DOMLaunch¶
"I3TimeWindowCleaning<I3DOMLaunch>"
(C++ 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 InputResponse:
Default =
'hits'
, The detector response object to read in- Param OutputResponse:
Default =
'hitsClean'
, The detector response object to read in- Param TimeWindow:
Default =
4000.0
, The window that is used in cleaning out DOMs.- Param UseCharge:
Default =
False
, If true, the charge will be used to determine the best time window, if false, pulses are merily counted. Has no influence if not used with I3RecoPulses.
- I3TimeWindowCleaning_I3MCHit¶
"I3TimeWindowCleaning<I3MCHit>"
(C++ 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 InputResponse:
Default =
'hits'
, The detector response object to read in- Param OutputResponse:
Default =
'hitsClean'
, The detector response object to read in- Param TimeWindow:
Default =
4000.0
, The window that is used in cleaning out DOMs.- Param UseCharge:
Default =
False
, If true, the charge will be used to determine the best time window, if false, pulses are merily counted. Has no influence if not used with I3RecoPulses.
- I3TimeWindowCleaning_I3RecoHit¶
"I3TimeWindowCleaning<I3RecoHit>"
(C++ 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 InputResponse:
Default =
'hits'
, The detector response object to read in- Param OutputResponse:
Default =
'hitsClean'
, The detector response object to read in- Param TimeWindow:
Default =
4000.0
, The window that is used in cleaning out DOMs.- Param UseCharge:
Default =
False
, If true, the charge will be used to determine the best time window, if false, pulses are merily counted. Has no influence if not used with I3RecoPulses.
- I3TimeWindowCleaning_I3RecoPulse¶
"I3TimeWindowCleaning<I3RecoPulse>"
(C++ 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 InputResponse:
Default =
'hits'
, The detector response object to read in- Param OutputResponse:
Default =
'hitsClean'
, The detector response object to read in- Param TimeWindow:
Default =
4000.0
, The window that is used in cleaning out DOMs.- Param UseCharge:
Default =
False
, If true, the charge will be used to determine the best time window, if false, pulses are merily counted. Has no influence if not used with I3RecoPulses.