removing obsolete files + fixing some doxygen warnings + added some documentation

[u/mrichter/AliRoot.git] / HLT / PHOS / AliHLTPHOSRawAnalyzerKLevel.h

diff --git a/HLT/PHOS/AliHLTPHOSRawAnalyzerKLevel.h b/HLT/PHOS/AliHLTPHOSRawAnalyzerKLevel.h
index 6399119a60ac8731e21b4c613817694987d8b0a0..674fa4e2bd03a44803f7beb387774d7ffed3cf82 100644 (file)
--- a/HLT/PHOS/AliHLTPHOSRawAnalyzerKLevel.h
+++ b/HLT/PHOS/AliHLTPHOSRawAnalyzerKLevel.h
@@ -10,6 +10,13 @@
 /* Copyright(c) 2006, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                          */
 
+/**
+ * The AliHLTPHOSPeakfinder class is the class for extracting the basic signal parameters
+ * "timing" and "energy" from the PHOS raw data. Physical data will for a given readout channel be
+ * a sequense of ADC digitized 10 bit integer values, however for performance reasons all values used in
+ * calculation is of type double.
+ **/
+
 class AliHLTPHOSRawAnalyzerKLevel : public AliHLTPHOSRawAnalyzer
 {
  public:
@@ -21,7 +28,19 @@ class AliHLTPHOSRawAnalyzerKLevel : public AliHLTPHOSRawAnalyzer
     }
   
   virtual ~AliHLTPHOSRawAnalyzerKLevel();
-  virtual void Evaluate(int start = 0, int lenght = 100);
+ 
+  /**
+   * Extraction of timing and energy using the K-Level method.
+   * The. The parameters "start" and "length" defines a sub array  of the data array
+   * that will be used for the the fit. If start+length must not exeed the total length
+   * of the Data array. "start" must be chosen as close as possible to t0.
+   * The baseline must also be subtracted.
+   * The length of "tVector" and "aVector" mus be equal to length.
+   * "index + length" must not exeed the length of the data array set in the constructor.
+   * @param start the start index of the subarray of the data array. 
+   * @param length the number of samples to use starting from index 
+   **/
+  virtual void Evaluate(int start = 0, int length = 100);
  private:
   double fTKLevel; /**<K-Level*/
   ClassDef(AliHLTPHOSRawAnalyzerKLevel, 2)