Project polyplopia¶
Invoke with: import icecube.polyplopia
C++ I3Modules¶
- MPHitFilter¶
"MPHitFilter"(C++ I3Module)An I3IcePick which selects events which have have MCPEs >= threshold.
- Param Filter:
Default =
True, Remove events that don’t pass threshold- Param HitOMThreshold:
Default =
1, Minimum number of hit OMs to pass filter- Param I3MCPESeriesMapName:
Default =
'I3MCPESeriesMap', Name of HitSeriesMap object to scan- Param IceTopMCPESeriesMapName:
Default =
'', Name of IceTop HitSeriesMap object to scan- Param MCTreeName:
Default =
'I3MCTree', Name of I3MCTree object in frame- Param PolyplopiaInfoName:
Default =
'PolyplopiaInfo', map of weights to merge- Param PruneTree:
Default =
True, Cut dead MCTree branches that don’t produce MCPEs- Param RemoveBackgroundOnly:
Default =
True, Remove events that don’t contain primary
- PoissonMerger¶
"PoissonMerger"(C++ I3Module)This modules implements the exponential distribution sampling exclusively. PoissonMerger assigns a random time to each event based on an exponential distribution with a mean time tau given as a configuration parameter. If two or more events fall within the time window delta_t, they are combined into a single event. Events are given an additional weight callde ‘PolyplopiaWeight’ which determines the likely hood of a combined event given a change in energy spectrum.
- Param CoincidentEventService:
Default =
None, Service to inject background CR events from- Param IcePickServiceKey:
Default =
'', Key for an IcePick in the context that this module should check before processing physics frames.- Param IceTopTreeName:
Default =
'', Name of IceTop I3MCTree- Param If:
Default =
None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t- Param MCTreeName:
Default =
'I3MCTree', Name of I3MCTree objects to merge- Param PrimaryType:
Default =
'corsika', Primary Type (corsika, nugen, etc). To avoid overcounting with corsika.- Param RandomServiceName:
Default =
'I3RandomService', The name of the random service to use- Param Rate:
Default =
nan, Event rate (if NaN polyplopia should get this from background file)- Param SeparateMCTree:
Default =
'', Put coincident events into this separate MCTree- Param TimeWindow:
Default =
40000.0, Coincident event time window
- PoissonPEMerger¶
"PoissonPEMerger"(C++ I3Module)<undocumented>
- Param BaseIsBackground:
Default =
True, Whether the base simulation into which events will be merged is itself background (i.e. Corsika or MuonGun)- Param CoincidentEventService:
Default =
<Unprintable>, Service to inject background CR events from- Param MCPEsToMerge:
Default =
'', The name of the I3MCPESeriesMaps to merge- Param MCTreeName:
Default =
'I3MCTree', Name of I3MCTree objects to merge- Param MMCTrackName:
Default =
'', The name of the MMCTrackList to merge (if any)- Param PhotonsToMerge:
Default =
'', The name of the I3PhotonSeriesMaps to merge- Param RandomService:
Default =
'I3RandomService', The name of the random service to use- Param Rate:
Default =
nan, Event rate (if NaN polyplopia should get this from background file)- Param TimeWindow:
Default =
40000.0, Coincident event time window
Python I3Modules¶
- CorsikaTimeScaleFixer¶
CorsikaTimeScaleFixer(Python I3Module)Adjusts the corsika timescale when only a fraction of events in a file are read. The module loops over the file to count the number of events at initialization and then uses this total number of events along with the number of events to read to rescale the TimeScale variable so that subsequent use of this file by e.g. polyplopia will correctly calculate the event rate.
- Param InputFile:
Default =
'', Name of the file being read- Param MaxExcess:
Default =
50, The maximum number of events over the read limit to tolerate- Param ReadEvents:
Default =
0, The number of events actually being read
- PoissonPEMerger¶
PoissonPEMerger(Python I3Module)<undocumented>
- Param BackgroundFile:
Default =
'', File to inject events from- Param I3MCPESeriesName:
Default =
'I3MCPESeriesMap', Name of I3MCPESeriesMap object in frame- Param MCTreeName:
Default =
'I3MCTree', Name of I3MCTree object in frame- Param MMCTrackName:
Default =
'MMCTrackList', Name of MMCTrackList object in frame- Param RandomService:
Default =
None, RNG Service (superceeds Seed)- Param Rate:
Default =
0.0, Event rate (zero if polyplopia should get this from summary service)- Param Seed:
Default =
0, RNG Seed- Param TimeWindow:
Default =
200000.0, Time window for randomized events (in the center will be the neutrino. A big timewindow should be taken (200000 ??) - see http://wiki.icecube.wisc.edu/index.php/Coincident_Simulation_Fixes#Delta- t_timestructures_with_this_new_scheme
C++ ServiceFactorys¶
- CoincidentI3ReaderServiceFactory¶
"CoincidentI3ReaderServiceFactory"(C++ ServiceFactory)<undocumented>
- Param FileName:
Default =
'', Input file from which to read background events
