Modules

Modules for compressing and uncompressing GCD frames.

icecube.frame_object_diff.modules.get_compressor(obj)

Return the compressor class for an object, if available. Raise an exception otherwise.

class icecube.frame_object_diff.modules.GeometryCompressor(context)

Parameters:

• base_filename – Base filename to compress against

• base_frame – (optional) Frame from base filename to compress against Can be an actual frame object, or a callable that returns a frame object.

• inline_compression – (optional) Enable/disable inline compression (default enabled)

• frame_callback – (optional) Callback to receive compressed frames

• If – (optional) Callable to decide whether to run on the frame.

If base_frame is not supplied, it is looked up from base_filename.

Either inline_compression or frame_callback can be enabled, not both.

class icecube.frame_object_diff.modules.CalibrationCompressor(context)

Parameters:

• base_filename – Base filename to compress against

• base_frame – (optional) Frame from base filename to compress against Can be an actual frame object, or a callable that returns a frame object.

• inline_compression – (optional) Enable/disable inline compression (default enabled)

• frame_callback – (optional) Callback to receive compressed frames

• If – (optional) Callable to decide whether to run on the frame.

If base_frame is not supplied, it is looked up from base_filename.

Either inline_compression or frame_callback can be enabled, not both.

class icecube.frame_object_diff.modules.DetectorStatusCompressor(context)

Parameters:

• base_filename – Base filename to compress against

• base_frame – (optional) Frame from base filename to compress against Can be an actual frame object, or a callable that returns a frame object.

• inline_compression – (optional) Enable/disable inline compression (default enabled)

• frame_callback – (optional) Callback to receive compressed frames

• If – (optional) Callable to decide whether to run on the frame.

If base_frame is not supplied, it is looked up from base_filename.

Either inline_compression or frame_callback can be enabled, not both.

class icecube.frame_object_diff.modules.GeometryUncompressor(context)

Parameters:

• base_frame – (optional) Frame from base filename to uncompress against. Can be an actual frame object, or a callable that returns a frame object.

• keep_compressed – (optional) Enable/disable keeping compressed objects in frame (default disabled)

• frame_callback – (optional) Callback to receive uncompressed frames instead of writing them in the frame stream.

• If – (optional) Callable to decide whether to run on the frame.

If base_frame is not supplied, it is looked up from base_filename.

class icecube.frame_object_diff.modules.CalibrationUncompressor(context)

Parameters:

• base_frame – (optional) Frame from base filename to uncompress against. Can be an actual frame object, or a callable that returns a frame object.

• keep_compressed – (optional) Enable/disable keeping compressed objects in frame (default disabled)

• frame_callback – (optional) Callback to receive uncompressed frames instead of writing them in the frame stream.

• If – (optional) Callable to decide whether to run on the frame.

If base_frame is not supplied, it is looked up from base_filename.

class icecube.frame_object_diff.modules.DetectorStatusUncompressor(context)

Parameters:

• base_frame – (optional) Frame from base filename to uncompress against. Can be an actual frame object, or a callable that returns a frame object.

• keep_compressed – (optional) Enable/disable keeping compressed objects in frame (default disabled)

• frame_callback – (optional) Callback to receive uncompressed frames instead of writing them in the frame stream.

• If – (optional) Callable to decide whether to run on the frame.

If base_frame is not supplied, it is looked up from base_filename.