first steps to set the covariance matrix from the errors calculated in conformal...

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

diff --git a/HLT/TPCLib/AliHLTTPCTrackArray.h b/HLT/TPCLib/AliHLTTPCTrackArray.h
index 8d5a5e125c26add9a01529cddc5ff9ba708f249f..4b74be439e5811d9298a8842b28fec3017d6b9f7 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCTrackArray.h
+++ b/HLT/TPCLib/AliHLTTPCTrackArray.h
@@ -1,41 +1,93 @@
+// -*- Mode: C++ -*-
 // @(#) $Id$
 // Original: AliHLTTrackArray.h,v 1.7 2004/06/11 16:06:33 loizides 
 #ifndef ALIHLTTPCTRACKARRAY_H
 #define ALIHLTTPCTRACKARRAY_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   AliHLTTPCTrackArray.h
+    @author Uli Frankenfeld, maintained by Matthias Richter
+    @date   
+    @brief  Array of AliHLTTPCTracks
+*/
+
 #include "AliHLTTPCRootTypes.h"
 
 class AliHLTTPCConfMapTrack;
 class AliHLTTPCTrack;
 class AliHLTTPCTrackSegmentData;
 
+/**
+ * @class AliHLTTPCTrackArray
+ * Array of AliHLTTrack objects.
+ * The class implements a dynamic array and handler methods.
+ *
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCTrackArray {
-
- private:
-
-  Char_t fTrackType; //track type
-  Int_t fSize; //size of arra
-  Bool_t *fIsPresent;//!
-  Int_t fNAbsent; //ntracks absent
-
-  AliHLTTPCTrack **fTrack;//!
-  Int_t fNTracks; //ntracks in
-
-  UInt_t WriteConfMapTracks(AliHLTTPCTrackSegmentData* tr); 
-  void DeleteArray();
-
  public:
+  /** default constructor */
   AliHLTTPCTrackArray();
+  /**
+   * constructor 
+   * @param ntrack     initial size
+   */
   AliHLTTPCTrackArray(Int_t ntrack);
+  /**
+   * constructor 
+   * @param tracktype  string describing type, one of
+   *   - AliHLTTPCTrack        -> 't'
+   *   - AliHLTTPCConfMapTrack -> 'c'
+   *   - AliHLTTPCHoughTrack   -> 'h'
+   *   - AliHLTTPCModelTrack   -> 'm'
+   * @param ntrack     initial size
+   */
   AliHLTTPCTrackArray(char* tracktype,Int_t ntrack);
+  /**
+   * constructor 
+   * @param tracktype  string describing type, one of
+   *   - AliHLTTPCTrack        -> 't'
+   *   - AliHLTTPCConfMapTrack -> 'c'
+   *   - AliHLTTPCHoughTrack   -> 'h'
+   *   - AliHLTTPCModelTrack   -> 'm'
+   */
   AliHLTTPCTrackArray(char* tracktype);
+  /** destructor */
   virtual ~AliHLTTPCTrackArray();
+
+  /**
+   * Get type of track.
+   * @return one of
+   *   - 't' -> AliHLTTPCTrack        
+   *   - 'c' -> AliHLTTPCConfMapTrack 
+   *   - 'h' -> AliHLTTPCHoughTrack   
+   *   - 'm' -> AliHLTTPCModelTrack   
+   */
   Int_t GetTrackType(){return fTrackType;}
+
+  /**
+   * Get size of the array.
+   * @return size of the array
+   */
   Int_t GetSize() const {return fSize;}
-  Bool_t SetSize(Int_t newsize=2000);
+
+  /**
+   * Set size.
+   * If the current size is smaller, the array is grown to the new size.
+   * @return kTRUE if the array was grown, kFALSE otherwise
+   */
+  Bool_t SetSize(Int_t newsize=0);
 
   Int_t GetNPresent() const {return (fNTracks- fNAbsent);}
   Int_t GetNTracks() const {return fNTracks;}
+
+  /**
+   * Return pointer to next free track object.
+   * The array is grown if necessary.
+   */
   AliHLTTPCTrack *NextTrack();
   AliHLTTPCTrack *GetCheckedTrack(Int_t t){if(fIsPresent[t]) return fTrack[t]; return 0;}
   AliHLTTPCTrack *GetTrack(Int_t t){return fTrack[t];}
@@ -48,8 +100,18 @@ class AliHLTTPCTrackArray {
   void QSort( AliHLTTPCTrack **a, Int_t first, Int_t last);
   Int_t TrackCompare(AliHLTTPCTrack *a, AliHLTTPCTrack *b) const;
 
-  void FillTracks(Int_t ntracks, AliHLTTPCTrackSegmentData* tr,Int_t slice); //Fill tracks and transform
-  void FillTracks(Int_t ntracks, AliHLTTPCTrackSegmentData* tr); //Fill tracks
+  /**
+   * Fill track array from track segment array.
+   * Reads the track from an array of AliHLTTrackSegmentData. The coordinates
+   * are transformed to global coordinates if the slice parameter is specified.
+   * In that case to internal slice variable is set to zero.
+   * @param ntracks      size of the input array
+   * @param tr           array of AliHLTTrackSegmentData
+   * @param slice        slice no to transform the tracks to
+   * @param bTransform   transform to global coordinates if 1
+   */
+  void FillTracks(Int_t ntracks, AliHLTTPCTrackSegmentData* tr,Int_t slice=-1, Int_t bTransform=1);
+
   UInt_t WriteTracks(AliHLTTPCTrackSegmentData* tr); //Write tracks
   UInt_t WriteTracks(UInt_t & ntracks,AliHLTTPCTrackSegmentData* tr); //Write tracks
   UInt_t GetOutSize();
@@ -57,7 +119,26 @@ class AliHLTTPCTrackArray {
   void AddTracks(AliHLTTPCTrackArray *newtrack,Bool_t remove_old=kTRUE,Int_t slice=-1);//add all Tracks to this 
   void AddLast(AliHLTTPCTrack *track);
 
-  ClassDef(AliHLTTPCTrackArray,1) //Track array class
+  AliHLTTPCTrack* operator[](int index);
+
+ private:
+  /** copy constructor prohibited */
+  AliHLTTPCTrackArray(const AliHLTTPCTrackArray&);
+  /** assignment operator prohibited */
+  AliHLTTPCTrackArray& operator=(const AliHLTTPCTrackArray&);
+
+  Char_t fTrackType; //track type
+  Int_t fSize; //size of array
+  Bool_t *fIsPresent;//!
+  Int_t fNAbsent; //ntracks absent
+
+  AliHLTTPCTrack **fTrack;//!
+  Int_t fNTracks; //ntracks in
+
+  UInt_t WriteConfMapTracks(AliHLTTPCTrackSegmentData* tr); 
+  void DeleteArray();
+
+  ClassDef(AliHLTTPCTrackArray,2) //Track array class
 };
 
 #endif