Project full_event_followup

Invoke with: import icecube.full_event_followup

Python I3Modules

I3FullEventFollowupReader

I3FullEventFollowupReader (Python I3Module)

Acts as a driving module / reader. This module will use a callback function accepting a full frame packet (usually GCDQP). This is not meant for standard data processing as it circumvents the frame mix-in mechanism on purpose. It can be used to feed modules from data from the full-event followup (used for the HESE follow-up, for example). If the callback function returns None, processing will be stopped.

Param ReaderCallback:

Default = None, This callback is called without any parameters. It is expected to return a frame packet (vector of frames).

I3FullEventFollowupWriter

I3FullEventFollowupWriter (Python I3Module)

Sends a full frame packet (usually GCDQP) for each P-frame to a writer callback function provided to the module using the “WriterCallback” parameter. Use the “If” parameter to select P-frames to send and the “Keys” parameter to define a whitelist of the frame objects to include (all objects will be included if unset).

Param If:

Default = None, A python function receiving the frame (for P-frames). If this returns something that evaluates to True the frame gets processed.

Param Keys:

Default = None, List of frame key names to send (if not set keys will be sent

Param Streams:

Default = None, Select the streams/stops to work on. Works on all available frames if unset.

Param WriterCallback:

Default = None, This callback will receive a list of frames fully defining the P-frame (usually GCDQP). It will also received the original frame for reference (and in case the result needs to be stored in the original frame).