Project STTools

Invoke with: import icecube.STTools

C++ I3Modules

I3RTVeto_DOMLaunch_Module

"I3RTVeto_DOMLaunch_Module" (C++ I3Module)

<undocumented>

Param GeometryName:

Default = 'I3Geometry', Name of the I3Geometry frame object that should be used for constructing the spatial context.

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

Default = '', Name of the input hit series map.

Param OutputHitSeriesMapName:

Default = '', Name of the output hit series map.

Param STConfigService:

Default = None, The ST configuration service object, that provides the ST configuration for this ST icetray module.

Param Streams:

Default = [icetray.I3Frame.Physics], The set of I3Frame types (a.k.a. streams) for which the RunSTAlgorithm method will get executed.

I3RTVeto_RecoPulseMask_Module

"I3RTVeto_RecoPulseMask_Module" (C++ I3Module)

<undocumented>

Param GeometryName:

Default = 'I3Geometry', Name of the I3Geometry frame object that should be used for constructing the spatial context.

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

Default = '', Name of the input hit series map.

Param OutputHitSeriesMapName:

Default = '', Name of the output hit series map.

Param STConfigService:

Default = None, The ST configuration service object, that provides the ST configuration for this ST icetray module.

Param Streams:

Default = [icetray.I3Frame.Physics], The set of I3Frame types (a.k.a. streams) for which the RunSTAlgorithm method will get executed.

I3RTVeto_RecoPulse_Module

"I3RTVeto_RecoPulse_Module" (C++ I3Module)

<undocumented>

Param GeometryName:

Default = 'I3Geometry', Name of the I3Geometry frame object that should be used for constructing the spatial context.

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

Default = '', Name of the input hit series map.

Param OutputHitSeriesMapName:

Default = '', Name of the output hit series map.

Param STConfigService:

Default = None, The ST configuration service object, that provides the ST configuration for this ST icetray module.

Param Streams:

Default = [icetray.I3Frame.Physics], The set of I3Frame types (a.k.a. streams) for which the RunSTAlgorithm method will get executed.

I3SeededRTCleaning_DOMLaunch_Module

"I3SeededRTCleaning_DOMLaunch_Module" (C++ I3Module)

<undocumented>

Param AllowNoSeedHits:

Default = False, The switch if it is allowed that an event has no seed hits, i.e. no hits will be present in the output for those events.

Param GeometryName:

Default = 'I3Geometry', Name of the I3Geometry frame object that should be used for constructing the spatial context.

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

Default = '', Name of the input hit series map.

Param MaxNIterations:

Default = -1, The maximal number of iterations for the iterative RT hits selection procedure. The value -1 means no constraint on the number of iterations.

Param NHitsThreshold:

Default = 2, Some seed procedures need a configured number of hits threshold. This is it. The value 0 means no threshold.

Param OutputDiscardedHLCHitSeriesMapName:

Default = '', The frame object name of the optional hit series map output for HLC hits that were cleaned away by the seededRT algorithm. An empty “” name disables this output.

Param OutputDiscardedSLCHitSeriesMapName:

Default = '', The frame object name of the optional hit series map output for SLC hits that were cleaned away by the seededRT algorithm. An empty “” name disables this output.

Param OutputHitSeriesMapName:

Default = '', Name of the output hit series map.

Param SeedHitSeriesMapName:

Default = '', The name of the hit series map inside the current processed frame, whose hits should be used as seed hits. So this hit series map must be a subset of the hit series map named InputHitSeriesMapName. Otherwise no hits will be used as seeds at all.

Param SeedOMKeyList:

Default = [], The list of OMKey objects, that should be used by the OMHits seed procedure.

Param SeedProcedure:

