Project offline_filterscripts¶

Invoke with: import icecube.offline_filterscripts

Python I3Modules¶

CalculateGaps¶

CalculateGaps (Python I3Module)

Module to generate data gaps file for later use

Param EventHeaderName:: Default = 'I3EventHeader', Name of the Event Header
Param MinGapTime:: Default = 30, Minimum time (in seconds) between events to consider as a data gap
Param OutputFileName:: Default = '', Name of Output Gaps File

Positional¶

Positional (Python I3Module)

Check first hit position and time between first tWo HLC hits.

Param elowenbool:: Default = 'ELOWEN_Filter_positions', whether to keep or not
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

HoboTimeSplitter¶

HoboTimeSplitter (Python I3Module)

Split an event into halves on the charge-weighted mean time.

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 Output:: Default = '', Name of the mask in the output P frames
Param Pulses:: Default = '', Pulses to split

MarkQForHive¶

MarkQForHive (Python I3Module)

Mark q-frames to apply HiveSplitter.

Param If:: Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

HivePframeCut¶

HivePframeCut (Python I3Module)

Check if IceHive produced more than 1 p-frame and check if this overlaps with the FPT trigger window.

Param If:: Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

RemoveHiveP¶

RemoveHiveP (Python I3Module)

Remove IceHive p-frames that did not pass the filter.

Param If:: Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

CheckForTrigger¶

CheckForTrigger (Python I3Module)

Check for the presence of a particular Trigger, according to its configID.

Param ConfigID:: Default = 30002, ConfigID to look for
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 InputTriggerHierarchy:: Default = 'DSTTriggers', Name of input trigger hierarchy
Param Output:: Default = 'IceAct_TriggerPresent_Bool', Name of filter decision bool

ReevaluateTriggerOnIceTopSplit¶

ReevaluateTriggerOnIceTopSplit (Python I3Module)

IceTop 2-station Trigger 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 Input:: Default = 'CleanedHLCTankPulses', Name of input pulse series
Param InputTriggerHierarchy:: Default = 'DSTTriggers', Name of input trigger hierarchy
Param Output:: Default = 'IceTop_TwoStationFilter_Bool', Name of filter decision bool

TimeWindowCollector¶

TimeWindowCollector (Python I3Module)

A module to collect time windows from frames and write them to an I3TimeWindowSeries in the frame.

Param If:: Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t
Param TimeWindowName:: Default = <Unprintable>, Name of the time windows to collect
Param TimeWindowSeriesName:: Default = <Unprintable>, Name of the timewindow series to write

I3ShadowFilter¶

I3ShadowFilter (Python I3Module)

Filter to select events coming from a direction close to Moon or Sun.

