Project hdfwriter
-----------------

Invoke with: ``import icecube.hdfwriter``

I3Tray segments
^^^^^^^^^^^^^^^

.. js:data:: I3HDFWriter

    ``I3HDFWriter`` *(I3Tray segment)*

    Tabulate data to an HDF5 file.

    :param Output: *Default* = ``None``,
        Path to output file

    :param CompressionLevel: *Default* = ``6``,
        gzip compression to apply to each table

    :param BookEverything: *Default* = ``False``,
        Book absolutely everything in the frame, using the default converters. This has
        the tendency to produce very, very large files, and is almost certainly not what
        you actually want to do.

    :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 Keys: *Default* = ``None``,
        A list or dict of FrameObject keys to convert

    :param SubEventStreams: *Default* = ``['']``,
        The names of the SubEvent streams to be booked

    :param Types: *Default* = ``None``,
        A list or dict of types to convert


.. js:data:: I3SimHDFWriter

    ``I3SimHDFWriter`` *(I3Tray segment)*

    Tabulate untriggered data (Q frames only, no event headers)

    :param RunNumber: *Default* = ``0``,
        run ID to use in made-up headers. This should be unique in each file.

    :param Output: *Default* = ``None``,
        Path to output file

    :param CompressionLevel: *Default* = ``6``,
        gzip compression to apply to each table

    :param BookEverything: *Default* = ``False``,
        Book absolutely everything in the frame, using the default converters. This has
        the tendency to produce very, very large files, and is almost certainly not what
        you actually want to do.

    :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 Keys: *Default* = ``None``,
        A list or dict of FrameObject keys to convert

    :param SubEventStreams: *Default* = ``['']``,
        The names of the SubEvent streams to be booked

    :param Types: *Default* = ``None``,
        A list or dict of types to convert