Project VHESelfVeto

Invoke with: import icecube.VHESelfVeto

C++ I3Modules

BadStringRemover

"BadStringRemover" (C++ I3Module)

<undocumented>

Param BadDOMFractionForBadString:

Default = 0.3, Fraction of bad DOMs on a string for that string to be flagged as bad

Param BadDOMList:

Default = 'BadDomsList', Name of bad DOM list to use

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param IgnoreDeepCoreStrings:

Default = True, flag to ignore DeepCore strings, defaulting to true for original functionality

Param OutGeometry:

Default = 'I3GeometryWithoutBadStrings', Name of trimmed geometry to write out

Param OutNBadStrings:

Default = '', optional: I3Int with number of bad strings

Param OutPulses:

Default = 'SplitOfflinePulsesTrimmed', Name of trimmed pulse series to write out

Param Pulses:

Default = 'SplitOfflinePulses', Name of pulse series to use

DetectorShrinker

"DetectorShrinker" (C++ I3Module)

<undocumented>

Param BottomBoundaryWidth:

Default = 10.0, Distance from the bottom detector edge where there should be no hits.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param InGeometry:

Default = 'I3Geometry', Name of original geometry to read

Param OutGeometry:

Default = 'I3GeometryTrimmed', Name of trimmed geometry to write out

Param OutPulses:

Default = 'OfflinePulsesTrimmed', Name of trimmed pulse series to write out

Param Pulses:

Default = 'OfflinePulses', Name of pulse series to use

Param TopBoundaryWidth:

Default = 90.0, Distance from the top and side detector edge where there should be no hits.

FiducialVolumeEntryPointFinder

"FiducialVolumeEntryPointFinder" (C++ I3Module)

<undocumented>

Param AssumeMuonTracksAreInfinite:

Default = False, Assume muon tracks have an infinite length. If this is false, then the real starting poisition of the muon will be used

Param BottomBoundaryWidth:

Default = 10.0, Distance from the bottom detector edge where there should be no vertices.

Param Geometry:

Default = 'I3Geometry', Name of geometry object 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 MCTreeName:

Default = 'I3MCTree', Name of I3MCTree containing Monte Carlotruth information

Param ParticleIntersectionsName:

Default = 'IntersectingParticles', Name of the output vector containing all intersecting particles

Param SideBoundaryWidth:

Default = 70.0, Distance from the side edge where there should be no vertices.

Param TopBoundaryWidth:

Default = 90.0, Distance from the top detector edge where there should be no vertices.

HomogenizedQTot

