Project frame_object_diff

Invoke with: import icecube.frame_object_diff

Python I3Modules

CalibrationCompressor

CalibrationCompressor (Python I3Module)

Param base_filename:

Base filename to compress against :param base_frame:

(optional) Frame from base filename to compress against Can be an actual frame object, or a callable that returns a frame object. :param inline_compression: (optional) Enable/disable inline compression (default enabled) :param frame_callback: (optional) Callback to receive compressed frames :param If: (optional) Callable to decide whether to run on the frame.

Param base_filename:

Default = None, Base filename to compress against

Param base_frame:

Default = None, Frame from base filename to compress against

Param frame_callback:

Default = None, Callback to receive compressed frames

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

Default = True, Enable/disable inline compression (default enabled)

CalibrationUncompressor

CalibrationUncompressor (Python I3Module)

Param base_frame:

(optional) Frame from base filename to uncompress against.

Can be an actual frame object, or a callable that returns a frame object. :param keep_compressed: (optional) Enable/disable keeping compressed objects in frame (default disabled) :param frame_callback: (optional) Callback to receive uncompressed frames instead of writing them in the frame stream. :param If: (optional) Callable to decide whether to run on the frame.

Param base_frame:

Default = None, Frame from base filename to uncompress against

Param frame_callback:

Default = None, Callback to receive uncompressed frames

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

Default = True, Enable/disable keeping compressed objects in frame (default disabled)

DetectorStatusCompressor

DetectorStatusCompressor (Python I3Module)

Param base_filename:

Base filename to compress against :param base_frame:

(optional) Frame from base filename to compress against Can be an actual frame object, or a callable that returns a frame object. :param inline_compression: (optional) Enable/disable inline compression (default enabled) :param frame_callback: (optional) Callback to receive compressed frames :param If: (optional) Callable to decide whether to run on the frame.

Param base_filename:

Default = None, Base filename to compress against

Param base_frame:

Default = None, Frame from base filename to compress against

Param frame_callback:

Default = None, Callback to receive compressed frames

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

Default = True, Enable/disable inline compression (default enabled)

DetectorStatusUncompressor

DetectorStatusUncompressor (Python I3Module)

Param base_frame:

(optional) Frame from base filename to uncompress against.

Can be an actual frame object, or a callable that returns a frame object. :param keep_compressed: (optional) Enable/disable keeping compressed objects in frame (default disabled) :param frame_callback: (optional) Callback to receive uncompressed frames instead of writing them in the frame stream. :param If: (optional) Callable to decide whether to run on the frame.

Param base_frame:

Default = None, Frame from base filename to uncompress against

Param frame_callback:

Default = None, Callback to receive uncompressed frames

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

Default = True, Enable/disable keeping compressed objects in frame (default disabled)

GeometryCompressor

GeometryCompressor (Python I3Module)

Param base_filename:

Base filename to compress against :param base_frame:

(optional) Frame from base filename to compress against Can be an actual frame object, or a callable that returns a frame object. :param inline_compression: (optional) Enable/disable inline compression (default enabled) :param frame_callback: (optional) Callback to receive compressed frames :param If: (optional) Callable to decide whether to run on the frame.

Param base_filename:

Default = None, Base filename to compress against

Param base_frame:

Default = None, Frame from base filename to compress against

Param frame_callback:

Default = None, Callback to receive compressed frames

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

Default = True, Enable/disable inline compression (default enabled)

GeometryUncompressor

GeometryUncompressor (Python I3Module)

Param base_frame:

(optional) Frame from base filename to uncompress against.

Can be an actual frame object, or a callable that returns a frame object. :param keep_compressed: (optional) Enable/disable keeping compressed objects in frame (default disabled) :param frame_callback: (optional) Callback to receive uncompressed frames instead of writing them in the frame stream. :param If: (optional) Callable to decide whether to run on the frame.

Param base_frame:

Default = None, Frame from base filename to uncompress against

Param frame_callback:

Default = None, Callback to receive uncompressed frames

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

Default = True, Enable/disable keeping compressed objects in frame (default disabled)

I3Tray segments

compress

compress (I3Tray segment)

A general compressor for GCD frames.

Param base_filename:

Default = None, The base GCD filename.

Param base_path:

Default = '', (optional) Will be used as a path to base_filename but not stored in the diff objects.

Param base_frames:

Default = {}, (optional) Pre-existing copy of GCD frames in a dictionary.

Param inline_compression:

Default = True, (optional) Directly modify the frame stream (default True).

Param frame_callback:

Default = None, (optional) Function callback which receives the compressed frames.

Param If:

Default = <function <lambda> at 0x105229a80>, (optional) Callable to decide whether to run on the frame.

inline_compress

inline_compress (I3Tray segment)

An inline compressor for GCD frames in the same file.

Param If:

Default = <function <lambda> at 0x1067bf9c0>, (optional) Callable to decide whether to run on the frame.

inline_uncompress

inline_uncompress (I3Tray segment)

An inline uncompressor for GCD frames. The reverse of inline_compress.

Param If:

Default = <function <lambda> at 0x1067bfc40>, (optional) Callable to decide whether to run on the frame.

uncompress

uncompress (I3Tray segment)

A general uncompressor for GCD frames. The reverse of compress.

Param base_filename:

Default = None, (optional) The base GCD filename (default to stored filename).

Param base_path:

Default = '', (optional) Will be used as a path to the input filename if set.

Param base_frames:

Default = {}, (optional) Pre-existing copy of GCD frames in a dictionary.

Param keep_compressed:

Default = False, (optional) Keep the compressed objects (default False).

Param frame_callback:

Default = None, (optional) Function callback which receives the uncompressed frames.

Param If:

Default = <function <lambda> at 0x1067bfa60>, (optional) Callable to decide whether to run on the frame.