Project cscd-llh

Invoke with: import icecube.cscd_llh

C++ I3Modules

I3CscdLlhModule

"I3CscdLlhModule" (C++ I3Module)

IceTray module for executing a LLH reconstruction.

Param AmpWeightPower:

Default = 0.0, Hits are weighted with an amplitude raised to this power, if “FirstLE” is true. The “amplitude” is Set equal to the number of hits in the RecoHitsSeries for the OM. Typically 0.0 (weight=1 for all hits) or 1.0 (weight=amplitude).

Param EnergySeed:

Default = nan, The starting value for the cascade energy (GeV).

Param ExcludedOMs:

Default = [], This is a vector of OMs that are to be excluded from contributing to the likelihood. This is necessary for PDFs that need to know about un-hit OMs.

Param FirstLE:

Default = True, If true, use first leading edge with amplitude weight. If false, use all leading edges with no weights.

Param HitNoHitDead:

Default = 0.05, The probability that an OM will not register a hit, regardless of the light intensity.

Param HitNoHitDistCutoff:

Default = 0.5, Replace the geometrical factor 1/d with 1/(d + d_c) so that it’s well-behaved when d is small.

Param HitNoHitLambdaAttn:

Default = 29.0, The attenuation length.

Param HitNoHitNoise:

Default = 0.005, The probability that an OM will register a hit due to noise.

Param HitNoHitNorm:

Default = 1.4, The normalization factor for the expected number of photoelectrons. This is 1.4 (m/GeV) for most reconstructions, but needs to be changed to 40/1000 when reconstructing the direction.

Param HitNoHitSmallProb:

Default = 1e-40, The minimum probability (a small positive definite number.)

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 InputType:

Default = 'RecoHit', Type of input hits. Options are “RecoHit” and “RecoPulse”

Param Legendre Coefficient 0:

Default = 4.364, The zeroth coefficient for the legendre polynomial

Param Legendre Coefficient 1:

Default = 2.566, The first coefficient for the legendre polynomial

Param Legendre Coefficient 2:

Default = 2.0, The second coefficient for the legendre polynomial

Param MaxCalls:

Default = 50000, Maximum number of function calls after which minimizer will stop, even if it has not yet converged.

Param MinHits:

Default = 10, Minimum number of hits in the event.

Param MinimizeInLog(E):

Default = False, Minimizing in log(E) can improve the results when E varies slowly across the range.

Param Minimizer:

Default = '', The function minimizer. Options are “Brent”, “Powell”, and “Simplex”

Param PandelLambda:

Default = 47.0, Pandel length parameter.

Param PandelLambdaA:

Default = 98.0, Pandel absorption length.

Param PandelLightSpeed:

Default = 0.22103046286329384, The speed of light in ice.

Param PandelMaxDist:

Default = 500.0, If the distance from the hit to the cascade vertex is greater than “PandelMaxDist”, the probability will be Set to “PandelSmallProb”. If PandelMaxDist is less than or equal to zero, it will be ignored.

Param PandelSigma:

Default = 15.0, Patched Pandel gaussian width.

Param PandelSmallProb:

Default = 1e-10, The minimum probability (a small positive definite number.)

Param PandelTau:

Default = 450.0, Pandel time parameter.

Param ParamAzimuth:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the cascade azimuthal angle. String format is “SS, LL, UL, fix”.

Param ParamEnergy:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the cascade energy. String format is “SS, LL, UL, fix”.

Param ParamT:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the vertex time. String format is “SS, LL, UL, fix”.

Param ParamX:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the vertex x-coordinate. String format is “SS, LL, UL, fix”.

Param ParamY:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the vertex y-coordinate. String format is “SS, LL, UL, fix”.

Param ParamZ:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the vertex z-coordinate. String format is “SS, LL, UL, fix”.

Param ParamZenith:

Default = '', Step size (SS), lower limit (LL), upper limit (UL), fix (true or false) for the cascade polar angle. String format is “SS, LL, UL, fix”.

Param PDF:

Default = '', The probability density function. Options are “UPandel”, “UPandelMpe”, “HitNoHit”, “HitNoHitMpe”, and “PndlHnh”,”HnhDir “

Param PndlHnhWeight:

Default = 1.0, The weight of the Hit/No-hit factor of the PndlHnh PDF. The weight of the UPandel factor is always 1.0.

Param RecoSeries:

Default = 'Muon-DAQ Hits', RecoSeries name

Param ResultName:

Default = 'CscdLlh', Key for the RecoResultDict entry that holds the result of the reconstruction.

Param SeedKey:

Default = '', The dictionary key that holds the first guess vertex.

Param SeedWithOrigin:

Default = False, If true, use the detector origin and t=0 as a first guess. The “SeedKey” will be ignored. To be used only for testing purposes.

Param Tolerance:

Default = 0.01, Required tolerance on the function value at the minimum.