Project DeepCore_Filter ----------------------- Invoke with: ``import icecube.DeepCore_Filter`` C++ I3Modules ^^^^^^^^^^^^^ .. js:data:: I3DeepCoreTimeVeto_I3DOMLaunch ``"I3DeepCoreTimeVeto"`` *(C++ I3Module)* ** :param ChargeWeightCoG: *Default* = ``False``, Weight the center of gravity (CoG) calculation by the charge on the DOMs. :param DecisionName: *Default* = ``'Veto'``, Name of the veto decision bool which is output to the frame. :param FirstHitOnly: *Default* = ``True``, Use only the first hit on each DOM instead of looping over all hits. Leave as default to recreate old DeepCoreVeto behaviour :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 InputFiducialHitSeries: *Default* = ``''``, Name of Hit Series to be used for fiducial (DeepCore) hits. Include information for those DOMs inside the Deepcore volume :param InputVetoHitSeries: *Default* = ``''``, Name of Hit Series to be used for veto hits. Include information for those DOMs outside of Deepcore :param ParticleName: *Default* = ``''``, Name of the I3Particle containing the CoG, time used for the veto. If blank, will not add particle to frame. DeepCore will append _dc, IceCube will append _ic :param TimeThreshold: *Default* = ``500.0``, How much earlier(in ns) the IceCube vertex time is allowed to be than the DeepCore. Default to 500 ns. .. js:data:: I3DeepCoreTimeVeto_I3RecoPulse ``"I3DeepCoreTimeVeto"`` *(C++ I3Module)* ** :param ChargeWeightCoG: *Default* = ``False``, Weight the center of gravity (CoG) calculation by the charge on the DOMs. :param DecisionName: *Default* = ``'Veto'``, Name of the veto decision bool which is output to the frame. :param FirstHitOnly: *Default* = ``True``, Use only the first hit on each DOM instead of looping over all hits. Leave as default to recreate old DeepCoreVeto behaviour :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 InputFiducialHitSeries: *Default* = ``''``, Name of Hit Series to be used for fiducial (DeepCore) hits. Include information for those DOMs inside the Deepcore volume :param InputVetoHitSeries: *Default* = ``''``, Name of Hit Series to be used for veto hits. Include information for those DOMs outside of Deepcore :param ParticleName: *Default* = ``''``, Name of the I3Particle containing the CoG, time used for the veto. If blank, will not add particle to frame. DeepCore will append _dc, IceCube will append _ic :param TimeThreshold: *Default* = ``500.0``, How much earlier(in ns) the IceCube vertex time is allowed to be than the DeepCore. Default to 500 ns. .. js:data:: I3DeepCoreVeto_I3DOMLaunch ``"I3DeepCoreVeto"`` *(C++ I3Module)* ** :param ChargeWeightCoG: *Default* = ``False``, Weight the center of gravity (CoG) calculation by the charge on the DOMs. :param DecisionName: *Default* = ``'DeepCoreVeto'``, Name of the veto decision bool which is output to the frame. :param FirstHitOnly: *Default* = ``True``, Use only the first hit on each DOM instead of looping over all hits. Leave as default to recreate old DeepCoreVeto behaviour :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 InputFiducialHitSeries: *Default* = ``''``, Name of Hit Series to be used for fiducial (DeepCore) hits. Include information for those DOMs inside the Deepcore volume :param InputVetoHitSeries: *Default* = ``''``, Name of Hit Series to be used for veto hits. Include information for those DOMs outside of Deepcore :param MinHitsToVeto: *Default* = ``1``, Number of acceptable hits within the veto time window. (Strictly) Greater than this will be vetoed :param ParticleName: *Default* = ``''``, Name of the I3Particle containing the CoG, time used for the veto. If blank, will not add particle to frame :param VetoChargeName: *Default* = ``''``, Name of variable to put in the frame which stores the number of PE satisfying the DeepCore Filter. :param VetoHitsName: *Default* = ``''``, Name of variable to put in the frame which stores the number of hits satisfying the DeepCore Filter. .. js:data:: I3DeepCoreVeto_I3RecoPulse ``"I3DeepCoreVeto"`` *(C++ I3Module)* ** :param ChargeWeightCoG: *Default* = ``False``, Weight the center of gravity (CoG) calculation by the charge on the DOMs. :param DecisionName: *Default* = ``'DeepCoreVeto'``, Name of the veto decision bool which is output to the frame. :param FirstHitOnly: *Default* = ``True``, Use only the first hit on each DOM instead of looping over all hits. Leave as default to recreate old DeepCoreVeto behaviour :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 InputFiducialHitSeries: *Default* = ``''``, Name of Hit Series to be used for fiducial (DeepCore) hits. Include information for those DOMs inside the Deepcore volume :param InputVetoHitSeries: *Default* = ``''``, Name of Hit Series to be used for veto hits. Include information for those DOMs outside of Deepcore :param MinHitsToVeto: *Default* = ``1``, Number of acceptable hits within the veto time window. (Strictly) Greater than this will be vetoed :param ParticleName: *Default* = ``''``, Name of the I3Particle containing the CoG, time used for the veto. If blank, will not add particle to frame :param VetoChargeName: *Default* = ``''``, Name of variable to put in the frame which stores the number of PE satisfying the DeepCore Filter. :param VetoHitsName: *Default* = ``''``, Name of variable to put in the frame which stores the number of hits satisfying the DeepCore Filter. I3Tray segments ^^^^^^^^^^^^^^^ .. js:data:: DeepCoreTimeVeto ``DeepCoreTimeVeto`` *(I3Tray segment)* I3Tray segments should have docstrings. This one doesn't. Fix it. :param pulses: *Default* = ``'InIcePulses'``, :param OutputName: *Default* = ``'DCTimeVeto'``, :param DetectorConfig: *Default* = ``'IC86EDC'``, :param If: *Default* = `` at 0x104937240>``, .. js:data:: RunFilter ``RunFilter`` *(I3Tray segment)* I3Tray segments should have docstrings. This one doesn't. Fix it. :param pulses: *Default* = ``'InIcePulses'``, :param OutputName: *Default* = ``'DCVeto'``, :param DetectorConfig: *Default* = ``'IC86EDC'``, :param If: *Default* = `` at 0x104934ae0>``,