View Javadoc

1   package org.lcsim.event;
2   
3   import hep.physics.matrix.SymmetricMatrix;
4   import hep.physics.vec.Hep3Vector;
5   import java.util.Map;
6   
7   /**
8    * A representation of a vertex
9    * @author tonyj
10   */
11  public interface Vertex
12  {
13      /** Checks if the Vertex is the primary vertex of the event.
14       *  Only one primary vertex per event is allowed
15       */
16      boolean isPrimary();
17  
18      /** Type code for the algorithm that has been used to create the vertex - check/set the 
19       *  collection parameters AlgorithmName and  AlgorithmType.
20       */
21      String getAlgorithmType();
22  
23       /** Chi squared of the vertex fit.
24       */
25      double getChi2();
26  
27      /** Probability of the vertex fit.
28       */
29      double getProbability();
30  
31      /** Position of the vertex
32       */
33      Hep3Vector getPosition();
34  
35      /** Covariance matrix of the position 
36       */
37      SymmetricMatrix getCovMatrix();
38  
39      /** Additional parameters related to this vertex.
40       */
41      Map<String,Double> getParameters();
42  
43      /** Returns Reconstructed Particle associated to the Vertex
44       */
45      ReconstructedParticle getAssociatedParticle(); 
46  }