Project TopologicalSplitter
---------------------------

Invoke with: ``import icecube.TopologicalSplitter``

C++ I3Modules
^^^^^^^^^^^^^

.. js:data:: I3TopologicalSplitter

    ``"I3TopologicalSplitter"`` *(C++ I3Module)*

    The main splitter module.

    :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 InputName: *Default* = ``''``,
        Name of the pulses to split

    :param Multiplicity: *Default* = ``4``,
        Required number of connected hits to form a subevent

    :param OutputName: *Default* = ``''``,
        Name of the pulses to put in the split frames

    :param SaveSplitCount: *Default* = ``False``,
        Whether to save an integer in the frame indicating the number of subevents
        generated

    :param SubEventStreamName: *Default* = ``''``,
        The name of the SubEvent stream.

    :param TimeCone: *Default* = ``1000.0``,
        Maximum deviation from speed of light travel time which will allow a pair of
        hits to be considered connected

    :param TimeWindow: *Default* = ``4000.0``,
        Time span within which the multiplicity requirement must be met

    :param XYDist: *Default* = ``500.0``,
        Maximum horizontal distance within which hits will be considered connected

    :param ZDomDist: *Default* = ``30``,
        Maximum vertical distance within which hits on the same string will be
        considered connected, expressed as a number of DOM spacings (unitless)


.. js:data:: TTriggerSplitter

    ``"TTriggerSplitter"`` *(C++ I3Module)*

    A module with the same interface as the TTriggerSplitter module provided by the
    ttrigger project.

    :param CBWindow: *Default* = ``0.0``,
        DEPRECATED

    :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 InputName: *Default* = ``''``,
        Name of the pulses to split

    :param LCSpan: *Default* = ``-1``,
        DEPRECATED

    :param LCWindow: *Default* = ``0.0``,
        DEPRECATED

    :param Multiplicity: *Default* = ``4``,
        Required number of connected hits to form a subevent

    :param OutputName: *Default* = ``''``,
        Name of the pulses to put in the split frames

    :param SaveSplitCount: *Default* = ``False``,
        Whether to save an integer in the frame indicating the number of subevents
        generated

    :param SubEventStreamName: *Default* = ``''``,
        The name of the SubEvent stream.

    :param TimeCone: *Default* = ``1000.0``,
        Maximum deviation from speed of light travel time which will allow a pair of
        hits to be considered connected

    :param TimeWindow: *Default* = ``4000.0``,
        Time span within which the multiplicity requirement must be met

    :param Topo: *Default* = ``1``,
        DEPRECATED

    :param XYDist: *Default* = ``500.0``,
        Maximum horizontal distance within which hits will be considered connected

    :param ZDomDist: *Default* = ``30``,
        Maximum vertical distance within which hits on the same string will be
        considered connected, expressed as a number of DOM spacings (unitless)


.. js:data:: ttrigger_I3RecoPulse

    ``"ttrigger<I3RecoPulse>"`` *(C++ I3Module)*

    *<undocumented>*

    :param CBWindow: *Default* = ``0.0``,
        DEPRECATED

    :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 InputName: *Default* = ``''``,
        Name of the pulses to split

    :param InputNames: *Default* = ``[]``,
        DEPRECATED

    :param LCSpan: *Default* = ``-1``,
        DEPRECATED

    :param LCWindow: *Default* = ``0.0``,
        DEPRECATED

    :param Multiplicity: *Default* = ``4``,
        Required number of connected hits to form a subevent

    :param OutputName: *Default* = ``''``,
        Name of the pulses to put in the split frames

    :param SaveSplitCount: *Default* = ``False``,
        Whether to save an integer in the frame indicating the number of subevents
        generated

    :param SubEventStreamName: *Default* = ``''``,
        The name of the SubEvent stream.

    :param TimeCone: *Default* = ``1000.0``,
        Maximum deviation from speed of light travel time which will allow a pair of
        hits to be considered connected

    :param TimeWindow: *Default* = ``4000.0``,
        Time span within which the multiplicity requirement must be met

    :param Topo: *Default* = ``1``,
        DEPRECATED

    :param XYDist: *Default* = ``500.0``,
        Maximum horizontal distance within which hits will be considered connected

    :param ZDomDist: *Default* = ``30``,
        Maximum vertical distance within which hits on the same string will be
        considered connected, expressed as a number of DOM spacings (unitless)