Project wavereform

Invoke with: import icecube.wavereform

C++ I3Modules

I3LaunchSelector

"I3LaunchSelector" (C++ I3Module)

<undocumented>

Param Flags:

Default = [], List of vector<OMKey>s in the frame. Any OMKey that appears in one of these lists will be copied to the output map.

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

Default = False, Invert the selection: any key that does not appear in Flags will be copied to the output map

Param Launches:

Default = 'InIceRawData', Name of DOMLaunch map in the frame.

Param Output:

Default = 'InIceRawDataErrata', Name of DOMLaunch map to put in the frame. The list of keys is also written to the frame as output+’Keys’, e.g. InIceRawDataErrataKeys

I3Wavereform

"I3Wavereform" (C++ I3Module)

<undocumented>

Param Chi:

Default = 'ATWDChi_RecoPulses', Where to store the chi^2 between waveform and pulses

Param ChiThreshold:

Default = 2000.0, Flag any OM with a waveform/pulse chi^2 greater than this.

Param Flag:

Default = '', Where to store the list of bad OMs

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

Default = 'RecoPulses', Name of the pulse series in the frame

Param UseDOMsimulatorTemplates:

Default = False, Use pulse shapes from DOMsimulator, rather than those from reality.

Param Waveforms:

Default = 'CalibratedATWD', Name of calibrated waveforms in the frame

Python I3Modules

DOMFlagger

DOMFlagger (Python I3Module)

<undocumented>

Param Condition:

Default = <function DOMFlagger.__init__.<locals>.<lambda> at 0x102f53b00>, Function that returns True if a series of DOMLaunches/Waveforms/Pulses should be transmitted in raw form, False otherwise

Param Flag:

Default = None, Name of the flag vector to put in the 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 Key:

Default = None, Name of the DOMLaunches/Waveforms/Pulses in the frame

ShowPlots

ShowPlots (Python I3Module)

Show plots generated by previous instances of WaveformPlotter with Block=False.

Param DisplayPlots:

Default = False, Whether or not to display plots on screen

Param OutFilename:

Default = 'test.png', Filename to use for the plot if saving as png

Param SavePlots:

Default = True, Whether or not to save plots to png files

WaveformPlotter

WaveformPlotter (Python I3Module)

<undocumented>

Param Block:

Default = True, Stop to display plots at every frame

Param Errata:

Default = [], Time windows in which calibration should be considered fishy

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

Default = None, Name of DOMLaunches in the frame

Param Pulses:

Default = 'WavedeformPulses', Name of pulses in the frame

Param ShowChiSquared:

Default = True,

Param UseDOMsimulatorTemplates:

Default = False, Use pulse shapes from simulation

Param Waveforms:

Default = 'CalibratedWaveforms', Name of calibrated waveforms in the frame