Project wimpsim-reader

Invoke with: import icecube.wimpsim_reader

C++ I3Modules

I3WimpSimReader

"I3WimpSimReader" (C++ I3Module)

<undocumented>

Param EndMJD:

Default = nan, MJD to end simulation; if unspecified: read everything

Param FileNameList:

Default = [], The WimpSim file to read from

Param InfoFileName:

Default = '', write Information to this textfile

Param InjectionRadius:

Default = nan, If >0, events will be injected in cylinder with zmin, zmax height. If 0, inject in a box defined by PositionLimits. Note that the average X/Y/Z position from PositionLimits will be used as the center of the cylinder.

Param LowerZenCut:

Default = 0.0, optional lower Zenith Cut in [rad]

Param NEvents:

Default = 0, Number of events to issue, if unconfigured read everything

Param Oversampling:

Default = 0, N oversamplings

Param PositionLimits:

Default = [-800.0, 800.0, -800.0, 800.0, -800.0, 800.0], Array of xmin,xmax,ymin,ymax,zmin,zmax. Used as the injection volume if InjectionRadius<=0.

Param RandomService:

Default = None, The RandomService in the context

Param RandomServiceName:

Default = 'I3RandomService', Name of the RandomService to be used

Param SensitiveHeight:

Default = nan, Muon box activated height

Param SensitiveRadius:

Default = nan, Muon box activated radius

Param StartMJD:

Default = nan, MJD to start simulation; if unspecified: read everything

Param UpperZenCut:

Default = 3.141592653589793, optional upper Zenith Cut in [rad]

Param UseElectrons:

Default = False, Read and simulate electron vertices

Param UseMuons:

Default = True, Read and simulate muon vertices

Param UseNC:

Default = False, Read and simulate NeutralCurrent vertices

Param UseTaus:

Default = False, Read and simulate tau vertices

Python I3Modules

NuMuValueCollector

NuMuValueCollector (Python I3Module)

collect the Veff from all events; do not forget to devide by the weight-sum in the end

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 WIMPparamsName:

Default = 'WIMP_params', The name of the input WIMPparams

VeffCollector

VeffCollector (Python I3Module)

collect the Veff from all events; do not forget to devide by the weight-sum in the end

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 WIMPparamsName:

Default = 'WIMP_params', The name of the input WIMPparams

I3Tray segments

WimpSimReaderEarth

WimpSimReaderEarth (I3Tray segment)

run this traysegement for earth files

Param GCDFileName:

Default = None, specify either this to take the detector start_time as event-time -or- use a random time-stamp in [startMJD, endMJD]

Param Infile:

Default = None, infile or list of infiles to read

Param StartMJD:

Default = nan, pick a random MJD starting from this time

Param EndMJD:

Default = nan, pick a random MJD ending at this time

WimpSimReaderSUN

WimpSimReaderSUN (I3Tray segment)

run this traysegement for Sun files

Param Infile:

Default = None, infile or list of infiles to read

Param StartMJD:

Default = nan, read only from this MJD

Param EndMJD:

Default = nan, read only until this MJD

get_oneweight

get_oneweight (I3Tray segment)

I3Tray segments should have docstrings. This one doesn’t. Fix it.

Param If:

Default = <function <lambda> at 0x106a4d9e0>,