View Javadoc

1   package org.lcsim.event;
2   
3   /**
4    *  Used by ReconstructedParticle and Cluster
5    *  for different hypotheses on the particle type.
6    *
7    * @author gaede
8    * @version $Id: ParticleID.java,v 1.2 2005/11/08 17:03:48 tonyj Exp $
9    * @see ReconstructedParticle#getParticleIDs()
10   */
11  public interface ParticleID
12  {
13     /** Type - userdefined.
14      */
15     public int getType();
16     
17     /** The PDG code of this id - UnknownPDG ( 999999 ) if unknown.
18      */
19     public int getPDG();
20     
21     /**The likelihood  of this hypothesis - in a user defined normalization.
22      */
23     public double getLikelihood();
24     
25     /** Type of the algorithm/module that created this hypothesis.
26      * Check/set collection parameters PIDAlgorithmTypeName and PIDAlgorithmTypeID.
27      */
28     public int getAlgorithmType();
29     
30     /** Parameters associated with this hypothesis.
31      * Check/set collection paramter PIDParameterNames for decoding the indices.
32      */
33     public double[] getParameters();
34     
35     /** Constant to be used if the PDG code is not known or undefined.
36      */
37     public final static int UnknownPDG = 999999;
38  }
39