View Javadoc

1   package org.lcsim.event;
2   
3   /** Tracker pulses as computed from  TrackerData objects or as directly measured by a specific
4    *  subdetector. Typically TrackerHIts are created from TrackerPulses by some sort of clustering.
5    *  @see TrackerRawData
6    *  @see TrackerData
7    * 
8    * @author gaede
9    * @version $Id: TrackerPulse.java,v 1.2 2008/05/23 06:53:35 jeremy Exp $
10   */
11  
12  public interface TrackerPulse 
13  {
14      /** Returns the first detector specific (geometrical) cell id.
15       */
16      long getCellID();
17  
18      /** The time of the pulse - arbitrary units.
19       */
20      double getTime();
21  
22      /** The integrated charge of the pulse - arbitrary units.
23       */
24      double getCharge();
25  
26      /** The quality bit flag of the pulse - check/set collection parameters 
27       *  TrackerPulseQualityNames and TrackerPulseQualityNamesValues.
28       */
29      int getQuality();
30  
31      /** Optionally the TrackerData that has been used to create the pulse
32       *  can be stored with the pulse - NULL if none. Check the quality bits for reason
33       *  why the spectrum has been stored for the pulse.
34       */
35      TrackerData getTrackerData();
36  } // class or interface