View Javadoc

1   package org.lcsim.event;
2   //import java.util.*;
3   
4   /**
5    * Represents a generic calorimeter hit for real data (or simulation
6    * thereof).  In order to reduce the file size you can suppress a
7    * (32-bit) pointer tag stored with every hit by setting the
8    * flag(LCIO::RCHBIT_NO_PTR)==1. <br>
9    *
10   * <b>NB: If you apply this flag to reduce the file size you won't be
11   * able to point/refer to the RawCalorimeterHits, e.g. from an
12   * LCRelation object.</b>
13   * 
14   * @author Guilherme Lima
15   * @version $Id: RawCalorimeterHit.java,v 1.2 2005/04/28 23:27:25 tonyj Exp $
16   */
17  public interface RawCalorimeterHit {
18  
19      /** Returns the detector specific (geometrical) cell id.
20       */
21      public long getCellID();
22  
23      /** Returns the amplitude of the hit in ADC counts.
24       */
25      public int getAmplitude();
26  
27      /** Returns a time stamp for the hit. Optional, check/set 
28       *  flag(LCIO::RCHBIT_TIME)==1.
29       */
30      public int getTimeStamp();
31  } // class or interface