Default = 'AllHLCHits', The name of the procedure to use for determining the initial seed hits. The following values are possible: “AllHLCHits”: All HLC hits will be used as seed hits. “AllCoreHits”: All hits that have at least NHitsThreshold partner ST hits will be used as seed hits. “HLCCoreHits”: Only HLC hits, that have a certain amount of partner ST HLC hits. If the AllowNoSeedHits parameter is set to false and the HLC core is empty, all HLC hits will be used as seed hits. “HLCCOGSTHits”: Hits which fulfill the ST conditions around the Center-of- Gravity of all HLC hits, are used as seed hits. “OMKeyHits”: Select all hits as seed hits which belong to the OMs present in the configured (SeedOMKeyList) list of OMKey objects. “FirstOMKeyHits”: Select hits as seed hits which belong to the OMs present in the configured (SeedOMKeyList) list of OMKey objects and are the first hits within the OM’s hit series. (This seed procedure was used by the original SeededRTCleaning module when configured with Seeds=’Brightest’.) “HitSeriesMapHitsFromFrame”: Selects hits as seed hits which are contained inside an hit series map named SeedHitSeriesMapName inside the current processed frame.

Param STConfigService:

Default = None, The ST configuration service object, that provides the ST configuration for this ST icetray module.

Param StoreEmptyResults:

Default = True, The switch if resulting hit maps should be put in the frame when they are empty.

Param Streams:

Default = [icetray.I3Frame.Physics], The set of I3Frame types (a.k.a. streams) for which the RunSTAlgorithm method will get executed.

I3SeededRTCleaning_RecoPulseMask_Module

"I3SeededRTCleaning_RecoPulseMask_Module" (C++ I3Module)

<undocumented>

Param AllowNoSeedHits:

Default = False, The switch if it is allowed that an event has no seed hits, i.e. no hits will be present in the output for those events.

Param GeometryName:

Default = 'I3Geometry', Name of the I3Geometry frame object that should be used for constructing the spatial context.

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

Default = '', Name of the input hit series map.

Param MaxNIterations:

Default = -1, The maximal number of iterations for the iterative RT hits selection procedure. The value -1 means no constraint on the number of iterations.

Param NHitsThreshold:

Default = 2, Some seed procedures need a configured number of hits threshold. This is it. The value 0 means no threshold.

Param OutputDiscardedHLCHitSeriesMapName:

Default = '', The frame object name of the optional hit series map output for HLC hits that were cleaned away by the seededRT algorithm. An empty “” name disables this output.

Param OutputDiscardedSLCHitSeriesMapName:

Default = '', The frame object name of the optional hit series map output for SLC hits that were cleaned away by the seededRT algorithm. An empty “” name disables this output.

Param OutputHitSeriesMapName:

Default = '', Name of the output hit series map.

Param SeedHitSeriesMapName:

Default = '', The name of the hit series map inside the current processed frame, whose hits should be used as seed hits. So this hit series map must be a subset of the hit series map named InputHitSeriesMapName. Otherwise no hits will be used as seeds at all.

Param SeedOMKeyList:

Default = [], The list of OMKey objects, that should be used by the OMHits seed procedure.

Param SeedProcedure:

Default = 'AllHLCHits', The name of the procedure to use for determining the initial seed hits. The following values are possible: “AllHLCHits”: All HLC hits will be used as seed hits. “AllCoreHits”: All hits that have at least NHitsThreshold partner ST hits will be used as seed hits. “HLCCoreHits”: Only HLC hits, that have a certain amount of partner ST HLC hits. If the AllowNoSeedHits parameter is set to false and the HLC core is empty, all HLC hits will be used as seed hits. “HLCCOGSTHits”: Hits which fulfill the ST conditions around the Center-of- Gravity of all HLC hits, are used as seed hits. “OMKeyHits”: Select all hits as seed hits which belong to the OMs present in the configured (SeedOMKeyList) list of OMKey objects. “FirstOMKeyHits”: Select hits as seed hits which belong to the OMs present in the configured (SeedOMKeyList) list of OMKey objects and are the first hits within the OM’s hit series. (This seed procedure was used by the original SeededRTCleaning module when configured with Seeds=’Brightest’.) “HitSeriesMapHitsFromFrame”: Selects hits as seed hits which are contained inside an hit series map named SeedHitSeriesMapName inside the current processed frame.

Param STConfigService:

Default = None, The ST configuration service object, that provides the ST configuration for this ST icetray module.

Param StoreEmptyResults:

Default = True, The switch if resulting hit maps should be put in the frame when they are empty.

Param Streams:

Default = [icetray.I3Frame.Physics], The set of I3Frame types (a.k.a. streams) for which the RunSTAlgorithm method will get executed.

