Project online_filterscripts
----------------------------

Invoke with: ``import icecube.online_filterscripts``

Python I3Modules
^^^^^^^^^^^^^^^^

.. js:data:: I3HistogramLLH

    ``I3HistogramLLH`` *(Python I3Module)*

    Use a precalcuated S/B-likelihood histogram to calculate the likelihood ratio.

    :param HistFile: *Default* = ``''``,
        Filename containing the histograms

    :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 OutputName: *Default* = ``''``,
        Where to store the result

    :param VarNames: *Default* = ``[]``,
        Name of the object(s) with x/y/z values


.. js:data:: I3TimeResidualBooker

    ``I3TimeResidualBooker`` *(Python I3Module)*

    A module to store the time residuals of a pulsemap with respect to a given fit.

    :param Geometry: *Default* = ``'I3Geometry'``,
        Name of geometry to use

    :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 MaxDist: *Default* = ``200.0``,
        Maximal Distance of OM to track

    :param Particle: *Default* = ``'OnlineL2_SplineMPE'``,
        Particle to calculate Time Residuals for

    :param Pulsemap: *Default* = ``'CleanedMuonPulsesIC'``,
        Pulsemap to use for time residual calculation

    :param TimeWindow: *Default* = ``[-500.0, 500.0]``,
        Time Window for residuals


.. js:data:: I3Vectorize

    ``I3Vectorize`` *(Python I3Module)*

    Extend a given frame object to match the length of another vector-like object.

    :param Func: *Default* = ``<function I3Vectorize.__init__.<locals>.<lambda> at 0x104bbba60>``,
        Optional function to apply on input values

    :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 Input: *Default* = ``''``,
        Name of the input object

    :param Output: *Default* = ``''``,
        Name of the output object

    :param Vector: *Default* = ``''``,
        Corresponding vector object to match length


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

.. js:data:: base_processing

    ``base_processing`` *(I3Tray segment)*

    base_processing - tray segment for base processin.


.. js:data:: online_basic_recos

    ``online_basic_recos`` *(I3Tray segment)*

    Apply some standard pulse cleaning and recostructions.

    :param If: *Default* = ``<icecube.icetray.pypick.pypick object at 0x108a3bfe0>``,

.. js:data:: online_dst

    ``online_dst`` *(I3Tray segment)*

    DST creation- Create I3DST22 and I3DSTHeader (1/1000 frames) objects.

    :param If: *Default* = ``<icecube.icetray.pypick.pypick object at 0x108a582c0>``,

.. js:data:: CalcHeseLLHratio

    ``CalcHeseLLHratio`` *(I3Tray segment)*

    Calculate the LLH ratio for HESE filter.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param If: *Default* = ``<function <lambda> at 0x1352ddf80>``,

.. js:data:: HESE_filter

    ``HESE_filter`` *(I3Tray segment)*

    Traysegment for online HESE filter.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param If: *Default* = ``<function <lambda> at 0x1352de0c0>``,

.. js:data:: HeseCalcChargeVeto

    ``HeseCalcChargeVeto`` *(I3Tray segment)*

    Calculate the Homegenized Qtot, and veto calculations used by HESE.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param If: *Default* = ``<function <lambda> at 0x1352dde40>``,

.. js:data:: L2Reco

    ``L2Reco`` *(I3Tray segment)*

    Perform recos for OnlineL2 selection.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param llhfit_name: *Default* = ``''``,
    :param linefit_name: *Default* = ``''``,
    :param If: *Default* = ``<function <lambda> at 0x1352dea20>``,

.. js:data:: NewL2AdvancedReco

    ``NewL2AdvancedReco`` *(I3Tray segment)*

    Run recos to run on events that pass the OnlineL2 filter.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param splinereco_amplitude_table: *Default* = ``None``,
    :param splinereco_timing_table: *Default* = ``None``,
    :param path_to_cramerrao_table: *Default* = ``None``,
    :param If: *Default* = ``<function <lambda> at 0x1352deb60>``,

.. js:data:: online_l2_filter

    ``online_l2_filter`` *(I3Tray segment)*

    Make OnlineL2 selection.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param If: *Default* = ``<function <lambda> at 0x1352deca0>``,

.. js:data:: CompressGCD

    ``CompressGCD`` *(I3Tray segment)*

    Use frame_object_diff to generate compressed versions of the GCD objects.

    :param base_GCD_path: *Default* = ``None``,
    :param base_GCD_filename: *Default* = ``None``,

.. js:data:: alert_event_extractor

    ``alert_event_extractor`` *(I3Tray segment)*

    Extract alert info object.


.. js:data:: GFUAngErrReco

    ``GFUAngErrReco`` *(I3Tray segment)*

    Find angular error for events that pass GFU filter.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param L2name: *Default* = ``''``,
    :param If: *Default* = ``<function <lambda> at 0x1352dd940>``,

.. js:data:: GFUGetBDTScore

    ``GFUGetBDTScore`` *(I3Tray segment)*

    Generate BDT score and add it to frame for events.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param bdt_up_file: *Default* = ``None``,
    :param bdt_down_file: *Default* = ``None``,
    :param L2name: *Default* = ``''``,
    :param If: *Default* = ``<function <lambda> at 0x108a49940>``,

.. js:data:: online_gfu_filter

    ``online_gfu_filter`` *(I3Tray segment)*

    Add pieces of GFU filter to the tray.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param l2name: *Default* = ``'l2_online'``,
    :param If: *Default* = ``<function <lambda> at 0x1352dda80>``,

.. js:data:: MuonReco

    ``MuonReco`` *(I3Tray segment)*

    Reco for Muon Filter - Runs hit multiplicity and statistics for cut variables.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param If: *Default* = ``<function <lambda> at 0x1352de200>``,

.. js:data:: online_muon_filter

    ``online_muon_filter`` *(I3Tray segment)*

    Create the MuonFilter_23.

    :param pulses: *Default* = ``'CleanedInIcePulses'``,
    :param If: *Default* = ``<function <lambda> at 0x1352de340>``,

.. js:data:: online_software_smt_retrigger

    ``online_software_smt_retrigger`` *(I3Tray segment)*

    Define a segment to check for each In-Ice split P-Frame.

    :param If: *Default* = ``<icecube.icetray.pypick.pypick object at 0x1352d3d10>``,

.. js:data:: pole_base_package_output

    ``pole_base_package_output`` *(I3Tray segment)*

    Define Tray segment:  pole_base_package_output.


.. js:data:: pole_base_processing_and_filter

    ``pole_base_processing_and_filter`` *(I3Tray segment)*

    Tray segment to drive data event processing at Pole.