Project NoiseEngine¶
Invoke with: import icecube.NoiseEngine
C++ I3Modules¶
- NoiseEngine¶
"NoiseEngine"(C++ I3Module)IceTray.
- Param BinsName:
Default =
'', The name of the I3Vector containing the Healpix bin contents to be pushed to the frame. If blank, bin contents will not be pushed to the frame- Param ChargeWeight:
Default =
True, If using I3RecoPulses, would you like to weight each pair by their average charge?- Param EndVelocity:
Default =
1.0, The maximum implied speed (m/ns) for each pair of hits (Default: 1. m/ns)- Param HealpixOrder:
Default =
1, The order of the Healpix map used. 0 = 12 bins, 1 = 48 bins, 2 = 192 bins, 3 = 768 bins.- Param HitSeriesName:
Default =
'CleanInIceRawData', The name of the hit series to process 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 NChLimit:
Default =
20, The maximum number of hit DOMs to process. If more DOMs are hit than this, the event automatically passes to avoid wasting processing time.- Param OutputName:
Default =
'NoiseEngine', The name of the boolean decision to be pushed to the frame- Param StartVelocity:
Default =
0.1, The minimum implied speed (m/ns) for each pair of hits (Default: 0.1 m/ns)- Param Threshold:
Default =
3.0, The number of hit pairs needed in one bin to pass the trigger.- Param TimerName:
Default =
'', The name of the I3Double to push to the frame holding the amount of time (for testing purposes).- Param TimeWindowLength:
Default =
750.0, The length of the sliding time window use to choose pairs- Param VelocityName:
Default =
'', The name of the I3Vector containing the velocities of selected pairs to be pushed to the frame. If blank, velocities will not be pushed to the frame
I3Tray segments¶
- WithCleaners¶
WithCleaners(I3Tray segment)Clustering algorithm to identify pure noise events, with some noise cleaning before it runs For documentation on how these cleaning settings were optimized, see the talk from Michael Larson in Uppsala: https://events.icecube.wisc.edu/event/36/contributions/2168/
- Param HitSeriesName:
Default =
'Pulses_cleaned', Name of the I3RecoPulseSeries to get pulses from.- Param OutputName:
Default =
'NoiseEngine_bool', Name of the output I3Bool to be written to the frame- Param If:
Default =
<function <lambda> at 0x106ba8e00>, the usual python function, makes the segment run conditionally frame by frame.- Param writePulses:
Default =
<function <lambda> at 0x106ba8ea0>, Boolean if you want the hit series that NoiseEngine sees (after the pre- processing cleaning) to stay in the frame. Default is true, set to false if you would rather just throw these out.
