Project filter-tools

Invoke with: import icecube.filter_tools

C++ I3Modules

CreateFilterMask

"CreateFilterMask" (C++ I3Module)

This module creates an I3FilterResultMap based on the I3Bools in the frame.

Param OutputName:

Default = 'FilterMask', Name to give the I3FilterResultMap object in the frame

DistributePnFObjects

"DistributePnFObjects" (C++ I3Module)

<undocumented>

Param If:

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

Param SubstreamNames:

Default = ['NullSplit', 'InIceSplit', 'IceTopSplit'], list of the name of substreams

FilterCheckModule

"FilterCheckModule" (C++ I3Module)

This module verifies the result of the pole filter.

Param FilterResultName:

Default = 'FilterMask', Name of I3FilterResultMap object in frame

FilterMask2Bools

"FilterMask2Bools" (C++ I3Module)

This module takes an existing I3FilterResultMap and writes out each filter result individually to the frame as an I3Bool given by conditionPassed AND (IgnorePrescale OR prescalePassed), where IgnorePrescale is a parameter of FilterMask2Bools. Original intent was to pass bools to the flat-ntuple module.

Param FilterResultName:

Default = 'FilterMask', Name of I3FilterResultMap object in frame

Param IgnorePrescale:

Default = False, Whether or not to ignore filter result prescale booleans

FilterMaskMaker

"FilterMaskMaker" (C++ I3Module)

A module to create a FilterResultMap (aka FilterMask) based on I3Bools in the frame with configurable prescales.

Param FilterConfigs:

Default = <icecube._dataclasses.I3MapStringInt object at 0x10b4103c0>, I3MapStringInt of filter names and prescales

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

Default = 'FilterMask', Filter mask output name

Param RandomService:

Default = None, RandomService to use with prescale calculation

I3IceForkModule_FilterMaskFilter

"I3IceForkModule<FilterMaskFilter>" (C++ I3Module)

<undocumented>

Param CacheResults:

Default = False, For each frame evaluated, write the result to the frame, and check to see if that result exists before evaluating again.

Param DecisionName:

Default = 'FilterMaskFilter', Name of the filter decision in the Frame

Param FilterNameList:

Default = [], Pass Frames where at least one of these filters is true

Param FilterResultName:

Default = 'FilterMask', Name of I3FilterResultMap object in frame

I3IcePickModule_FilterMaskFilter

"I3IcePickModule<FilterMaskFilter>" (C++ I3Module)

<undocumented>

Param CacheResults:

Default = False, For each frame evaluated, write the result to the frame, and check to see if that result exists before evaluating again.

Param DecisionName:

Default = 'FilterMaskFilter', Name of the filter decision in the Frame

Param DiscardEvents:

Default = False, Set to ‘true’ if we’re supposed to actually discard events

Param FilterNameList:

Default = [], Pass Frames where at least one of these filters is true

Param FilterResultName:

Default = 'FilterMask', Name of I3FilterResultMap object in 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 InvertFrameOutput:

Default = False, Set to ‘true’ if you want the I3Bool that is written to the frame to be ‘true’ when the event fails the IcePick and ‘false’ when the event passes the IcePick (as in the old reverse-Pretzian logic). This ONLY affects the frame object output.

Param NEventsToPick:

Default = -1, Number of events to pick. If set to a value other than -1,IceTray will stop processing once after this manyselected events by requesting suspension

Param Streams:

Default = [icetray.I3Frame.Physics], Frame stops on which to operate. All other stop types are ignored.

KeepFromSubstream

"KeepFromSubstream" (C++ I3Module)

<undocumented>

Param If:

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

Param KeepKeys:

Default = [], List of key names to keep

Param KeepStream:

Default = False, Boolean, keep the substream P-frames?

Param StreamName:

Default = '', Name of the subevent stream

OrPframeFilterMasks

"OrPframeFilterMasks" (C++ I3Module)

<undocumented>

Param If:

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

Param InputName:

Default = 'FilterMask', Name of I3FilterResultMap object to collect in the p-frames

Param OutputName:

Default = 'QFilterMask', Name to give the I3FilterResultMap object in the frame

ParticleCheck

"ParticleCheck" (C++ I3Module)

<undocumented>

Param ParticleNames:

Default = ['CascadeLinefit', 'IcLinefit', 'MoonFit', 'ToI'], Names of the I3Particles to check

Param ParticlePrefix:

Default = 'Pole', Prefix on the I3Particles that will be checked against

Python I3Modules

FilterMaskMaker

FilterMaskMaker (Python I3Module)

A module to generate a FilterMask (stored at OutputMask parameter name) based on an input list of Filter names (expected as I3Bools in frame) and prescales (as input FilterConfigs list, expected as a list)

Param FilterConfigs:

Default = None, Dictionart of filter names and prescales

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

Default = 'FilterMask', Filter mask output name

Param RandomService:

Default = None, RandomService to use with prescale calculation

C++ ServiceFactorys

I3IcePickInstaller_FilterMaskFilter

"I3IcePickInstaller<FilterMaskFilter>" (C++ ServiceFactory)

<undocumented>

Param CacheResults:

Default = False, For each frame evaluated, write the result to the frame, and check to see if that result exists before evaluating again.

Param FilterNameList:

Default = [], Pass Frames where at least one of these filters is true

Param FilterResultName:

Default = 'FilterMask', Name of I3FilterResultMap object in frame

Param ServiceName:

Default = '', Name that the service will have in the context.This is typically redundant… by default, it uses The name of the installer

I3Tray segments

AnalysisClientRehydrate

AnalysisClientRehydrate (I3Tray segment)

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

Param dbhost:

Default = 'dbs',

Param dbuser:

Default = 'i3omdbro',

Param doInIceSplit:

Default = True,

Param doIceTopSplit:

Default = True,

Param doNullSplit:

Default = True,

PnfResplitter

PnfResplitter (I3Tray segment)

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

Param doInIceSplit:

Default = True,

Param doNullSplit:

Default = True,

Param doIceTopSplit:

Default = True,