I3SeededRTCleaning_RecoPulse_Module

"I3SeededRTCleaning_RecoPulse_Module" (C++ I3Module)

<undocumented>

Param AllowNoSeedHits:

Default = False, The switch if it is allowed that an event has no seed hits, i.e. no hits will be present in the output for those events.

Param GeometryName:

Default = 'I3Geometry', Name of the I3Geometry frame object that should be used for constructing the spatial context.

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

Default = '', Name of the input hit series map.

Param MaxNIterations:

Default = -1, The maximal number of iterations for the iterative RT hits selection procedure. The value -1 means no constraint on the number of iterations.

Param NHitsThreshold:

Default = 2, Some seed procedures need a configured number of hits threshold. This is it. The value 0 means no threshold.

Param OutputDiscardedHLCHitSeriesMapName:

Default = '', The frame object name of the optional hit series map output for HLC hits that were cleaned away by the seededRT algorithm. An empty “” name disables this output.

Param OutputDiscardedSLCHitSeriesMapName:

Default = '', The frame object name of the optional hit series map output for SLC hits that were cleaned away by the seededRT algorithm. An empty “” name disables this output.

Param OutputHitSeriesMapName:

Default = '', Name of the output hit series map.

Param SeedHitSeriesMapName:

Default = '', The name of the hit series map inside the current processed frame, whose hits should be used as seed hits. So this hit series map must be a subset of the hit series map named InputHitSeriesMapName. Otherwise no hits will be used as seeds at all.

Param SeedOMKeyList:

Default = [], The list of OMKey objects, that should be used by the OMHits seed procedure.

Param SeedProcedure:

Default = 'AllHLCHits', The name of the procedure to use for determining the initial seed hits. The following values are possible: “AllHLCHits”: All HLC hits will be used as seed hits. “AllCoreHits”: All hits that have at least NHitsThreshold partner ST hits will be used as seed hits. “HLCCoreHits”: Only HLC hits, that have a certain amount of partner ST HLC hits. If the AllowNoSeedHits parameter is set to false and the HLC core is empty, all HLC hits will be used as seed hits. “HLCCOGSTHits”: Hits which fulfill the ST conditions around the Center-of- Gravity of all HLC hits, are used as seed hits. “OMKeyHits”: Select all hits as seed hits which belong to the OMs present in the configured (SeedOMKeyList) list of OMKey objects. “FirstOMKeyHits”: Select hits as seed hits which belong to the OMs present in the configured (SeedOMKeyList) list of OMKey objects and are the first hits within the OM’s hit series. (This seed procedure was used by the original SeededRTCleaning module when configured with Seeds=’Brightest’.) “HitSeriesMapHitsFromFrame”: Selects hits as seed hits which are contained inside an hit series map named SeedHitSeriesMapName inside the current processed frame.

Param STConfigService:

Default = None, The ST configuration service object, that provides the ST configuration for this ST icetray module.

Param StoreEmptyResults:

Default = True, The switch if resulting hit maps should be put in the frame when they are empty.

Param Streams:

Default = [icetray.I3Frame.Physics], The set of I3Frame types (a.k.a. streams) for which the RunSTAlgorithm method will get executed.

C++ ServiceFactorys

I3BasicSeededRTConfigurationServiceFactory

"I3BasicSeededRTConfigurationServiceFactory" (C++ ServiceFactory)

<undocumented>

Param AllowSelfCoincidence:

Default = False, If true, allow hits on the same OM to be in causal connection with each other

Param DustlayerLowerZBoundary:

Default = -150.0, The lower bound of the z-coordinate of the dust layer.Used only when the dust layer correction has been enabled.

Param DustlayerUpperZBoundary:

Default = 0.0, The upper bound of the z-coordinate of the dust layer.Used only when the dust layer correction has been enabled.

Param RTRadius:

Default = 150.0, The RT radius

Param RTTime:

Default = 1000.0, The RT time

Param Treat_String_36_as_DeepCore:

Default = True, If true, treat string 36 (OMs 20-24 and 40-60) as part of DeepCore

Param UseDustlayerCorrection:

Default = True, If true, correct for the dust layer