Gulliver modules

Maintainer: Alan Coleman <alanc@udel.edu>

This project hosts three basic Gulliver-based Icetray modules:

I3LogLikelihoodCalculator

Calculates the log-likelihood for a given I3Particle, a likelihood service (derived from I3EventLogLikelihoodBase), and a parametrization service (derived from I3ParametrizationBase).

I3SimpleFitter

Performs a simple generic log-likelihood reconstruction.

I3IterativeFitter

A iteration-based extension of I3SimpleFitter.

The general steps performed by the modules are explained in Anatomy of a Gulliver fit. Most required services can be found in lilliput.

See also

Doxygen documentation, Gulliver, Lilliput, FiniteReco, Millipede, Paraboloid.

Examples

Calculate the log-likelihood for an I3LineFit and the I3RecoLLHFactory likelihood service:

tray.AddService("I3RecoLLHFactory", "spe1st",
                InputReadout="SRTOfflinePulses",
                Likelihood="SPE1st",
                PEProb="GaussConvoluted",
                IceModel=2,
                AbsorptionLength=98.*icecube.icetray.I3Units.m,
                NoiseProbability=100.*icecube.icetray.I3Units.hertz,
                JitterTime=15.*icecube.icetray.I3Units.ns)

tray.AddModule("I3LineFit", "lf",
               Name="lf",
               InputRecoPulses="SRTOfflinePulses",
               AmpWeightPower=1.)

tray.AddModule("I3LogLikelihoodCalculator", "lfLOGL",
               FitName="lf",
               LogLikelihoodService="spe1st",
               NFreeParameters=5)

Perform a basic I3SimpleFitter reconstruction:

tray.AddService("I3SimpleParametrizationFactory", "xyzza",
                StepX=20.*icecube.icetray.I3Units.m,
                StepY=20.*icecube.icetray.I3Units.m,
                StepZ=20.*icecube.icetray.I3Units.m,
                StepZenith=0.1*icecube.icetray.I3Units.radian,
                StepAzimuth=0.2*icecube.icetray.I3Units.radian,
                BoundsX=[-2000.*icecube.icetray.I3Units.m,
                         2000.*icecube.icetray.I3Units.m],
                BoundsY=[-2000.*icecube.icetray.I3Units.m,
                         2000.*icecube.icetray.I3Units.m],
                BoundsZ=[-2000.*icecube.icetray.I3Units.m,
                         2000.*icecube.icetray.I3Units.m])

tray.AddService("I3GulliverMinuitFactory", "minuit",
                Algorithm="SIMPLEX")

tray.AddService("I3RecoLLHFactory", "spe1st",
                InputReadout="SRTOfflinePulses",
                Likelihood="SPE1st",
                PEProb="GaussConvoluted",
                IceModel=2,
                NoiseProbability=1000.*icecube.icetray.I3Units.hertz,
                JitterTime=15.*icecube.icetray.I3Units.ns)

tray.AddService("I3BasicSeedServiceFactory", "linefitseed",
                InputReadout="SRTOfflinePulses",
                TimeShiftType="TFirst",
                FirstGuesses=["linefit"])

tray.AddModule("I3LineFit", "linefit",
               Name="linefit",
               InputRecoPulses="SRTOfflinePulses",
               AmpWeightPower=1.)

tray.AddModule("I3SimpleFitter", "spefit",
               SeedService="linefitseed",
               Parametrization="xyzza",
               LogLikelihood="spe1st",
               Minimizer="minuit")

If you want to do an iterative fit instead, simple replace I3SimpleFitter with I3IterativeFitter:

tray.AddModule("I3IterativeFitter", "spefit",
               SeedService="linefitseed",
               RandomService="I3RandomService",
               Parametrization="xyzza",
               LogLikelihood="spe1st",
               Minimizer="minuit")

The lilliput project provides IceTray segments for standard vanilla reconstructions performed at standard processing.

Gulliview

class icecube.gulliver_modules.gulliview.GulliView(ctx)

Likelihood space visualization

This module displays (or save PNGs for) the two-dimensional slices of the likelihood space around the seed.

Module parameters:

LogLikelihood

LogLikelihood service to use

Parametrization

Parametrization service to use

SeedService

Seed service to use

WithGradients

Plot LogLikelihood gradients along with function values.

NSteps

Number of steps to take along each dimension

StepSize

Size of each step in unit of the parametrization’s step size

Filename

Output filename base for plots; if None, run interactively.

The following example shows the basic usage of GulliView:

tray.Add("I3LineFit",
         Name="linefit",
         InputRecoPulses="SRTOfflinePulses",
         AmpWeightPower=1.)

mininame, paraname, llhname, seedname, name = tray.Add(
    icecube.lilliput.I3SinglePandelFitter, "PandelFit",
    pulses="SRTOfflinePulses",
    domllh="SPE1st",
    seeds=["linefit"])

seeder = icecube.lilliput.add_seed_service(
    tray, "SRTOfflinePulses", ["PandelFit"])

tray.Add(icecube.gulliver_modules.gulliview.GulliView,
         SeedService=seeder,
         Parametrization=paraname,
         LogLikelihood=llhname,
         Filename=None)