cleanup (Gaute)

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

diff --git a/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h b/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
index 15eef662d803fe8a0424feac7d4831b12d16279a..636fce62556b5bb345a0f962abf2da813c0c39a1 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
+++ b/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
@@ -6,16 +6,30 @@
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-/* AliHLTTPCSliceTrackerComponent
- */
+/** @file   AliHLTTPCSliceTrackerComponent.h
+    @author Timm Steinbeck, Matthias Richter
+    @date   
+    @brief  The TPC conformal mapping tracker component.
+*/
 
 #include "AliHLTProcessor.h"
-#include "AliHLTTPCDefinitions.h"
 
 class AliHLTTPCConfMapper;
 class AliHLTTPCVertex;
 class AliHLTTPCInterMerger;
 
+/**
+ * @class AliHLTTPCSliceTrackerComponent
+ * The TPC conformal mapping tracker component.
+ * 
+ * The component has the following component arguments:
+ * - disable-merger  disable merging of track segments
+ * - pp-run          parameter set for pp run
+ * - multiplicity    multiplicity to choose parameter set for
+ * - bfield          magnatic field
+ * 
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCSliceTrackerComponent : public AliHLTProcessor
 {
 public:
@@ -28,44 +42,63 @@ public:
   /** destructor */
   virtual ~AliHLTTPCSliceTrackerComponent();
 
-       // Public functions to implement AliHLTComponent's interface.
-       // These functions are required for the registration process
+  // Public functions to implement AliHLTComponent's interface.
+  // These functions are required for the registration process
 
-       const char* GetComponentID();
-       void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
-       AliHLTComponentDataType GetOutputDataType();
-       virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-       AliHLTComponent* Spawn();
+  /** interface function, see @ref AliHLTComponent for description */
+  const char* GetComponentID();
+  /** interface function, see @ref AliHLTComponent for description */
+  void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
+  /** interface function, see @ref AliHLTComponent for description */
+  AliHLTComponentDataType GetOutputDataType();
+  /** interface function, see @ref AliHLTComponent for description */
+  virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
+  /** interface function, see @ref AliHLTComponent for description */
+  AliHLTComponent* Spawn();
 
 protected:
-       
-       void SetTrackerParam(Int_t phiSegments=50,Int_t etaSegments=100,
-                            Int_t trackletlength=3,Int_t tracklength=5,
-                            Int_t rowscopetracklet=2,Int_t rowscopetrack=3,
-                            Double_t minPtFit=0,Double_t maxangle=1.31,
-                            Double_t goodDist=5,Double_t hitChi2Cut=10,
-                            Double_t goodHitChi2=20,Double_t trackChi2Cut=50,
-                            Int_t maxdist=50,Double_t maxphi=0.1,Double_t maxeta=0.1,
-                            bool vertexconstraint=true);
-       void SetTrackerParam( bool doPP, int multiplicity, double bField );
-       void SetTrackerParam1()
-               {
-               SetTrackerParam( 10, 20, 5, 10, 2,2,
-                                0, 1.31, 5, 100,
-                                50, 100, 50, 0.1, 0.1,
-                                true );
-               }
-
-       // Protected functions to implement AliHLTComponent's interface.
-       // These functions provide initialization as well as the actual processing
-       // capabilities of the component. 
-
-       int DoInit( int argc, const char** argv );
-       int DoDeinit();
-       int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
-                    AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
-                    AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
-       
+
+  /**
+   * Set Tracker parameters
+   * Knowledge on that has been lost, so somebody has to insert more
+   * documentation.
+   */  
+  void SetTrackerParam(Int_t phiSegments=50,Int_t etaSegments=100,
+                      Int_t trackletlength=3,Int_t tracklength=5,
+                      Int_t rowscopetracklet=2,Int_t rowscopetrack=3,
+                      Double_t minPtFit=0,Double_t maxangle=1.31,
+                      Double_t goodDist=5,Double_t hitChi2Cut=10,
+                      Double_t goodHitChi2=20,Double_t trackChi2Cut=50,
+                      Int_t maxdist=50,Double_t maxphi=0.1,Double_t maxeta=0.1,
+                      bool vertexconstraint=true);
+
+  /**
+   * Set Tracker parameters
+   * Knowledge on that has been lost, so somebody has to insert more
+   * documentation.
+   */
+  void SetTrackerParam( bool doPP, int multiplicity, double bField );
+
+  /**
+   * Set default tracker parameters
+   * Knowledge on that has been lost, so somebody has to insert more
+   * documentation.
+   */
+  void SetTrackerParam1();
+
+  // Protected functions to implement AliHLTComponent's interface.
+  // These functions provide initialization as well as the actual processing
+  // capabilities of the component. 
+
+  /** interface function, see @ref AliHLTComponent for description */
+  int DoInit( int argc, const char** argv );
+  /** interface function, see @ref AliHLTComponent for description */
+  int DoDeinit();
+  /** interface function, see @ref AliHLTComponent for description */
+  int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
+              AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
+              AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
+  
 private:
 
   /** instance of the tracker */
@@ -83,10 +116,8 @@ private:
   /** magnetic field */
   Double_t fBField;                                                //  see above
 
-// BEGINN ############################################## MODIFIY JMT
   Bool_t fnonvertextracking;   // enable NONVERTEX Tracking
   Bool_t fmainvertextracking;  // enable MAINVERTEX Tracking
-// END ################################################# MODIFIY JMT
 
   /** merger object */
   AliHLTTPCInterMerger *fpInterMerger;                             //! transient