Coding conventions & doccumentation

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

diff --git a/HLT/PHOS/AliHLTPHOSRawAnalyzerPeakFinder.h b/HLT/PHOS/AliHLTPHOSRawAnalyzerPeakFinder.h
index a624d1c3c6f7ac1338f115d2db6833d7fdc9f3ea..eda89c45b632b730727da106071ac08bb787e899 100644 (file)
--- a/HLT/PHOS/AliHLTPHOSRawAnalyzerPeakFinder.h
+++ b/HLT/PHOS/AliHLTPHOSRawAnalyzerPeakFinder.h
@@ -12,14 +12,54 @@ class AliHLTPHOSRawAnalyzerPeakFinder : public AliHLTPHOSRawAnalyzer
  public:
   AliHLTPHOSRawAnalyzerPeakFinder();
   AliHLTPHOSRawAnalyzerPeakFinder(const AliHLTPHOSRawAnalyzerPeakFinder & );
-  AliHLTPHOSRawAnalyzerPeakFinder & operator = (const AliHLTPHOSRawAnalyzerPeakFinder)
+  AliHLTPHOSRawAnalyzerPeakFinder & operator = (const AliHLTPHOSRawAnalyzerPeakFinder &)
     {
       return *this; 
     }
   virtual ~AliHLTPHOSRawAnalyzerPeakFinder();
-  virtual void SetTVector(Double_t *tVect, Int_t size);
-  virtual void SetAVector(Double_t *aVect, Int_t size);
-  virtual void Evaluate(Int_t start = 0, Int_t lenght = 100);
+
+
+/**
+* Extraction of timing and energy using the Peakfinde Algorithm.
+* 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 tVectPtr the peakfinder vector for timing
+* @param size size in number of values of the time vector
+*/
+  virtual void SetTVector(Double_t *tVectPtr =0, Int_t size = 0);
+
+
+
+/**
+* Extraction of timing and energy using the Peakfinde Algorithm.
+* 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 aVectPtr the peakfinder vector for timing
+* @param size size in number of values of the time vector
+*/
+  virtual void SetAVector(Double_t *aVectPtr =0, Int_t size =0);
+
+
+/**
+* Extraction of timing and energy using the Peakfinde Algorithm.
+* 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_t start = 0, Int_t length = 100);
  private:
   Double_t   *fTVectorPtr;  //[1008]        /**<Peakfinder vector for TOF reconstruction*/
   Double_t   *fAVectorPtr;  //[1008]        /**<Peakfinder vector for Energy reconstruction*/