minor update of documentation

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

diff --git a/HLT/TPCLib/AliHLTTPCFileHandler.h b/HLT/TPCLib/AliHLTTPCFileHandler.h
index 3745207e3f5a267056698eea2e29e8b395bdef86..23fc1fb8e6bcb5645dcf0bff7aafdb21b5849389 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCFileHandler.h
+++ b/HLT/TPCLib/AliHLTTPCFileHandler.h
@@ -3,9 +3,9 @@
 
 #ifndef ALIHLTTPCFILEHANDLER_H
 #define ALIHLTTPCFILEHANDLER_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                               */
+//* 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   AliHLTTPCFileHandler.h
     @author U. Frankenfeld, A. Vestbo, C. Loizides, maintained by
@@ -13,13 +13,8 @@
     @date   
     @brief  file input for the TPC tracking code before migration to the
             HLT component framework
+*/
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-                                                                          */
 #include "AliHLTTPCMemHandler.h"
 
 class TClonesArray;
@@ -38,10 +33,11 @@ class AliHLTTPCTrackSegmentData;
 class AliHLTTPCTrackArray;
 
 /**
- * class AliHLTTPCFileHandler
+ * @class AliHLTTPCFileHandler
  * This is the input interface class for the TPC tracking code before conversion to
  * the HLT component framework.
  * 
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCFileHandler:public AliHLTTPCMemHandler {
 
@@ -92,21 +88,32 @@ class AliHLTTPCFileHandler:public AliHLTTPCMemHandler {
    * @return pointer to array, size in nrow <br>
    *         NULL in case of failure, required size in pTgtSize
    */
-  AliHLTTPCDigitRowData *AliDigits2Memory(UInt_t & nrow,Int_t event=0, Byte_t* tgtBuffer=NULL, UInt_t* pTgtSize=NULL);
+  //TODO: Check that the following change works. It should, but just double check.
+  AliHLTTPCDigitRowData *AliDigits2Memory(UInt_t & nrow,Int_t event, Byte_t* tgtBuffer, UInt_t* pTgtSize=NULL);
+
+  AliHLTTPCDigitRowData *AliDigits2Memory(UInt_t & nrow,Int_t event=0)
+  {
+    return AliDigits2Memory(nrow, event, NULL, NULL);
+  }
 
   /**
-   * Convert and filetr AliDigits from AliRoot file to HLT Digit data in memory.
+   * Convert and filter AliDigits from AliRoot file to HLT Digit data in memory.
    * This functions is the same as @ref AliDigits2Memory but in addition it
    * filters out single timebins, which is noise. The timebins which
    * are removed are timebins which have the 4 zero neighbours; 
    * (pad-1,time),(pad+1,time),(pad,time-1),(pad,time+1).
    *
-   * This is legacy code, the two function contain big portions of identical code
+   * This is legacy code, the two functions contain big portions of identical code
    * will be merged.
    * See @ref AliDigits2Memory for detailed description.
    */
   AliHLTTPCDigitRowData *AliAltroDigits2Memory(UInt_t & nrow,Int_t event=0,Bool_t eventmerge=kFALSE); 
 
+  /**
+   * Convert AliDigits from AliRoot file to Altro data format in memory.
+   */
+  int AliDigits2Altro(Int_t event, Byte_t* tgtBuffer, UInt_t size);
+
   /**
    * Write AliDigits from AliRoot file to binary file.
    * @param event      event no
@@ -142,13 +149,13 @@ class AliHLTTPCFileHandler:public AliHLTTPCMemHandler {
 
   TTree *fDigitsTree;//!
   FILE *fMC;//!
-  
+
   Bool_t fIndexCreated;   //is index created
-  Int_t  fIndex[36][159]; //stores index over digitstree 
+  Int_t  fIndex[fgkNSlice][fgkNRow]; //stores index over digitstree 
                           //for faster access w/o ASVVERSION
   Bool_t fUseStaticIndex; //take static index
   static Bool_t fgStaticIndexCreated;   //global index created
-  static Int_t  fgStaticIndex[36][159]; //global index
+  static Int_t  fgStaticIndex[fgkNSlice][fgkNRow]; //global index
 
   virtual Bool_t SetAliInput();
   Bool_t GetDigitsTree(Int_t event);
@@ -160,7 +167,7 @@ class AliHLTTPCFileHandler:public AliHLTTPCMemHandler {
   /** assignment operator prohibited */
   AliHLTTPCFileHandler& operator=(const AliHLTTPCFileHandler&);
 
-  ClassDef(AliHLTTPCFileHandler,1)   //Filehandler class
+  ClassDef(AliHLTTPCFileHandler,0)   //HLT TPC Filehandler IO class
 };
 
 #endif