"HomogenizedQTot" (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 Output:

Default = 'QTot', Name of output object

Param Pulses:

Default = 'OfflinePulses', Name of pulse series to use

Param VertexTime:

Default = '', Name of vertex time on which to impose charge causality requirements (ignored if blank)

I3TrackVeto

"I3TrackVeto" (C++ I3Module)

Down-going muon track veto of the MESE selection.

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

Default = 'TrackVetoFit', Name for track hypothesis that gives the largest total charge

Param Pulses:

Default = '', Name of the pulse series map to check for direct pulses

Param Radius:

Default = 100.0, Only consider DOMs within this perpendicular distance to the track hypothesis.

Param SeedService:

Default = None, Seed service to query for track hypotheses

Param TimeWindow:

Default = make_pair(-15,500), Time window definition for direct pulses

LayerVeto

"LayerVeto" (C++ I3Module)

<undocumented>

Param BadDOMList:

Default = 'BadDomsList', Name of the list of DOMs that do not produce data

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

Default = 'LayerVeto', Prefix for output quantities

Param Pulses:

Default = 'OfflinePulsesHLCNoDeepCore', Name of the pulse series to examine for veto hits

Param QMax:

Default = 250.0, Maximum charge required to end the veto window

Param QMin:

Default = 3.0, Minimum charge required to end the veto window

Param QScale:

Default = 24.0, For total charges between QMin and QMax, require QTotal/QScale charge to end the veto window

Param TagThreshold:

Default = inf, Charge threshold for tagging events on outer layer

Param TimeWindow:

Default = 3000.0, Maximum length of the veto window

Param VetoLayers:

Default = None, Callback to define veto layers

TauGeneratesMuon

"TauGeneratesMuon" (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 MCTreeName:

Default = 'I3MCTree', Name of I3MCTree containing Monte Carlotruth information

Param OutgoingMuonName:

Default = 'OutgoingMuon', Name of I3Particle containing the MC particle corresponding to the outgoing muon

Param OutputBool:

Default = 'TauGeneratesMuon', Name of I3Bool containing the veto pass decision

VHESelfVeto

"VHESelfVeto" (C++ I3Module)

<undocumented>

Param BottomBoundaryWidth:

Default = 10.0, Distance from the bottom detector edge where there should be no hits.

Param DustLayer:

Default = -135, Mid-detector layer that should contain no hits.

Param DustLayerWidth:

Default = 80.0, Mid-detector layer boundary width – only applies below the dust layer

Param Geometry:

Default = 'I3Geometry', Name of geometry object 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 OutputBool:

Default = 'VHESelfVeto', Name of I3Bool containing the veto pass decision

Param OutputVertexPos:

Default = 'VHESelfVetoVertexPos', Name of I3Position containing the vertex position guess

Param OutputVertexTime:

Default = 'VHESelfVetoVertexTime', Name of I3Double containing the vertex time guess

Param Pulses:

Default = 'OfflinePulses', Name of pulse series to use

Param TimeWindow:

Default = 3000.0, Size of sliding time window to examine.

Param TopBoundaryWidth:

Default = 90.0, Distance from the top and side detector edge where there should be no hits.

Param VertexThreshold:

Default = 250.0, Number of PE in the sliding time window that constitudes a vertex detection

Param VetoThreshold:

Default = 3.0, Maximum number of PE permitted within the detector boundary before the vertex time

VertexInFiducialVolume

"VertexInFiducialVolume" (C++ I3Module)

<undocumented>

Param BottomBoundaryWidth:

Default = 10.0, Distance from the bottom detector edge where there should be no vertices.

Param DustLayer:

Default = nan, Mid-detector layer that should contain no hits.

Param DustLayerWidth:

Default = nan, Mid-detector layer boundary width – only applies below the dust layer

Param Geometry:

Default = 'I3Geometry', Name of geometry object 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 MCTreeName:

Default = 'I3MCTree', Name of I3MCTree containing Monte Carlotruth information

Param NumVerticesName:

Default = 'NumVerticesInFiducialVolume', Number of vertices for this event

Param OutputBool:

Default = 'VertexInFiducialVolume', Name of I3Bool containing the veto pass decision

Param SideBoundaryWidth:

Default = 70.0, Distance from the side edge where there should be no vertices.

Param TopBoundaryWidth:

Default = 90.0, Distance from the top detector edge where there should be no vertices.

Param VertexIncomingNeutrinoName:

Default = 'VertexIncomingNeutrino', Name of I3Particle containing the MC particle corresponding to the incoming neutrino

Param VertexOutgoingHadronName:

Default = 'VertexOutgoingHadron', Name of I3Particle containing the MC particle corresponding to the outgoing hadron

Param VertexOutgoingLeptonName:

Default = 'VertexOutgoingLepton', Name of I3Particle containing the MC particle corresponding to the outgoing lepton

Param VertexPosName:

Default = 'VertexPosition', Name of I3Position containing the MC vertex position

Param VertexTimeName:

Default = 'VertexTime', Name of I3Double containing the MC vertex time

Python I3Modules

I3ACausalHitSelector

I3ACausalHitSelector (Python I3Module)

Select non-causal pulses.

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

Default = 60.0, float: Ignore DOMs within this distance to the vertex position; the default is 60m.

Param output:

Default = '', str: Name for the pulse series map of non-causal pulses

Param Pulses:

Default = '', str: Name of pulse series map to check for non-causal pulses

Param SafetyMargin:

Default = 50.0, float: Treat negative time residuals within this time window as causally connected; the default is 50ns.

Param VertexFit:

Default = '', str: Name of vertex fit

I3Tray segments

I3LayerVeto

I3LayerVeto (I3Tray segment)

Outer-layer veto of the MESE selection

Param pulses:

Default = None,

Param toplayer:

Default = 90.0,

Param dustlayer:

Default = (-220.0, -100.0),

Param mincharge:

Default = 3.0,

Param maxcharge:

Default = 250.0,

Param chargescale:

Default = 24.0,

Param timewindow:

Default = 3000000.0,

Param output:

Default = 'LayerVeto',

AxialCscdLlhFitter

AxialCscdLlhFitter (I3Tray segment)

A drop-in replacement for I3CscdLlhModule.

Param Pulses:

Default = None,

Param Seed:

Default = None,

Param If:

Default = None,

I3TrackVeto

I3TrackVeto (I3Tray segment)

Down-going muon track veto of the MESE selection

Param pulses:

Default = None,

Param vertexfit:

Default = None,

Param radius:

Default = 100.0,

Param timewindow:

Default = (-15.0, 500.0),

Param nside:

Default = 4,

Param hemisphere:

Default = 'down',

Param tracktype:

Default = icecube._dataclasses.ParticleShape.InfiniteTrack,

Param output:

Default = 'TrackVetoFit',