Project ddddr
-------------

Invoke with: ``import icecube.ddddr``

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

.. js:data:: I3MuonEnergy

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

    This module estimates and fits the energy loss along a given track.

    :param BadDomListName: *Default* = ``'BadDomsList'``,
        Name of the BadDomList frame object. Default is "BadDomList".

    :param BinWidth: *Default* = ``50.0``,
        Bin width of the slant depth for the binned dEdX fit.

    :param FixB: *Default* = ``True``,
        fix free parameter b in tomF's function

    :param FixGamma: *Default* = ``True``,
        fix free parameter gamma in tomF's function

    :param I3MCTree: *Default* = ``''``,
        I3MCTree to use in case Monte Carlo track is used for the reconstruction.

    :param IceModelFileName: *Default* = ``'/Users/buildbot/actions-runner/_work/icetray/icetray/ddddr/resources/tables/implied.txt'``,
        name of the ice model file name

    :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* = ``'TWOfflinePulseSeriesReco'``,
        name of the input data

    :param LevelDist: *Default* = ``19.0``,
        For distances smaller than LevelDist, the light yield at the DOMs is assumed to
        scale linearly with the distance to the track.

    :param MaxImpact: *Default* = ``100.0``,
        Max. closest distance of a DOM to the muon track to be considered for the
        reconstruction

    :param MaxIterations: *Default* = ``500``,
        Maximum number of iterations for the fit.

    :param Method: *Default* = ``0``,
        -1: no fit, 0: expo; 1: tomF

    :param MMCTrackList: *Default* = ``''``,
        MMCTrackList to use in case Monte Carlo track is used for the reconstruction

    :param Prefix: *Default* = ``''``,
        Prefix for objects that are stored in the frame

    :param PurityAdjust: *Default* = ``0.0``,
        Scales the atten. length with a linear function of the depth, pos. values
        decrease the atten. length. Default is 0. (leaves atten. length unchanged).

    :param SaveDomResults: *Default* = ``False``,
        If true, saves impact, slant depth and dEdX for each DOM to frame

    :param Seed: *Default* = ``''``,
        Name of the seed track

    :param SlantBinNumber: *Default* = ``20``,
        Number of bins for slant depth. Only used together with Monte Carlo.

    :param Tolerance: *Default* = ``1e-05``,
        Tolerance to pass to the minimizer

    :param UseMonteCarloTrack: *Default* = ``False``,
        Use Monte Carlo track instead of reconstructed track for the energy loss reco.


.. js:data:: I3TrueMuonEnergy

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

    This module calculates the total energy of a muon bundle by summing up the
    contribution of each muon for each bin along the track of the whole bundle.

    :param BinWidth: *Default* = ``50.0``,
        the bin size of slant depth

    :param EnergyLoss: *Default* = ``True``,
        true for fit energy loss; false for energy

    :param I3MCTree: *Default* = ``'I3MCTree'``,
        name of the I3MCTree

    :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 MaxRadius: *Default* = ``800.0``,
        Max. radius of the cylindric simulation volume used by MMC/Proposal.

    :param MMCTrackList: *Default* = ``'MMCTrackList'``,
        name of the mmc track list

    :param Prefix: *Default* = ``'I3TrueMuonEnergy'``,
        prefix for energy (loss) information stored in the frame

    :param SaveEnergyLosses: *Default* = ``False``,
        If true, save the binned energy losses along the muon bundle to the frame.

    :param SlantBinNo: *Default* = ``200``,
        the bin number of slant depth


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

.. js:data:: TrueAndRecoMuonEnergy

    ``TrueAndRecoMuonEnergy`` *(I3Tray segment)*

    This segment uses the I3TrueMuonEnergy module and the I3MuonEnergy module to compare
    the true and the reconstructed energy loss along the true Monte Carlo track.

    :param BinWidth: *Default* = ``50``,
    :param I3MCTree: *Default* = ``'I3MCTree'``,
    :param MMCTrackList: *Default* = ``'MMCTrackList'``,
    :param InputPulses: *Default* = ``'TWOfflinePulsesHLC'``,
    :param MaxImpact: *Default* = ``100``,
    :param Prefix: *Default* = ``'I3MuonEnergy'``,
    :param SaveDomResults: *Default* = ``False``,

TableIO converters
^^^^^^^^^^^^^^^^^^

.. js:data:: I3MuonEnergyParamsConverter

    ``icecube.ddddr.I3MuonEnergyParamsConverter`` *(TableIO converter)*

    *<undocumented>*


.. js:data:: I3MuonEnergyCascadeParamsConverter

    ``icecube.ddddr.I3MuonEnergyCascadeParamsConverter`` *(TableIO converter)*

    *<undocumented>*