Project frame_object_diff ------------------------- Invoke with: ``import icecube.frame_object_diff`` Python I3Modules ^^^^^^^^^^^^^^^^ .. js:data:: 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) .. js:data:: 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) .. js:data:: 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) .. js:data:: 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) .. js:data:: 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) .. js:data:: 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 ^^^^^^^^^^^^^^^ .. js:data:: 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* = `` at 0x1032dda80>``, (optional) Callable to decide whether to run on the frame. .. js:data:: inline_compress ``inline_compress`` *(I3Tray segment)* An inline compressor for GCD frames in the same file. :param If: *Default* = `` at 0x10481b9c0>``, (optional) Callable to decide whether to run on the frame. .. js:data:: inline_uncompress ``inline_uncompress`` *(I3Tray segment)* An inline uncompressor for GCD frames. The reverse of inline_compress. :param If: *Default* = `` at 0x10481bc40>``, (optional) Callable to decide whether to run on the frame. .. js:data:: 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* = `` at 0x10481ba60>``, (optional) Callable to decide whether to run on the frame.