minor update of documentation

[u/mrichter/AliRoot.git] / HLT / TPCLib / AliHLTTPCClusterFinder.h

diff --git a/HLT/TPCLib/AliHLTTPCClusterFinder.h b/HLT/TPCLib/AliHLTTPCClusterFinder.h
index fd0285181ef62526006cab5e4ab439046b3e94d2..06457851223283f16e5c710c2c19ea20729372ac 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCClusterFinder.h
+++ b/HLT/TPCLib/AliHLTTPCClusterFinder.h
@@ -1,28 +1,30 @@
 // @(#) $Id$
 // Original: AliHLTClustFinderNew.h,v 1.13 2004/06/18 10:55:26 loizides 
 
-#ifndef AliHLTTPC_CLUSTERFINDER
-#define AliHLTTPC_CLUSTERFINDER
+#ifndef ALIHLTTPCCLUSTERFINDER_H
+#define ALIHLTTPCCLUSTERFINDER_H
 //* This file is property of and copyright by the ALICE HLT Project        * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/** @file   AliHLTTPCClusterFinder.h
-    @author Anders Vestbo, Constantin Loizides
-           Kenneth Aamodt kenneth.aamodt@student.uib.no
-    @brief  Cluster Finder for the TPC
-*/
+//  @file   AliHLTTPCClusterFinder.h
+//  @author Anders Vestbo, Constantin Loizides
+//         Kenneth Aamodt kenneth.aamodt@student.uib.no
+//  @brief  HLT Cluster Finder for the TPC
+//  @note
 
 #include "AliHLTLogging.h"
 #include <vector>
 #include "AliHLTTPCTransform.h"
 #include "AliHLTTPCDigitData.h"
 #include "AliHLTTPCDigitReader.h"
+#include "AliTPCRecoParam.h"
 
 class AliHLTTPCPad;
 class AliHLTTPCSpacePointData;
 class AliHLTTPCClusters;
 class AliTPCTransform;
+class AliTPCParam;
 
 /**
  * @class AliHLTTPCClusterFinder
@@ -123,14 +125,14 @@ class AliHLTTPCClusterFinder : public AliHLTLogging {
   typedef struct AliClusterData AliClusterData; //!
 
   struct MCWeight{
-    Int_t fMCID;
-    Float_t fWeight;
+    Int_t fMCID; //!
+    Float_t fWeight; //!
     static Bool_t CompareWeights( const MCWeight &mc1,  const MCWeight &mc2 ){ return mc1.fWeight > mc2.fWeight; }
   };
   typedef struct MCWeight MCWeight;
 
   struct ClusterMCInfo{
-    MCWeight fClusterID[3];
+    MCWeight fClusterID[3]; //!
   };
   typedef struct ClusterMCInfo ClusterMCInfo;
 
@@ -175,7 +177,7 @@ class AliHLTTPCClusterFinder : public AliHLTLogging {
   Int_t GetNumberOfClusters() const {return fNClusters;}
 
   /** Returns the Ocuppancy limit */
-  Float_t GetOccupancyLimit() {return fOccupancyLimit;}
+  Float_t GetOccupancyLimit() const {return fOccupancyLimit;}
   
   // setters
   void SetDeconv(Bool_t f) {fDeconvPad=f; fDeconvTime=f;}
@@ -186,6 +188,7 @@ class AliHLTTPCClusterFinder : public AliHLTLogging {
   void SetDoPadSelection(Bool_t input){fDoPadSelection=input;}
   void SetLastTimeBin(Int_t ltb){fLastTimeBin=ltb;}
   void SetFirstTimeBin(Int_t ftb){fFirstTimeBin=ftb;}
+  void SetReleaseMemory( Bool_t v ){ fReleaseMemory = v;}
   void UpdateLastTimeBin(){fLastTimeBin=AliHLTTPCTransform::GetNTimeBins();}
 
 //---------------------------------- Under this line the old sorted clusterfinder functions can be found --------------------------------
@@ -214,9 +217,11 @@ class AliHLTTPCClusterFinder : public AliHLTLogging {
   
   vector<AliHLTTPCPadVector> fRowPadVector;     //! transient
   
-  void FillMCClusterVector(vector<AliHLTTPCDigitData> digitData);
+  void FillMCClusterVector(vector<AliHLTTPCDigitData> *digitData);
 
-  vector<AliHLTTPCClusterFinder::MCWeight> GetClusterMCInfo(){return fClusterMCVector;}
+  vector<AliHLTTPCClusterFinder::MCWeight> GetClusterMCInfo() const {return fClusterMCVector;}
+
+  Bool_t UpdateCalibDB();
 
  protected: 
   /** copy constructor prohibited */
@@ -283,12 +288,18 @@ class AliHLTTPCClusterFinder : public AliHLTLogging {
 
   AliTPCTransform * fOfflineTransform;                             //! transient
 
+  AliTPCParam   *fOfflineTPCParam;                                 //! transient
+
+  AliTPCRecoParam fOfflineTPCRecoParam;                            //! transient
+
   Float_t fTimeMeanDiff;                                           //! transient
 
+  Bool_t fReleaseMemory; //! flag to release the memory after each event
+
 #ifdef do_mc
-  void GetTrackID(Int_t pad,Int_t time,Int_t *trackID);
+  void GetTrackID(Int_t pad,Int_t time,Int_t *trackID) const;
 #endif
   
-  ClassDef(AliHLTTPCClusterFinder,9) //Fast cluster finder
+  ClassDef(AliHLTTPCClusterFinder, 0) //Fast cluster finder
 };
 #endif