Param azimuth_range:: Default = [-1.5707963267948966, 1.5707963267948966], Azimuth range for the ‘shadow window’, specified by two doubles that specify the minimum and maximum azimuth difference w.r.t. the Moon/Sun coordinates.
Param filter_name:: Default = 'I3ShadowFilter_24', Name of the filter
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 mc_MJD_name:: Default = 'CorsikaMoon', If fake event times are generated for corsika events, then the MJD and angular coordinates are stored in the frame. If several Moon filters are defined (e.g. one for conventional data and one for extended DST), then subsequent filters can reuse the generated times and and angles (instead of generating different ones) if the same name is configured for this option.
Param mc_MJD_range:: Default = <Unprintable>, For testing with simulation: give the MJD range (e.g. 01 January 10:00 - 08 January 21:00 (2024): [60310.417,60317.875]instead of getting the event time from the event header, for each event a random time in the given MJD range will be generated. Default: empty range, i.e. assume experimental input data.
Param mc_random_service_name:: Default = <Unprintable>, Name of the random number generator service used to generate the event time in the year for simulated events.
Param paranoia:: Default = False, Parameter to set the amount of sanity checks(False for less checks, True for more).
Param reco_particle_key:: Default = <Unprintable>, Name of the reconstructed particle in the frame.
Param shadow_name:: Default = 'Moon', Shadow from which object (Moon or Sun)?
Param shadow_zenith_maximum:: Default = 1.5707963267948966, Maximum zenith for the Moon/Sun (default: horizon).
Param solid_angle_corrected:: Default = False, If set, then the behavior of AzimuthRange is slightly changed: the azimuth difference is multiplied with sin(zenith) (zenith of the reconstructed track).
Param zenith_range:: Default = [-0.2617993877991494, 0.2617993877991494], Zenith range for the angular window, specified by two doubles that specify the minimum and maximum zenith difference w.r.t. the Moon/Sun coordinates.

GapMin¶

GapMin (Python I3Module)

Gap min class.

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 use_pulses:: Default = <Unprintable>, Use pulses or launches

I3Tray segments¶

MPE¶

MPE (I3Tray segment)

Define MPE segment.

Param Pulses:: Default = '',
Param Seed:: Default = '',
Param If:: Default = <function <lambda> at 0x11ff7bec0>,
Param suffix:: Default = '',
Param MPEFit:: Default = 'MPEFit',
Param MPEFitCramerRao:: Default = 'MPEFitCramerRao',

SPE¶

SPE (I3Tray segment)

Define SPE segment.

Param Pulses:: Default = '',
Param If:: Default = <function <lambda> at 0x11ff7bd80>,
Param suffix:: Default = '',
Param LineFit:: Default = 'LineFit',
Param SPEFitSingle:: Default = 'SPEFitSingle',
Param SPEFit:: Default = 'SPEFit2',
Param SPEFitCramerRao:: Default = 'SPEFit2CramerRao',
Param N_iter:: Default = 2,

OfflineFilterGapsWriter¶

OfflineFilterGapsWriter (I3Tray segment)

Tray segment to calculate the gaps and livetime of data files

Param Filename:: Default = None,
Param MinGapTime:: Default = 30,

generate_ref_file¶

generate_ref_file (I3Tray segment)

Generate information for a filter test reference file

elowenfilter¶

elowenfilter (I3Tray segment)

Run all the ELOWEN filtersteps.

RunCRWGFilters¶

RunCRWGFilters (I3Tray segment)

Run four CosmicRay filters.

CascadeOfflineFilter¶

CascadeOfflineFilter (I3Tray segment)

Offline Cascade Filter Segment.

CascadeLlhVertexFit¶

CascadeLlhVertexFit (I3Tray segment)

Run CscdLlhVertexFit, seeded with CLast.

Param Pulses:: Default = None,
Param If:: Default = <function <lambda> at 0x11ff4ab60>,

HighLevelFits¶

HighLevelFits (I3Tray segment)

SPE Reconstructions.

Param pulses:: Default = None,
Param InIceCscd:: Default = <function <lambda> at 0x11ff4b100>,

OfflineCascadeReco¶

OfflineCascadeReco (I3Tray segment)

Offline Basic Cascade Recos.

Param If:: Default = <function <lambda> at 0x11ff4a5c0>, Python function or module for conditional execution of all fits
Param BadDOMListName:: Default = 'BadDomsList', Name of the Bad DOMs list to use in the FillRatio module Should be the list that matches the input pulses (HLC pulses with HLC bad dom list, etc.)

Offline_Monopod¶

Offline_Monopod (I3Tray segment)

Run Monopod Reconstruction on cleaned and masked pulses.

Param Pulses:: Default = 'OfflinePulses',
Param amplitude_table:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_single_spice_ftp-v1_flat_z20_a5.abs.fits',
Param effectivedistance_table:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_effectivedistance_spice_ftp-v1_z20.eff.fits',
Param effectivedistance_tableprob:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_effectivedistance_spice_ftp-v1_z20.prob.fits',
Param effectivedistance_tablemod:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_effectivedistance_spice_ftp-v1_z20.tmod.fits',
Param tilt_table_dir:: Default = '$I3_BUILD/ice-models/resources/models/ICEMODEL/spice_ftp-v1/',
Param timing_table:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_single_spice_ftp-v1_flat_z20_a5.prob.v2.fits',
Param minimizer:: Default = 'iMIGRAD',
Param If:: Default = <function <lambda> at 0x11ff4af20>,

SPEFit¶

SPEFit (I3Tray segment)

Run SPE Fit.

Param Pulses:: Default = 'OfflinePulses',
Param Jitter:: Default = 15.0,
Param NoiseRate:: Default = 1e-08,
Param Iterations:: Default = 1,
Param If:: Default = <function <lambda> at 0x11ff4ade0>,

SplitFits¶

SplitFits (I3Tray segment)

Run SPEFit and CascadeLlh on split pulse series named {BasePulses}_0 and {BasePulses}_1.

Param BasePulses:: Default = None,
Param If:: Default = <function <lambda> at 0x109d9bf60>,

TimeSplitFits¶

TimeSplitFits (I3Tray segment)

Split the event in two time halves and run SPEFit+CscdLlh on each half separately.

Param Pulses:: Default = 'OfflinePulses',
Param If:: Default = <function <lambda> at 0x11ff4aca0>,

TopoSplitFits_Doubles¶

TopoSplitFits_Doubles (I3Tray segment)

Toological Split Fit on Double events.

Param If:: Default = <function <lambda> at 0x11ff4aa20>,

TopoSplitFits_Singles¶

TopoSplitFits_Singles (I3Tray segment)

Topological Split Fit.

Param SRTPulses:: Default = 'SplitRTCleanedInIcePulses',
Param If:: Default = <function <lambda> at 0x11ff4a8e0>,

CascadeHitCleaning¶

CascadeHitCleaning (I3Tray segment)

Cascade Pulse and Time Window Cleaning.

Param Pulses:: Default = 'SplitInIcePulses',
Param TWOfflinePulsesHLC:: Default = 'TWOfflinePulsesHLC',
Param If:: Default = <function <lambda> at 0x11ff4b2e0>,

TopologicalCounter¶

TopologicalCounter (I3Tray segment)

Count the number of topological clusters in a given pulse series map, using only the first HLC pulse in each DOM.

Param pulses:: Default = 'OfflinePulsesHLC',
Param If:: Default = <function <lambda> at 0x11ff4b420>,

runVeto_Coinc¶

runVeto_Coinc (I3Tray segment)

Run the veto on coincident events.

Param pulses:: Default = None,
Param If:: Default = <function <lambda> at 0x11ff4b6a0>,

runVeto_Singles¶

runVeto_Singles (I3Tray segment)

Run the veto on single events.

Param pulses:: Default = None,
Param If:: Default = <function <lambda> at 0x11ff4b560>,

deepcore_filter¶

deepcore_filter (I3Tray segment)

Apply the offline DeepCoreFilter cuts.

Param pulses:: Default = 'SplitInIcePulses',
Param If:: Default = <function <lambda> at 0x109d0fe20>,

FaintParticleFilter¶

FaintParticleFilter (I3Tray segment)

Define the FaintParticleFilter segment.

Param If:: Default = <function <lambda> at 0x11ffc0400>,

FaintParticleFilter_hive¶

FaintParticleFilter_hive (I3Tray segment)

Define the FaintParticleFilter hive segment.

Param pulses:: Default = None,
Param If:: Default = <function <lambda> at 0x11ffc0900>,

IceHiveFPF¶

IceHiveFPF (I3Tray segment)

Configure and run IceHive.

Param input_pulses:: Default = None,
Param SplitName:: Default = None,
Param output_pulses:: Default = None,

highq_filter¶

highq_filter (I3Tray segment)

Run hqtot, place the result in the P frame, and set a flag based on it.

Param filter_name:: Default = 'HighQFilter',

run_hqtot¶

run_hqtot (I3Tray segment)

Run HomogenizedQTot segment from VHESelfVeto module.

Param output_key_name:: Default = 'Homogenized_QTot',

IceTopTwoStationFilter¶

IceTopTwoStationFilter (I3Tray segment)

Make the frame I3Bool, and then run I3FilterModule on it. UNUSED for now, since we’re just doing I3Bools.

Param If:: Default = <function <lambda> at 0x11ffc1440>,

IceTopFilterNTank¶

IceTopFilterNTank (I3Tray segment)

Define the IceTopNTankX_22 filters.

IceTopFilterSelectedStations¶

IceTopFilterSelectedStations (I3Tray segment)

Define the IceTopSelectedStations_22 filters.

MeseFilter¶

MeseFilter (I3Tray segment)

Define the first version of the 2024 mese filter segment.

DoubleSplit¶

DoubleSplit (I3Tray segment)

Calculate reconstruction in two time windows.

Param InputPulseMap:: Default = None,
Param splitname1:: Default = None,
Param splitname2:: Default = None,
Param If:: Default = <function <lambda> at 0x11ffc1da0>,

MonopoleFilter¶

MonopoleFilter (I3Tray segment)

Define the MonopoleFilter segment.

Param If:: Default = <function <lambda> at 0x11ffc2340>,

monopoleCV¶

monopoleCV (I3Tray segment)

Calculate Common Variables.

Param RecoPulses:: Default = None,
Param ParticleName:: Default = None,
Param remove:: Default = None,
Param If:: Default = <function <lambda> at 0x11ffc1c60>,

CalculateCutValues¶

CalculateCutValues (I3Tray segment)

Run CommonVariables values to use in the offline muon filter cuts

Param If:: Default = <function <lambda> at 0x11ff79d00>,

CharacterizeHits¶

CharacterizeHits (I3Tray segment)

Write out various hit on the non-DeepCore pulses

Param If:: Default = <function <lambda> at 0x11ff7a3e0>,

MuonOfflineFilter¶

MuonOfflineFilter (I3Tray segment)

Run the OfflineMuonFilter.

OfflineMuonReconstructions¶

OfflineMuonReconstructions (I3Tray segment)

Run the reconstructions for the offline muon filter.

CalculateShieldVars¶

CalculateShieldVars (I3Tray segment)

Calculate shield variables to look for hits in IceTop.

DoBayesianFit¶

DoBayesianFit (I3Tray segment)

Perform a Bayesian fit using the given parameters.

Param Pulses:: Default = '',
Param Seed:: Default = '',
Param If:: Default = <function <lambda> at 0x11ff7afc0>,

DoReconstructions¶

DoReconstructions (I3Tray segment)

Perform various reconstructions on the input data.

Param photonicsdir:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/SPICEMie/',
Param photonicsdriverdir:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/SPICEMie/driverfiles/',
Param photonicsdriverfile:: Default = 'mu_photorec.list',
Param infmuonampsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/InfBareMu_mie_abs_z20a10_V2.fits',
Param infmuonprobsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/InfBareMu_mie_prob_z20a10_V2.fits',
Param cascadeampsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_single_spice_ftp-v1_flat_z20_a5.abs.fits',
Param cascadeprobsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_single_spice_ftp-v1_flat_z20_a5.prob.v2.fits',
Param cascadeeffdsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_effectivedistance_spice_ftp-v1_z20.eff.fits',
Param cascadeeffdprobsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_effectivedistance_spice_ftp-v1_z20.prob.fits',
Param cascadeeffdtmodsplinepath:: Default = '/cvmfs/icecube.opensciencegrid.org/data/photon-tables/splines/cascade_effectivedistance_spice_ftp-v1_z20.tmod.fits',
Param tiltdir:: Default = '$I3_BUILD/ice-models/resources/models/ICEMODEL/spice_ftp-v1/',
Param If:: Default = <function <lambda> at 0x11ff7b4c0>,

DoSplineReco¶

DoSplineReco (I3Tray segment)

Perform spline reconstruction for muon tracks.

Param spline:: Default = '',
Param If:: Default = <function <lambda> at 0x11ff7b380>,

DoSplitFits¶

DoSplitFits (I3Tray segment)

Perform split fits on the input pulses.

Param Pulses:: Default = '',
Param If:: Default = <function <lambda> at 0x11ff7b240>,

Paraboloid¶

Paraboloid (I3Tray segment)

Perform paraboloid reconstruction on muon events.

Param If:: Default = <function <lambda> at 0x11ff7a840>,

SplitRecos¶

SplitRecos (I3Tray segment)

Perform split reconstruction on the given tray.

Param Pulses:: Default = '',
Param Suffix:: Default = '',
Param If:: Default = <function <lambda> at 0x11ff7b100>,

SplitAndRecoIceHive¶

SplitAndRecoIceHive (I3Tray segment)

Use IceHive to split the frame, then apply reconstructions.

Param If:: Default = <function <lambda> at 0x100535940>,

moon_and_sun_filters¶

moon_and_sun_filters (I3Tray segment)

Create two I3ShadowFilters (one for Moon, one for Sun).

SLOPFilter¶

SLOPFilter (I3Tray segment)

Define the SLOPFilter segment.

Param use_pulses:: Default = None,
Param If:: Default = <function <lambda> at 0x11ffde5c0>,

audit¶

audit (I3Tray segment)

GCD audit tray segment.

Param run_id:: Default = None,

generate¶

generate (I3Tray segment)

Run main tray segment for generating GCDs.

Param run_id:: Default = None,

Legacy_CosmicRayFilter¶

Legacy_CosmicRayFilter (I3Tray segment)

Add a frame object containing tags for IceTop’s “legacy filters”.

Param Pulses:: Default = 'CleanedHLCTankPulses',
Param If:: Default = <function <lambda> at 0x11ffde8e0>,

make_offline_filter_mask¶

make_offline_filter_mask (I3Tray segment)

Create an offline filter mask.

Param decision_name:: Default = 'PassedAnyOfflineFilter',

offline_filters¶

offline_filters (I3Tray segment)

Run offline filters.

offline_process¶

offline_process (I3Tray segment)

Run the offline processing.

Param gcdfile:: Default = None,
Param infiles:: Default = None,

read_superdst_files¶

read_superdst_files (I3Tray segment)

Resplit compressed DST file (from Pole) and prepare for higher level processing.

ref_offline_filter_mask¶

ref_offline_filter_mask (I3Tray segment)

Create reference objects and optionally compress P frames to Q frames.

Project offline_filterscripts¶

Python I3Modules¶

I3Tray segments¶

Table of Contents

Previous topic

Next topic

This Page