Project vemcal
--------------

Invoke with: ``import icecube.vemcal``

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

.. js:data:: I3HGLGPairSelector

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

    *<undocumented>*

    :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 InputPulses: *Default* = ``'IceTopVEMPulses'``,
        Name of input I3RecoPulseSeriesMap

    :param OutputPulseMask: *Default* = ``'IceTopHGLGData'``,
        Name of output I3RecoPulseSeriesMapMask which contains only HG-LG pairs.


.. js:data:: I3ITSLCCalExtractor

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

    This module extracts all the information which is needed to perform the SLC
    calibration and writes the data in a condensed format to the frame.

    :param IcePickServiceKey: *Default* = ``''``,
        Key for an IcePick in the context that this module should check before
        processing physics frames.

    :param IceTopDowngradedPulses: *Default* = ``'IceTopHLCasSLCPulses_forSLCcal'``,
        Name of downgraded IceTop HLC->SLC pulses in frame.

    :param IceTopRegularHLCPulses: *Default* = ``'IceTopHLCVEMPulses'``,
        Name of IceTop HLC pulses in frame.

    :param IceTopWaveforms: *Default* = ``'OfflineCalibratedIceTopATWD_SLC_2'``,
        Name of IceTop Waveforms (for harvesting chip/atwd) in frame.

    :param If: *Default* = ``None``,
        A python function... if this returns something that evaluates to True, Module
        runs, else it doesn't

    :param SLCCalData: *Default* = ``'I3ITSLCCalData'``,
        Name of the SLCCal data container in which the data is written to the frame


.. js:data:: I3VEMCalExtractor

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

    This module extracts all the information which is needed to perform the muon
    calibration and writes the data in a condensed format to the frame.

    :param IcePickServiceKey: *Default* = ``''``,
        Key for an IcePick in the context that this module should check before
        processing physics frames.

    :param IceTopMinBiasPulseInfoName: *Default* = ``'IceTopMinBiasPulseInfo'``,
        Name of the IceTop pulse info series connected with IceTopMinBiasPulses.

    :param IceTopMinBiasPulsesName: *Default* = ``'IceTopMinBiasPulses'``,
        Name of IceTop MinBias pulses in frame.

    :param IceTopPulseInfoName: *Default* = ``'IceTopPulseInfo'``,
        Name of the IceTop pulse info series connected with IceTopPulses.

    :param IceTopPulsesName: *Default* = ``'IceTopPulses'``,
        Name of normal IceTop physics pulses in frame.

    :param If: *Default* = ``None``,
        A python function... if this returns something that evaluates to True, Module
        runs, else it doesn't

    :param ShowerVeto: *Default* = ``''``,
        Name of IceTop raw data in frame. If specified it will be used as an air shower
        veto

    :param VEMCalDataName: *Default* = ``'I3VEMCalData'``,
        Name of the VEMCal data container in which the data is written to the frame


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

.. js:data:: SLCCalibRunFitter

    ``SLCCalibRunFitter`` *(Python I3Module)*

    This module collects charges from the I3ITSLCCalData frame object and fits a
    straight line to them by analytically minimizing a least squares function. This is
    done for each DOM and each ATWD. It stores the results in a JSON or HDF5 file.

    :param ITSLCCalData: *Default* = ``'I3ITSLCCalData'``,
        Where to find the lightweight stored data in the frame

    :param NPointsThresh: *Default* = ``3``,
        Number of points threshold to write output

    :param OutputDirectory: *Default* = ``'.'``,
        Directory (a temporary space) to put the .h5/.json output and any other outputs

    :param OutputFilename: *Default* = ``''``,
        HDF or JSON filename where to store the result (Default = construct a JSON
        filename from run number)

    :param Streams: *Default* = ``icetray.I3Frame.DAQ``,
        Runs this on Q or P frames? (default = Q