code documantation and minor cleanup
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 22 Apr 2008 11:24:42 +0000 (11:24 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 22 Apr 2008 11:24:42 +0000 (11:24 +0000)
56 files changed:
HLT/BASE/AliHLTDataTypes.h
HLT/RCU/AliHLTAltroEncoder.h
HLT/RCU/AliHLTAltroGenerator.cxx
HLT/RCU/AliHLTAltroGenerator.h
HLT/TPCLib/AliHLTTPCBenchmark.cxx [deleted file]
HLT/TPCLib/AliHLTTPCBenchmark.h [deleted file]
HLT/TPCLib/AliHLTTPCClusterDataFormat.h
HLT/TPCLib/AliHLTTPCClusterFinder.cxx
HLT/TPCLib/AliHLTTPCClusterFinder.h
HLT/TPCLib/AliHLTTPCClusterFinderComponent.cxx
HLT/TPCLib/AliHLTTPCClusterFinderComponent.h
HLT/TPCLib/AliHLTTPCConfMapFit.h
HLT/TPCLib/AliHLTTPCConfMapPoint.h
HLT/TPCLib/AliHLTTPCConfMapTrack.cxx
HLT/TPCLib/AliHLTTPCConfMapTrack.h
HLT/TPCLib/AliHLTTPCConfMapper.h
HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx
HLT/TPCLib/AliHLTTPCDataCompressorHelper.h
HLT/TPCLib/AliHLTTPCDefinitions.h
HLT/TPCLib/AliHLTTPCDigitData.h
HLT/TPCLib/AliHLTTPCDigitDumpComponent.h
HLT/TPCLib/AliHLTTPCDigitReader.h
HLT/TPCLib/AliHLTTPCDigitReaderDecoder.h
HLT/TPCLib/AliHLTTPCDigitReaderPacked.h
HLT/TPCLib/AliHLTTPCDigitReaderRaw.h
HLT/TPCLib/AliHLTTPCDigitReaderUnpacked.h
HLT/TPCLib/AliHLTTPCEsdWriterComponent.h
HLT/TPCLib/AliHLTTPCFileHandler.h
HLT/TPCLib/AliHLTTPCFitter.h
HLT/TPCLib/AliHLTTPCGlobalMerger.h
HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
HLT/TPCLib/AliHLTTPCInterMerger.h
HLT/TPCLib/AliHLTTPCKryptonClusterFinder.cxx
HLT/TPCLib/AliHLTTPCKryptonClusterFinder.h
HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h
HLT/TPCLib/AliHLTTPCLog.h
HLT/TPCLib/AliHLTTPCMemHandler.cxx
HLT/TPCLib/AliHLTTPCMemHandler.h
HLT/TPCLib/AliHLTTPCMerger.h
HLT/TPCLib/AliHLTTPCModelTrack.h
HLT/TPCLib/AliHLTTPCNoiseMapComponent.h
HLT/TPCLib/AliHLTTPCPad.h
HLT/TPCLib/AliHLTTPCRawDataUnpackerComponent.h
HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
HLT/TPCLib/AliHLTTPCSpacePointData.h
HLT/TPCLib/AliHLTTPCTrack.h
HLT/TPCLib/AliHLTTPCTrackArray.h
HLT/TPCLib/AliHLTTPCTrackMerger.h
HLT/TPCLib/AliHLTTPCTrackSegmentData.h
HLT/TPCLib/AliHLTTPCTrackletDataFormat.h
HLT/TPCLib/AliHLTTPCTransform.cxx
HLT/TPCLib/AliHLTTPCTransform.h
HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
HLT/TPCLib/docalihlttpc.c [new file with mode: 0644]
HLT/TPCLib/legacy.txt
HLT/libAliHLTTPC.pkg

index 91c48d3a27f76dcc340f2059c4c6fa0ca680f1e6..b27e7c2b231c4976ee0675ff9b882627d353f33c 100644 (file)
@@ -782,7 +782,7 @@ inline bool operator==( const AliHLTComponentDataType& dt1, const AliHLTComponen
 }
 
 /** Comparison operator for HLT component data types
- * invers of @ref operator==( const AliHLTComponentDataType& dt1, const AliHLTComponentDataType& dt2 )
+ * Invers of operator==
  * @ingroup alihlt_component_datatypes
  */
 inline bool operator!=( const AliHLTComponentDataType& dt1, const AliHLTComponentDataType& dt2 )
index 058080797febcbb7d47766036908ae9f1f67d06c..ed028a70b1080b2c0807aa5ed72fbd23ad8538b8 100644 (file)
     @brief  Encoder class for 10/40bit Altro Data format
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   
-
 #include "AliHLTDataTypes.h"
 #include "AliHLTLogging.h"
 #include <vector>
  * The class allows to encodes data sets of channel, timebin and signal
  * value into the 10bit/40bit Altro format. It works on a provided buffer.
  *
- * Signal values can be added by using the ::AddSignal function. This
- * functions works on a 'current channel'. If data is supposed to go into
- * a new channel, the ::SetChannel function has to be used.
+ * Signal values can be added by using the AddSignal(AliHLTUInt16_t, AliHLTUInt16_t)
+ * function. It functions works on a 'current channel'. If data is supposed to go into
+ * a new channel, SetChannel(AliHLTUInt16_t) has to be used.
+ *
+ * <pre>
+ *  AliHLTAltroEncoder encoder;
+ *  encoder.SetBuffer(pBuffer, size);
+ * 
+ *  for (channel ...) {
+ *    int channelAddress=...;
+ *    ...
+ *    for (int bunch=0; bunch<nofBunches; bunch++) {
+ *      int bunchLength=...;
+ *      int startTime=...;
+ *      int time=startTime;
+ *      for (; time<startTime+bunchLength; time++) {
+ *     iResult=encoder.AddSignal(signal, time);
+ *      }
+ *    }
+ * 
+ *    encoder.SetChannel(channelAddress);
+ *  }
+ * </pre>
+ * 
+ * @ingroup alihlt_rcu
  */
 class AliHLTAltroEncoder : AliHLTLogging {
  public:
index 1f146c8b17c967bb0a8669ba46b2b9c0a8571a6c..3ccb9dbc0ed690ddcd124adba686428f3643731d 100644 (file)
@@ -345,7 +345,6 @@ int AliHLTAltroGenerator::EncodeData(AliHLTUInt8_t* pBuffer, int size)
       int time=startTime;
       for (; time<startTime+bunchLength; time++) {
        iResult=encoder.AddSignal(fpSimData->At(dataPos++), time);
-       //iResult=encoder.AddChannelSignal(fpSimData->At(dataPos++), time, channelAddress);
       }
       assert(time-1==fpSimData->At(dataPos));
       dataPos++; // DO NOT PUT INTO ASSERT
@@ -361,9 +360,6 @@ int AliHLTAltroGenerator::EncodeData(AliHLTUInt8_t* pBuffer, int size)
     }
     encoder.SetChannel(channelAddress);
   }
-  if (iResult>=0 && channelAddress>=0) {
-    //encoder.SetChannel(channelAddress);
-  }
 
   if (iResult>=0) {
     iResult=(encoder.GetTotal40bitWords()*5)/4;
index e34599b376df07cb5625d91d610a683a575af7dd..7af0c3f1a15ee90212d1d36e8d810f46603bd2e3 100644 (file)
@@ -31,6 +31,20 @@ class TRandom;
 
 /**
  * @class AliHLTAltroGenerator
+ * Helper class to generate data in the Altro format.
+ * 
+ * The class can be configured through the parameters of the
+ * AliHLTAltroGenerator(int, int, int, int, int) constructor.
+ * The data is generated by the Generate() method and stored internally 
+ * for subsequent use. The data is encoded into a buffer with the 
+ * GetData(AliHLTUInt8_t) or GetData(AliHLTUInt8_t, int) methods.
+ *
+ * A couple of functions provide access to the simulated data on a
+ * signal by signal basis (Next()) or a bunch by bunch basis
+ * (NextChannel() / NextBunch()). The scheme follows pretty much the
+ * AliRawReader or AliAltroDecoder scheme respectively.
+ *
+ * @ingroup alihlt_rcu
  */
 class AliHLTAltroGenerator : AliHLTLogging {
  public:
diff --git a/HLT/TPCLib/AliHLTTPCBenchmark.cxx b/HLT/TPCLib/AliHLTTPCBenchmark.cxx
deleted file mode 100644 (file)
index 1175466..0000000
+++ /dev/null
@@ -1,195 +0,0 @@
-// @(#) $Id$
-
-// Author: Uli Frankenfeld <mailto:franken@fi.uib.no>
-//*-- Copyright &copy ALICE HLT Group
-
-/** \class AliHLTTPCBenchmark
-<pre>
-//_____________________________________________________________
-//
-// AliHLTTPCBenchmark
-//
-//   Benchmark class for level3 code
-//  
-//
-</pre>
-*/
-
-#ifndef no_root
-#include <TFile.h>
-#include <TGraphAsymmErrors.h>
-#include <TString.h>
-#include <TStopwatch.h>
-#include <TMath.h>
-#endif
-#include "AliHLTTPCRootTypes.h"
-#include "AliHLTTPCLogging.h"
-#include "AliHLTTPCBenchmark.h"
-
-#if __GNUC__ >= 3
-using namespace std;
-#endif
-
-ClassImp(AliHLTTPCBenchmark)
-
-AliHLTTPCBenchmark::AliHLTTPCBenchmark()
-  :
-  fNbench(0),
-  fNmax(20),
-  fNames(NULL),
-  fTimer(NULL),
-  fSum(NULL),
-  fMin(NULL),
-  fMax(NULL),
-  fCount(NULL)
-{
-  //Constructor
-}
-
-AliHLTTPCBenchmark::~AliHLTTPCBenchmark()
-{
-  //deconstructor
-   fNbench   = 0;
-   if (fNames)  {delete [] fNames; fNames  = 0;}
-   if (fTimer)  {delete [] fTimer; fTimer  = 0;}
-   if (fSum)    {delete [] fSum;   fSum   = 0;}
-   if (fMin)    {delete [] fMin;   fMin   = 0;}
-   if (fMax)    {delete [] fMax;   fMax   = 0;}
-   if (fCount)  {delete [] fCount; fCount =0;}
-}
-
-Int_t AliHLTTPCBenchmark::GetBench(const Char_t *name)
-{
-  //get bench with name
-   for (Int_t i=0;i<fNbench;i++) {
-      if (!strcmp(name,(const Char_t*)fNames[i])) return i;
-   }
-   return -1;
-}
-
-
-void AliHLTTPCBenchmark::Start(const Char_t *name)
-{
-  //start the benchmark with name
-   if (!fNbench) {
-#ifdef no_root
-     fNames=new Char_t*[fNmax];
-     fTimer = new AliHLTTPCStopwatch[fNmax];
-#else
-     fNames = new TString[fNmax];
-     fTimer = new TStopwatch[fNmax];
-#endif
-
-     fSum   = new Float_t[fNmax];
-     fMin   = new Float_t[fNmax];
-     fMax   = new Float_t[fNmax];
-     fCount = new Int_t[fNmax];
-     for(Int_t i =0;i<fNmax;i++){
-       fSum[i]=0;
-       fMin[i]=0;
-       fMax[i]=0;
-       fCount[i]=0;
-     }
-   }
-   Int_t bench = GetBench(name);
-   if (bench < 0 && fNbench < fNmax ) {
-      // define a new benchmark to Start
-#ifdef no_root
-     fNames[fNbench]=new Char_t[strlen(name)+1];
-     strcpy(fNames[fNbench],name);
-#else
-      fNames[fNbench] = name;
-#endif
-      bench = fNbench;
-      fNbench++;
-      fTimer[bench].Reset();
-      fTimer[bench].Start();
-   } else if (bench >=0) {
-   // Resume the existent benchmark
-      fTimer[bench].Reset();
-      fTimer[bench].Start();
-   }
-   else
-     LOG(AliHLTTPCLog::kWarning,"AliHLTTPCBenchmark::Start","Start")
-     <<"too many benches"<<ENDLOG;
-}
-
-void AliHLTTPCBenchmark::Stop(const char *name)
-{
-  //stop the benchmark with name
-   Int_t bench = GetBench(name);
-   if (bench < 0) return;
-
-   fTimer[bench].Stop();
-   Float_t val = fTimer[bench].CpuTime();
-   
-   fSum[bench] += val; 
-   fCount[bench]++;
-   if(fCount[bench]==1){
-     fMin[bench] = val;
-     fMax[bench] = val;
-   }
-   else{
-     if(val<fMin[bench])fMin[bench]=val;
-     if(val>fMax[bench])fMax[bench]=val;
-   }
-}
-
-void AliHLTTPCBenchmark::Analyze(const Char_t* name)
-{
-  //get results of benchmark
-  Float_t *x = new Float_t[fNbench]; 
-  Float_t *y = new Float_t[fNbench];
-  Float_t *eyl = new Float_t[fNbench]; 
-  Float_t *eyh = new Float_t[fNbench];
-  Char_t filename[256];
-  sprintf(filename,"%s.dat",name);
-  FILE *f= fopen(filename,"w");
-  for (Int_t i=0;i<fNbench;i++) {
-    Float_t av =0;
-    if(fCount[i]) av = fSum[i]/fCount[i]; 
-    x[i]=i+1;
-    y[i]=av*1000;
-    eyl[i]=(av-fMin[i])*1000;
-    eyh[i]=(fMax[i]-av)*1000;
-#ifdef no_root
-    fprintf(f,"%2d. %s: ",i+1,fNames[i]);
-#else
-    fprintf(f,"%2d. %s: ",i+1,fNames[i].Data());
-#endif
-    fprintf(f,"total %4.0f patch %4.0f -%4.0f +%4.0f ms\n",fSum[i],av*1000,eyl[i],eyh[i]);
-  }
-  fclose(f);
-  sprintf(filename,"%s.tmp",name);
-/* only a workaround!!
-  FILE *f2= fopen(filename,"w");
-  for (Int_t i=0;i<fNbench;i++) fprintf(f2,"%f ",x[i]); fprintf(f2,"\n");
-  for (Int_t i=0;i<fNbench;i++) fprintf(f2,"%f ",y[i]); fprintf(f2,"\n");
-  for (Int_t i=0;i<fNbench;i++) fprintf(f2,"%f ",eyl[i]); fprintf(f2,"\n");
-  for (Int_t i=0;i<fNbench;i++) fprintf(f2,"%f ",eyh[i]); fprintf(f2,"\n");
-  fclose(f2);
-*/
-#ifndef no_root
-  sprintf(filename,"%s.root",name);
-  TFile *file = new TFile(filename,"RECREATE");
-  TGraphAsymmErrors *gr = new TGraphAsymmErrors(fNbench,x,y,0,0,eyl,eyh);
-  gr->SetTitle("benchmark");
-  gr->SetMarkerStyle(8);
-  gr->SetMinimum(0);
-  //gr->Draw("ALP");
-  gr->Write();
-  file->Close();
-  delete file; 
-  file=0;
-#endif
-  delete[] x;
-  delete[] y;
-  delete[] eyl;
-  delete[] eyh;
-}
-
-Double_t AliHLTTPCBenchmark::GetCpuTime()
-{
-  //get cpu time
-  {return (Double_t)(clock()) / CLOCKS_PER_SEC;}
-}
diff --git a/HLT/TPCLib/AliHLTTPCBenchmark.h b/HLT/TPCLib/AliHLTTPCBenchmark.h
deleted file mode 100644 (file)
index 26136ce..0000000
+++ /dev/null
@@ -1,59 +0,0 @@
-// @(#) $Id$
-// Original: AliHLTBenchmark.h,v 1.6 2004/06/26 11:39:40 loizides 
-
-#ifndef ALIHLTTPCBENCHMARK_H
-#define ALIHLTTPCBENCHMARK_H
-
-//_____________________________________________________________
-//
-// AliHLTTPCBenchmark
-//
-//   Benchmark class for level3 code
-//  
-//
-
-#ifndef no_root
-class TStopwatch;
-class TString;
-#else
-class  AliHLTTPCStopwatch;
-#endif
-
-class AliHLTTPCBenchmark  {
-
-public:
-  /** standard constructor */
-  AliHLTTPCBenchmark();
-  /** destructor */
-  virtual ~AliHLTTPCBenchmark();
-   Int_t      GetBench(const Char_t *name);
-   void       Start(const Char_t *name);
-   void       Stop(const char *name);
-   void       Analyze(const Char_t* name);
-   
-   static Double_t GetCpuTime();
-
-private:
-  /** copy constructor prohibited */
-  AliHLTTPCBenchmark(const AliHLTTPCBenchmark&);
-  /** assignment operator prohibited */
-  AliHLTTPCBenchmark& operator=(const AliHLTTPCBenchmark&);
-
-   Int_t      fNbench;          //Number of active benchmarks
-   Int_t      fNmax;            //Maximum number of benchmarks initialized
-#ifndef no_root
-   TString    *fNames;          //! Names of benchmarks
-   TStopwatch *fTimer;          //! Timers
-#else
-   Char_t **fNames;             //! Names of benchmarks
-   AliHLTTPCStopwatch *fTimer;  //! Timers
-#endif
-   Float_t    *fSum;  //! sum of time
-   Float_t    *fMin;  //! min of time
-   Float_t    *fMax;  //! max of time
-   Int_t      *fCount;//! counter
-
-   ClassDef(AliHLTTPCBenchmark,0)  //HLTTPC benchmark
-};
-
-#endif // ALIHLTTPCBENCHMARK_H
index 1067702e0dc9e22233b06adae67eef9b5683e7e4..27ec01d3facad49547c6666a869b3ca056923ac8 100644 (file)
@@ -1,12 +1,19 @@
+// $Id$
 #ifndef _ALIHLTTPCCLUSTERFORMAT_H_
 #define _ALIHLTTPCCLUSTERFORMAT_H_
 
-/* Copyright(c) 1998-1999, 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.                         *
 
 #include "AliHLTTPCSpacePointData.h"
 
-/* AliHLTTPCClusterData
+/**
+ * @struct AliHLTTPCClusterData
+ * Primitive data exchange structure for TPC clusters.
+ * The data format contains one 32bit count member and the array
+ * of spacepoint data structures.
+ *
+ * @ingroup alihlt_tpc_datastructs
  */
 struct AliHLTTPCClusterData
     {
index 6f73426afb626e09a5e14e6ac3302eef1115fdbc..d0747493a9fdc870903de12c67e10e1d90965933 100644 (file)
@@ -1,21 +1,23 @@
 // @(#) $Id$
 // Original: AliHLTClustFinderNew.cxx,v 1.29 2005/06/14 10:55:21 cvetan Exp 
 
-/**************************************************************************
- * This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- *                                                                        *
- * Primary Authors: Kenneth Aamodt, Kalliopi Kanaki                       *
- *                  for The ALICE HLT Project.                            *
- *                                                                        *
- * Permission to use, copy, modify and distribute this software and its   *
- * documentation strictly for non-commercial purposes is hereby granted   *
- * without fee, provided that the above copyright notice appears in all   *
- * copies and that both the copyright notice and this permission notice   *
- * appear in the supporting documentation. The authors make no claims     *
- * about the suitability of this software for any purpose. It is          *
- * provided "as is" without express or implied warranty.                  *
- **************************************************************************/
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: Anders Vestbo, Constantin Loizides                    *
+//* Developers:      Kenneth Aamodt <kenneth.aamodt@student.uib.no>        *
+//*                  Kalliopi Kanaki                                       *
+//*                  for The ALICE HLT Project.                            *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
 
 /** @file   AliHLTTPCClusterFinder.cxx
     @author Kenneth Aamodt, Kalliopi Kanaki
 using namespace std;
 #endif
 
-/** \class AliHLTTPCClusterFinder
-//
-// The current cluster finder for HLT
-// (Based on STAR L3)
-//
-//Basically we have two versions for the cluster finder now.
-//The default version, reads the data pad by pad, and find the
-//clusters as it reads the data. The other version has now been
-//developed to cope with unsorted data. New methods for the unsorted
-//version can  be found at the end of the default one i the source file.
-//Currently the new version is only build to manage zero-suppressed data.
-//More functionality will be added later.
-//
-// The cluster finder is initialized with the Init function, 
-// providing the slice and patch information to work on. 
-//
-// The input is a provided by the AliHLTTPCDigitReader class,
-// using the init() funktion, and the next() funktion in order 
-// to get the next bin. Either packed or unpacked data can be
-// processed, dependent if one uses AliHLTTPCDigitReaderPacked 
-// class or AliHLTTPCDigitReaderUnpacked class in the 
-// Clusterfinder Component.
-// The resulting space points will be in the
-// array given by the SetOutputArray function.
-// 
-// There are several setters which control the behaviour:
-//
-// - SetXYError(Float_t):   set fixed error in XY direction
-// - SetZError(Float_t):    set fixed error in Z  direction
-//                            (used if errors are not calculated) 
-// - SetDeconv(Bool_t):     switch on/off deconvolution
-// - SetThreshold(UInt_t):  set charge threshold for cluster
-// - SetMatchWidth(UInt_t): set the match distance in 
-//                            time for sequences to be merged 
-// - SetSTDOutput(Bool_t):  switch on/off output about found clusters   
-// - SetCalcErr(Bool_t):    switch on/off calculation of 
-//                          space point errors (or widths in raw system)
-// - SetRawSP(Bool_t):      switch on/off convertion to raw system
-//
-//
-// Example Usage:
-//
-// AliHLTTPCFileHandler *file = new AliHLTTPCFileHandler();
-// file->SetAliInput(digitfile); //give some input file
-// for(int slice=0; slice<=35; slice++){
-//   for(int patch=0; pat<6; pat++){
-//     file->Init(slice,patch);
-//     UInt_t ndigits=0;
-//     UInt_t maxclusters=100000;
-//     UInt_t pointsize = maxclusters*sizeof(AliHLTTPCSpacePointData);
-//     AliHLTTPCSpacePointData *points = (AliHLTTPCSpacePointData*)memory->Allocate(pointsize);
-//     AliHLTTPCDigitRowData *digits = (AliHLTTPCDigitRowData*)file->AliAltroDigits2Memory(ndigits,event);
-//     AliHLTTPCClusterFinder *cf = new AliHLTTPCClusterFinder();
-//     cf->SetMatchWidth(2);
-//     cf->InitSlice( slice, patch, row[0], row[1], maxPoints );
-//     cf->SetSTDOutput(kTRUE);    //Some output to standard IO
-//     cf->SetRawSP(kFALSE);       //Convert space points to local system
-//     cf->SetThreshold(5);        //Threshold of cluster charge
-//     cf->SetDeconv(kTRUE);       //Deconv in pad and time direction
-//     cf->SetCalcErr(kTRUE);      //Calculate the errors of the spacepoints
-//     cf->SetOutputArray(points); //Move the spacepoints to the array
-//     cf->Read(iter->fPtr, iter->fSize ); //give the data to the cf
-//     cf->ProcessDigits();        //process the rows given by init
-//     Int_t npoints = cf->GetNumberOfClusters();
-//     AliHLTTPCMemHandler *out= new AliHLTTPCMemHandler();
-//     out->SetBinaryOutput(fname);
-//     out->Memory2Binary(npoints,points); //store the spacepoints
-//     out->CloseBinaryOutput();
-//     delete out;
-//     file->free();
-//     delete cf;
-//   }
-// }
-*/
-
 ClassImp(AliHLTTPCClusterFinder)
 
 AliHLTTPCClusterFinder::AliHLTTPCClusterFinder()
index 69afcd8f774bd44d4d857d44b9f6b2b0ff33017b..09c7096dd3df0e9b0d72fc74dce3347bfaf8de77 100644 (file)
 
 #ifndef AliHLTTPC_CLUSTERFINDER
 #define AliHLTTPC_CLUSTERFINDER
-/* 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   AliHLTTPCClusterFinder.h
-    @author Anders Vestbo, Constantin Loizides, Jochen Thaeder
+    @author Anders Vestbo, Constantin Loizides
            Kenneth Aamodt kenneth.aamodt@student.uib.no
-    @date   
     @brief  Cluster Finder for the TPC
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
-
 #include "AliHLTLogging.h"
-#include "AliHLTTPCPad.h"
+#include <vector>
+
+class AliHLTTPCPad;
 class AliHLTTPCSpacePointData;
 class AliHLTTPCDigitReader;
-
+class AliHLTTPCClusters;
+
+/**
+ * @class AliHLTTPCClusterFinder
+ *
+ * The current cluster finder for HLT
+ * (Based on STAR L3)
+ *
+ * Basically we have two versions for the cluster finder now.
+ * The default version, reads the data pad by pad, and find the
+ * clusters as it reads the data. The other version has now been
+ * developed to cope with unsorted data. New methods for the unsorted
+ * version can  be found at the end of the default one i the source file.
+ * Currently the new version is only build to manage zero-suppressed data.
+ * More functionality will be added later.
+ * 
+ * The cluster finder is initialized with the Init function, 
+ * providing the slice and patch information to work on. 
+ *
+ * The input is a provided by the AliHLTTPCDigitReader class,
+ * using the init() funktion, and the next() funktion in order 
+ * to get the next bin. Either packed or unpacked data can be
+ * processed, dependent if one uses AliHLTTPCDigitReaderPacked 
+ * class or AliHLTTPCDigitReaderUnpacked class in the 
+ * Clusterfinder Component.
+ * The resulting space points will be in the
+ * array given by the SetOutputArray function.
+ * 
+ * There are several setters which control the behaviour:
+ *
+ * - SetXYError(Float_t):   set fixed error in XY direction
+ * - SetZError(Float_t):    set fixed error in Z  direction
+ *                            (used if errors are not calculated) 
+ * - SetDeconv(Bool_t):     switch on/off deconvolution
+ * - SetThreshold(UInt_t):  set charge threshold for cluster
+ * - SetMatchWidth(UInt_t): set the match distance in 
+ *                            time for sequences to be merged 
+ * - SetSTDOutput(Bool_t):  switch on/off output about found clusters   
+ * - SetCalcErr(Bool_t):    switch on/off calculation of 
+ *                          space point errors (or widths in raw system)
+ * - SetRawSP(Bool_t):      switch on/off convertion to raw system
+ *
+ *
+ * Example Usage:
+ *
+ * <pre>
+ * AliHLTTPCFileHandler *file = new AliHLTTPCFileHandler();
+ * file->SetAliInput(digitfile); //give some input file
+ * for(int slice=0; slice<=35; slice++){
+ *   for(int patch=0; pat<6; pat++){
+ *     file->Init(slice,patch);
+ *     UInt_t ndigits=0;
+ *     UInt_t maxclusters=100000;
+ *     UInt_t pointsize = maxclusters*sizeof(AliHLTTPCSpacePointData);
+ *     AliHLTTPCSpacePointData *points = (AliHLTTPCSpacePointData*)memory->Allocate(pointsize);
+ *     AliHLTTPCDigitRowData *digits = (AliHLTTPCDigitRowData*)file->AliAltroDigits2Memory(ndigits,event);
+ *     AliHLTTPCClusterFinder *cf = new AliHLTTPCClusterFinder();
+ *     cf->SetMatchWidth(2);
+ *     cf->InitSlice( slice, patch, row[0], row[1], maxPoints );
+ *     cf->SetSTDOutput(kTRUE);    //Some output to standard IO
+ *     cf->SetRawSP(kFALSE);       //Convert space points to local system
+ *     cf->SetThreshold(5);        //Threshold of cluster charge
+ *     cf->SetDeconv(kTRUE);       //Deconv in pad and time direction
+ *     cf->SetCalcErr(kTRUE);      //Calculate the errors of the spacepoints
+ *     cf->SetOutputArray(points); //Move the spacepoints to the array
+ *     cf->Read(iter->fPtr, iter->fSize ); //give the data to the cf
+ *     cf->ProcessDigits();        //process the rows given by init
+ *     Int_t npoints = cf->GetNumberOfClusters();
+ *     AliHLTTPCMemHandler *out= new AliHLTTPCMemHandler();
+ *     out->SetBinaryOutput(fname);
+ *     out->Memory2Binary(npoints,points); //store the spacepoints
+ *     out->CloseBinaryOutput();
+ *     delete out;
+ *     file->free();
+ *     delete cf;
+ *   }
+ * }
+ * </pre>
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCClusterFinder : public AliHLTLogging {
 
  public:
index 486a38c45364ecdfe4773583236fd27f3565d2bd..97285060e596df9f444556ee87054705bb5355c9 100644 (file)
@@ -1,35 +1,28 @@
 // $Id$
 
-/**************************************************************************
- * This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- *                                                                        *
- * Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
- *                  Timm Steinbeck <timm@kip.uni-heidelberg.de>           *
- *                  Jochen Thaeder <thaeder@kip.uni-heidelberg.de>        *
- *                  for The ALICE HLT Project.                            *
- *                                                                        *
- * Permission to use, copy, modify and distribute this software and its   *
- * documentation strictly for non-commercial purposes is hereby granted   *
- * without fee, provided that the above copyright notice appears in all   *
- * copies and that both the copyright notice and this permission notice   *
- * appear in the supporting documentation. The authors make no claims     *
- * about the suitability of this software for any purpose. It is          *
- * provided "as is" without express or implied warranty.                  *
- **************************************************************************/
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: Timm Steinbeck, Matthias Richter                      *
+//* Developers:      Kenneth Aamodt <kenneth.aamodt@student.uib.no>        *
+//*                  for The ALICE HLT Project.                            *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
 
 /** @file   AliHLTTPCClusterFinderComponent.cxx
-    @author Timm Steinbeck, Matthias Richter, Jochen Thaeder, Kenneth Aamodt
+    @author Kenneth Aamodt <kenneth.aamodt@student.uib.no>
     @date   
     @brief  The TPC cluster finder processing component
 */
 
-// see header file for class documentation                                   //
-// or                                                                        //
-// refer to README to build package                                          //
-// or                                                                        //
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt                          //
-
 #if __GNUC__>= 3
 using namespace std;
 #endif
index 9e35c70fc68d7ddc69fa03f492b0f092a6ac62dd..5444088a3fe22d4ee31c4164ccad1c3898dad51f 100644 (file)
@@ -3,22 +3,16 @@
 #ifndef ALIHLTTPCCLUSTERFINDERCOMPONENT_H
 #define ALIHLTTPCCLUSTERFINDERCOMPONENT_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   AliHLTTPCClusterFinderComponent.h
-    @author Timm Steinbeck, Matthias Richter, Jochen Thaeder
+    @author Timm Steinbeck, Matthias Richter, Kenneth Aamodt
     @date   
     @brief  The TPC cluster finder component.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 
 class AliHLTTPCClusterFinder;
index 5a188aeeb9990d3e3fb604fbbf38a5977d9a822f..a2422152d6ea6c937e2fa4b7dd7ba152023e1013 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCCONFMAPFIT_H
 #define ALIHLTTPCCONFMAPFIT_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCConfMapFit.h
     @author Anders Vestbo, maintained by Matthias Richter
     @brief  Fit class for conformal mapping tracking.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 class AliHLTTPCConfMapTrack;
 class AliHLTTPCVertex;
 
@@ -27,6 +22,7 @@ class AliHLTTPCVertex;
  *
  * Fit class for conformal mapping tracking
  *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCConfMapFit {
 
index d030576a639fe8e00de986663c2b3d1a4e862099..b89b67b15c4aab19618edc2f205eb030271d4898 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCCONFMAPPOINT_H
 #define ALIHLTTPCCONFMAPPOINT_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCConfMapPoint.h
     @author Anders Vestbo, maintained by Matthias Richter
@@ -23,6 +24,7 @@ class AliHLTTPCVertex;
  * @class AliHLTTPCConfMapPoint
  * Hit class for conformal mapper
  *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCConfMapPoint {
 
index 0e2f27341a25a72c821376c31060e00ca106c93f..7e413b7b30e2720da6f51274d3a3c9312ea84328 100644 (file)
@@ -1,22 +1,22 @@
 // @(#) $Id$
 // Original: AliHLTConfMapTrack.cxx,v 1.16 2005/06/14 10:55:21 cvetan 
 
-/**************************************************************************
- * This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- *                                                                        *
- * Primary Authors: Anders Vestbo, maintained by                          *
- *                  Matthias Richter <Matthias.Richter@ift.uib.no>        *
- *                  for The ALICE HLT Project.                            *
- *                                                                        *
- * Permission to use, copy, modify and distribute this software and its   *
- * documentation strictly for non-commercial purposes is hereby granted   *
- * without fee, provided that the above copyright notice appears in all   *
- * copies and that both the copyright notice and this permission notice   *
- * appear in the supporting documentation. The authors make no claims     *
- * about the suitability of this software for any purpose. It is          *
- * provided "as is" without express or implied warranty.                  *
- **************************************************************************/
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: Anders Vestbo, maintained by                          *
+//*                  Matthias Richter <Matthias.Richter@ift.uib.no>        *
+//*                  for The ALICE HLT Project.                            *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
 
 /** @file   AliHLTTPCConfMapTrack.cxx
     @author Anders Vestbo, maintained by Matthias Richter
@@ -31,7 +31,6 @@
 #include "AliHLTTPCConfMapFit.h"
 #include "AliHLTTPCConfMapTrack.h"
 #include "AliHLTTPCTransform.h"
-//#include "AliHLTTPC.h"
 
 #if __GNUC__ >= 3
 using namespace std;
index 90c1f18d61cabd1a057e4075bee4b72d02d7592d..9779f213b972f84f2e0c560900d7e39138f79966 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCCONFMAPTRACK_H
 #define ALIHLTTPCCONFMAPTRACK_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCConfMapTrack.h
     @author Anders Vestbo, maintained by Matthias Richter
     @brief  Track class for conformal mapper
 */
 
-#include <string.h>
-
 #include "AliHLTTPCTrack.h"
-
-#include "AliHLTTPCRootTypes.h"
 #include "AliHLTTPCConfMapPoint.h"
 
 class AliHLTTPCVertex;
@@ -26,6 +23,7 @@ class AliHLTTPCVertex;
  * @class AliHLTTPCConfMapTrack
  * Track class for conformal mapper
  *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCConfMapTrack :public AliHLTTPCTrack {
 
index 72ccacd45a7f64c5c4df15ad83d781691e90ab00..cd19364506ac1f6e6bc4853a4b2ff275d57ae2b9 100644 (file)
@@ -14,8 +14,8 @@
 */
 
 #include <vector>
+#include "AliHLTTPCConfMapPoint.h"
 
-class AliHLTTPCConfMapPoint;
 class AliHLTTPCConfMapTrack;
 class AliHLTTPCVertex;
 class AliHLTTPCTrackArray;
@@ -25,6 +25,8 @@ class AliHLTTPCSpacePointData;
 /** 
  * @class AliHLTTPCConfMapper
  * Conformal mapping base class.
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCConfMapper {
 
index b54cfb7c5f5057fca6f59897314c4469aec349a9..708bf9840c52236579d73068f950389589b1e9f5 100644 (file)
@@ -1,8 +1,21 @@
 // @(#) $Id$
 // Original: AliHLTDataCompressorHelper.cxx,v 1.5 2004/06/15 10:26:57 hristov Exp $
 
-// Author: Anders Vestbo <mailto:vestbo@fi.uib.no>
-//*-- Copyright &copy ALICE HLT Group
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: Anders Vestbo                                         *
+//*                  for The ALICE HLT Project.                            *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
 
 #include "AliHLTStdIncludes.h"
 #include "AliHLTTPCRootTypes.h"
index d079a3b7ceecac87915692d518a7b4c3e2110cc5..f7e0a0caafc5d301549f5d0408ec051f3ac287ea 100644 (file)
@@ -1,11 +1,18 @@
 // @(#) $Id$
 // Original: AliHLTDataCompressorHelper.h,v 1.4 2004/06/15 10:26:57 hristov Exp $
 
+//* 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                               *
+
 #ifndef AliHLTTPC_DataCompressorHelper
 #define AliHLTTPC_DataCompressorHelper
 
-#include "AliHLTTPCRootTypes.h"
-
+/**
+ * @class AliHLTTPCDataCompressorHelper
+ *
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCDataCompressorHelper {
   
  public:
index 0e128c984ee0ae8d0847d0a5ba2aad9c2b5d6e40..a013181eb759d72d19046311fe801c91805c444d 100644 (file)
@@ -13,6 +13,8 @@
 /**
  * @class AliHLTTPCDefinitions
  * Data type definitions for the libAliHLTTPC library.
+ * 
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCDefinitions
 {
index 1e6ba7b3b0e0b583ff7c1f9bc8208a1082fc92e0..6a53188f244401cb50e8c860fca8ec782dc76973 100644 (file)
@@ -16,7 +16,7 @@
  *
  * The exact meaning of the 3 track ID fields is currently not known to me.
  * (Matthias 18.09.2007) 
- * @ingroup alihlt-tpc-datastructs
+ * @ingroup alihlt_tpc_datastructs
  */
 struct AliHLTTPCDigitData
 {
@@ -31,7 +31,7 @@ typedef struct AliHLTTPCDigitData AliHLTTPCDigitData;
  * @struct AliHLTTPCDigitRowData
  * A container for TPC raw data organized in rows.
  * This is the 3rd coordinate which is missing in @ref AliHLTTPCDigitData.
- * @ingroup alihlt-tpc-datastructs
+ * @ingroup alihlt_tpc_datastructs
  */
 struct AliHLTTPCDigitRowData
 {
@@ -53,7 +53,7 @@ typedef struct AliHLTTPCDigitRowData AliHLTTPCDigitRowData;
  *
  * The structure is not used for data exchange between components,
  * it's here for legacy reasons.
- * @ingroup alihlt-tpc-datastructs
+ * @ingroup alihlt_tpc_datastructs
  */
 struct AliHLTTPCRandomDigitData{
   UChar_t fRow;
@@ -67,7 +67,7 @@ typedef struct AliHLTTPCRandomDigitData AliHLTTPCRandomDigitData;
  * @struct AliHLTTPCPackedRawData
  * Container structure for TPC data.
  * It contains an array of TPC data objects, organized by pad rows.
- * @ingroup alihlt-tpc-datastructs
+ * @ingroup alihlt_tpc_datastructs
  */
 struct AliHLTTPCUnpackedRawData
 {
index 6236d93f8742c02277e9fcb2aa4acf16e2092f99..1d4f9126b5ec453fd645fcff46970def802e0b54 100644 (file)
@@ -3,9 +3,9 @@
 
 #ifndef ALIHLTTPCDIGITDUMPCOMPONENT_H
 #define ALIHLTTPCDIGITDUMPCOMPONENT_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   AliHLTTPCDigitDumpComponent.h
     @author Matthias Richter
     @brief  Special file writer converting TPC digit input to ASCII.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   
-
 #include "AliHLTFileWriter.h"
 
 /**
index 1a1e809d00e4fd872b3780221127eb31d7fefd6f..4023186954165d488ebb3a21f92c2c2e150940bf 100644 (file)
@@ -4,9 +4,9 @@
 #ifndef ALIHLTTPCDIGITREADER_H
 #define ALIHLTTPCDIGITREADER_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   AliHLTTPCDigitReader.h
     @author Timm Steinbeck, Jochen Thaeder, Matthias Richter, Kenneth Aamodt
     @brief  An abstract reader class for TPC data.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTLogging.h"
 #include "TObject.h"
 
index 1a47f86b8cc3354d721b5cbe145ba0b44323545c..9148e96506f750a524a4490d58cc04f3ee7b358d 100644 (file)
     @brief  DigitReader for the fast ALTRO Decoder
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTTPCDigitReader.h"
 #include "AliAltroData.h"
 class AliHLTTPCMapping;
@@ -30,6 +24,7 @@ class AliAltroBunch;
  * @class AliHLTTPCDigitReaderDecoder
  * Digit reader implementation for real ALTRO/RCU data using the fast
  * AliAltroDecoder class.
+ *
  * @ingroup alihlt_tpc
  */
 class AliHLTTPCDigitReaderDecoder : public AliHLTTPCDigitReader {
index 54587de2303c306e565fd1a9e1cd49d3c62d8628..3806a1ce730d7cff8f707259e2b41981eb731f6e 100644 (file)
@@ -27,6 +27,7 @@ class AliTPCRawStream;
  * Includes reordering of the pads by default, sorting (and time and
  * memory consuming intermediate storing of the data) can be disabled
  * by @ref SetUnsorted() with argument <b>kTRUE</b>.
+ *
  * @ingroup alihlt_tpc
  */
 class AliHLTTPCDigitReaderPacked : public AliHLTTPCDigitReader{
index db881be8aff2ef86179fd4835a2390c04cba0c39..311bc73558be19f38ff72584bc1f90f8dab31199 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCDIGITREADERRAW_H
 #define ALIHLTTPCDIGITREADERRAW_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCDigitReaderRaw.h
     @author Timm Steinbeck, Jochen Thaeder, Matthias Richter
@@ -31,6 +32,9 @@
  *  - 3: As 1, but RCU trailer is 3 32 bit words.
  *  - 4: As 0, but RCU trailer is 2 32 bit words.
  *  - 5: As 1, but RCU trailer is 2 32 bit words.
+ *
+ * @note This class is deprecated!
+ *
  * @ingroup alihlt_tpc
  */
 class AliHLTTPCDigitReaderRaw : public AliHLTTPCDigitReader  {
index f71824131d16532a6a5d696e430e75dbb2af3de7..138df29cb3c70c9b05c676975e85fd10c2791d85 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCDIGITREADERUNPACKED_H
 #define ALIHLTTPCDIGITREADERUNPACKED_H
 
-// Copyright(c) 1998-1999, 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   AliHLTTPCDigitReaderUnpacked.h
     @author Timm Steinbeck, Jochen Thaeder, Matthias Richter
index ee58b938c932dbde4b3c2b3a892a44da64bf89bc..e2540760e2f6964ebc5d8a6f309d47e5ee1b0e7a 100644 (file)
@@ -2,21 +2,16 @@
 
 #ifndef ALIHLTTPCESDWRITERCOMPONENT_H
 #define ALIHLTTPCESDWRITERCOMPONENT_H
-/* Copyright(c) 1998-1999, 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   AliHLTTPCEsdWriterComponent.h
     @author Matthias Richter
     @date   
     @brief  Writer component to store tracks of the HLT TPC conformal
             mapping tracker in the AliESD format
-
-                                                                          */
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+*/
 
 #include "AliHLTRootFileWriterComponent.h"
 #include "AliHLTProcessor.h"
index 9ec32d3a38feecf43de664ad9c47ee901946659f..fc61790814af72bd7832277ac533eedfc14b3403 100644 (file)
@@ -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
     @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 {
 
index 79d90e1c5b063d6ae4987b3aa1e2aa417c53798f..12df2a3be204a458b6003aa417b30224bcdd86d7 100644 (file)
@@ -3,8 +3,9 @@
 
 #ifndef ALIHLTTPCFITTER_H
 #define ALIHLTTPCFITTER_H
-/* Copyright(c) 1998-1999, 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   AliHLTTPCFitter.h
     @author Anders Vestbo, maintained by Matthias Richter
@@ -19,6 +20,8 @@ class AliHLTTPCSpacePointData;
 /** 
  * @class AliHLTTPCFitter
  * Fit class HLT for helix
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCFitter {
 
index bca7c38a48e378624996a8aa9b9c9f50cd62d0b6..84dfdbd7aec36ad4a0c7e6f1b6c0746bdcf2e309 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPC_GLOBALMERGER_H
 #define ALIHLTTPC_GLOBALMERGER_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCGlobalMerger.h
     @author Uli Frankenfeld, maintained by Matthias Richter
@@ -22,6 +23,8 @@
 /** 
  * @class AliHLTTPCGlobalMerger
  * The HLTTPC Slice merger
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCGlobalMerger : public AliHLTTPCMerger{
 
index 77ef16f40555f11e8f4bb79979e25155539d0180..1b4651195e0f227cafa919e6918f18e1b5c61b36 100644 (file)
@@ -3,8 +3,9 @@
 
 #ifndef ALIHLTTPCGLOBALMERGERCOMPONENT_H
 #define ALIHLTTPCGLOBALMERGERCOMPONENT_H
-/* Copyright(c) 1998-1999, 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   AliHLTTPCGlobalMergerComponent.h
     @author Timm Steinbeck, Matthias Richter
     @brief  HLT TPC global merger component.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 
 class AliHLTTPCGlobalMerger;
index 7e5b98b4acd2fe57dcfbc8ee1d6b2fbc1b94aaf2..acc1105bafa7e97acb80b3dd04b7cf8464682f81 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCINTERMERGER_H
 #define ALIHLTTPCINTERMERGER_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCInterMerger.h
     @author Uli Frankenfeld, maintained by Matthias Richter
@@ -22,6 +23,8 @@
 /** 
  * @class AliHLTTPCInterMerger
  * The HLTTPC track segment merger
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCInterMerger : public AliHLTTPCMerger {
 
index 32a321b963f26334d23fc90cb6735292f2ef2651..2c375cd51fc71365c6a55899e765ad45ce32d132 100644 (file)
@@ -1,19 +1,19 @@
 // $Id$
-/**************************************************************************
- * This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- *                                                                        *
- * Primary Authors: Kenneth Aamodt <kenneth.aamodt@student.uib.no>        *
- *                  for The ALICE HLT Project.                            *
- *                                                                        *
- * Permission to use, copy, modify and distribute this software and its   *
- * documentation strictly for non-commercial purposes is hereby granted   *
- * without fee, provided that the above copyright notice appears in all   *
- * copies and that both the copyright notice and this permission notice   *
- * appear in the supporting documentation. The authors make no claims     *
- * about the suitability of this software for any purpose. It is          *
- * provided "as is" without express or implied warranty.                  *
- **************************************************************************/
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: Kenneth Aamodt <kenneth.aamodt@student.uib.no>        *
+//*                  for The ALICE HLT Project.                            *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
 
 /** @file    AliHLTTPCKryptonClusterFinder.cxx
     @author  Kenneth Aamodt, Kalliopi Kanaki
@@ -24,6 +24,8 @@
 #include "AliHLTTPCDigitReader.h"
 #include "AliHLTTPCKryptonClusterFinder.h"
 #include "AliHLTTPCTransform.h"
+#include "AliHLTTPCPad.h"
+#include "AliHLTTPCClusters.h"
 #include "TFile.h"
 
 #if __GNUC__ >= 3
index 4038706cd48b2b0e18a8ba96cab4140cc5a9c21e..4dc0d5480fb01a0e60a62a14894afe6d8e154b02 100644 (file)
@@ -2,9 +2,9 @@
 
 #ifndef AliHLTTPC_KRYPTONCLUSTERFINDER
 #define AliHLTTPC_KRYPTONCLUSTERFINDER
-/* 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   AliHLTTPCKryptonClusterFinder.h
     @author Kenneth Aamodt kenneth.aamodt@student.uib.no
     @brief  Krypton Cluster Finder for the TPC
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
-
 //#include "AliHLTLogging.h"
 //#include "AliHLTTPCPad.h"
 #include "AliHLTTPCClusterFinder.h"
 class AliHLTTPCSpacePointData;
 class AliHLTTPCDigitReader;
 
+/**
+ * @class AliHLTTPCKryptonClusterFinder
+ *
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCKryptonClusterFinder : public AliHLTTPCClusterFinder {
 
  public:
index 8abb5cf8efe85d98f23d6a96e9320fa5cf43d1fb..882547da6dc51d24da7488e22a44e253a4ff065d 100644 (file)
@@ -3,9 +3,9 @@
 #ifndef ALIHLTTPCKRYPTONCLUSTERFINDERCOMPONENT_H
 #define ALIHLTTPCKRYPTONCLUSTERFINDERCOMPONENT_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   AliHLTTPCKryptonClusterFinderComponent.h
     @author Kenneth Aamodt, Kalliopi Kanaki
     @brief  The TPC krypton cluster finder component.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 
 class AliHLTTPCKryptonClusterFinder;
index 28146e2ccea707e2da50cc8373959c96b442429b..776f976b8a0f0b366f17eaf4a2d75461970b5428 100644 (file)
@@ -1,15 +1,13 @@
 // @(#) $Id$
 // Original: AliHLTLog.h,v 1.2 2004/06/11 16:06:33 loizides Exp $
 
+//* 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                               *
+
 #ifndef ALIHLTTPCLOG_H
 #define ALIHLTTPCLOG_H
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include <sstream>
 #include <iostream>
 #include "AliHLTLogging.h"
@@ -30,6 +28,8 @@ using namespace std;
  * \em Note: the old LOG and ENDLOG macros should be used any longer,
  * use the HLT logging macros or AliRoot logging macros instead. 
  * @see AliHLTLogging
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCLog  {
   public:
index ed3b4a3ed06a242fe5247f897b52b72bb705638e..8ffa9c0bd6bdceac166721bb65758b3f002552a4 100644 (file)
@@ -1,22 +1,22 @@
 // @(#) $Id$
 // Original: AliHLTMemHandler.cxx,v 1.52 2005/06/14 10:55:21 cvetan 
 
-/**************************************************************************
- * This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- *                                                                        *
- * Primary Authors: U. Frankenfeld, A. Vestbo, C. Loizides                *
- *                  Matthias Richter <Matthias.Richter@ift.uib.no>        *
- *                  for The ALICE HLT Project.                            *
- *                                                                        *
- * Permission to use, copy, modify and distribute this software and its   *
- * documentation strictly for non-commercial purposes is hereby granted   *
- * without fee, provided that the above copyright notice appears in all   *
- * copies and that both the copyright notice and this permission notice   *
- * appear in the supporting documentation. The authors make no claims     *
- * about the suitability of this software for any purpose. It is          *
- * provided "as is" without express or implied warranty.                  *
- **************************************************************************/
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: U. Frankenfeld, A. Vestbo, C. Loizides                *
+//*                  Matthias Richter <Matthias.Richter@ift.uib.no>        *
+//*                  for The ALICE HLT Project.                            *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
 
 /** @file   AliHLTTPCMemHandler.cxx
     @author U. Frankenfeld, A. Vestbo, C. Loizides, maintained by
     @date   
     @brief  input interface base class 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
-                                                                          */
-/** \class AliHLTTPCMemHandler 
-<pre>
-//_____________________________________________________________
-// AliHLTTPCMemHandler
-//
-// The HLT Binary File handler 
-//
-//  This class does all the memory I/O handling of HLT binary files.
-//  
-//  Examples:
-//  ---------
-//
-//  1) Reading a binary file:
-//  
-//  AliHLTTPCMemHandler file;
-//  file.SetBinaryInput(filename);
-//  file.Init(slice,patch);
-//
-//  UInt_t nrowss;
-//  AliHLTTPCDigitRowData *data = file.CompBinary2Memory(nrows);
-//  
-//  for(int i=0; i<nrows; i++) 
-//    {
-//    
-//    AliHLTTPCDigitData *dataPt = (AliHLTTPCDigitData*)data->fDigitData;
-//    for(int j=0; j<data->fNDigit; j++) 
-//      {
-//        pad = dataPt[j].fPad;
-//        time = dataPt[j].fTime;
-//        charge = dataPt[j].fCharge;
-//      }
-//     
-//    file.UpdateRowPointer(data);
-//  
-//    }
-//  file.CloseBinaryInput();
-//  ________________________
-//  
-//  2) Writing a binary file:
-//  
-//  //First of all you need to store the data in memory,
-//  //and have a pointer to it of type AliHLTTPCDigitRowData.
-//  //E.g. if you just want to write the data you read in example 1)
-//  //into a new file, you can do the following:
-//  
-//  AliHLTTPCMemHandler newfile;
-//  newfile.Init(slice,patch);
-//  newfile.SetBinaryOutput(newfilename);
-//  newfile.Memory2CompBinary((UInt_t)NumberOfRowsInPatch,(AliHLTTPCDigitRowData*)data);
-//  newfile.CloseBinaryOutput();
-//
-//
-// Compressed file format:
-// -----------------------
-//
-// The data is RLE encoded and currently using _10_ bit range for the ADC-values.
-</pre>
-*/  
 
 #include <cassert>
 #include "AliHLTTPCRootTypes.h"
index dcac7b0d80775ded3719dc33517582dfa2eb01cb..9c2ace4e9a5ada94697ff9d2042107174d4c095a 100644 (file)
@@ -2,9 +2,9 @@
 // Original: AliHLTMemHandler.h,v 1.30 2004/10/06 08:51:20 cvetan 
 #ifndef ALIHLTTPC_MEMHANDLER_H
 #define ALIHLTTPC_MEMHANDLER_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   AliHLTTPCMemHandler.h
     @author U. Frankenfeld, A. Vestbo, C. Loizides, maintained by
     @date   
     @brief  input interface base class 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
-                                                                          */
-//_____________________________________________________________
-// AliHLTTPCMemHandler
-//
-// The HLT Binary File handler 
-//
-//  This class does all the memory I/O handling of HLT binary files.
-//  
-// Author: Uli Frankenfeld <mailto:franken@fi.uib.no>, 
-//         Anders Vestbo <mailto:vestbo$fi.uib.no>, 
-//         Constantin Loizides <mailto:loizides@ikf.uni-frankfurt.de>
-// *-- Copyright &copy ALICE HLT Group 
+*/
 
 class AliHLTTPCDigitData;
 class AliHLTTPCSpacePointData;
@@ -43,6 +26,66 @@ class AliRunLoader;
 class AliRawEvent;
 #include "AliTPCRawStream.h"
 
+/**
+ * @class AliHLTTPCMemHandler
+ * The HLT Binary File handler 
+ *
+ * This class is the old memory I/O handler of HLT binary files.
+ * Some functionality is still used in the current code, mainly
+ * conversion of TPC digits into the format understandable by the
+ * components.
+ * <pre>
+ *  Examples:
+ *  ---------
+ *
+ *  1) Reading a binary file:
+ *  
+ *  AliHLTTPCMemHandler file;
+ *  file.SetBinaryInput(filename);
+ *  file.Init(slice,patch);
+ *
+ *  UInt_t nrowss;
+ *  AliHLTTPCDigitRowData *data = file.CompBinary2Memory(nrows);
+ *  
+ *  for(int i=0; i<nrows; i++) 
+ *    {
+ *    
+ *    AliHLTTPCDigitData *dataPt = (AliHLTTPCDigitData*)data->fDigitData;
+ *    for(int j=0; j<data->fNDigit; j++) 
+ *      {
+ *        pad = dataPt[j].fPad;
+ *        time = dataPt[j].fTime;
+ *        charge = dataPt[j].fCharge;
+ *      }
+ *     
+ *    file.UpdateRowPointer(data);
+ *  
+ *    }
+ *  file.CloseBinaryInput();
+ *  ________________________
+ *  
+ *  2) Writing a binary file:
+ *  
+ *  //First of all you need to store the data in memory,
+ *  //and have a pointer to it of type AliHLTTPCDigitRowData.
+ *  //E.g. if you just want to write the data you read in example 1)
+ *  //into a new file, you can do the following:
+ *  
+ *  AliHLTTPCMemHandler newfile;
+ *  newfile.Init(slice,patch);
+ *  newfile.SetBinaryOutput(newfilename);
+ *  newfile.Memory2CompBinary((UInt_t)NumberOfRowsInPatch,(AliHLTTPCDigitRowData*)data);
+ *  newfile.CloseBinaryOutput();
+ *
+ *
+ * Compressed file format:
+ * -----------------------
+ *
+ * The data is RLE encoded and currently using _10_ bit range for the ADC-values.
+ * </pre>
+ *  
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCMemHandler { 
 
  public:
index 4f9a92f3fb2e52c89b22156a6ac741c64c1f0986..41ec0b32c3564905c7a8bba0512ed49016eb3e8d 100644 (file)
@@ -2,8 +2,9 @@
 // Original: AliHLTMerger.h,v 1.8 2004/06/11 16:06:33 loizides 
 #ifndef ALIHLTTPCMERGER_H
 #define ALIHLTTPCMERGER_H
-/* Copyright(c) 1998-1999, 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   AliHLTTPCMerger.h
     @author Uli Frankenfeld, maintained by Matthias Richter
@@ -23,7 +24,9 @@ class AliHLTTPCTrackArray;
 /** 
  * @class AliHLTTPCMerger
  * The HLTTPC merger base class
-*/
+ *
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCMerger {
  public:
   AliHLTTPCMerger();
index a29691aa33393362b5f7bf0716065da982c6a332..5623a70e6d836fe32331bc4060e7eac761ddc1f5 100644 (file)
@@ -1,12 +1,21 @@
 // @(#) $Id$
 // Original: AliHLTModelTrack.h,v 1.13 2004/06/15 10:26:57 hristov 
 
+//* 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                               *
+
 #ifndef AliHLTTPCModel_Track
 #define AliHLTTPCModel_Track
 
 #include "AliHLTTPCTrack.h"
 #include "AliHLTTPCModels.h"
 
+/**
+ * @class AliHLTTPCModelTrack
+ *
+ * @ingroup alihlt_tpc
+ */
 class AliHLTTPCModelTrack : public AliHLTTPCTrack {
 
  public:
index 936ff66f2ba3ba6219eec7918b3ae85e02e933cf..8a4bd293095ba0b1750231ec3a3f6bef0330ca85 100644 (file)
     @brief  Component for Noise Map
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 
 //forward declarations
index 9faa35e7de01f70f105a7120b41973af221cdd90..2e89f7e192c96a5965d2ff0bd874458790b4e526 100644 (file)
@@ -3,9 +3,9 @@
 
 #ifndef ALIHLTTPCPAD_H
 #define ALIHLTTPCPAD_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   AliHLTTPCPad.h
     @author Matthias Richter
     @brief  Container Class for TPC Pads.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTLogging.h"
 #include "AliHLTTPCClusters.h"
 #include "TH1F.h"
index 7be86c50686d9baedfa77f1d21f28526dbde07cb..ec5c5c71eaf666f1f66ceac30dad81614b6cf55e 100644 (file)
@@ -3,14 +3,9 @@
 
 #ifndef ALIHLTTPCRAWDATAUNPACKERCOMPONENT_H
 #define ALIHLTTPCRAWDATAUNPACKERCOMPONENT_H
-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
- * See cxx source for full Copyright notice                               */
-
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+//* 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                               *
 
 #include "AliHLTProcessor.h"
 
@@ -20,6 +15,11 @@ class AliTPCRawStream;
 /**
  * @class AliHLTTPCRawDataUnpackerComponent
  * Unpacker component for TPC RAW data.
+ *
+ * @note Old remnant and never used in the new online interface. Became
+ *       obsolete with the introduction of DigitReaders. Maybe we want to
+ *       convert this component into a tool.
+ * @ingroup alihlt_tpc_components
  */
 class AliHLTTPCRawDataUnpackerComponent : public AliHLTProcessor
     {
index fcf59036d29d74f3dcfa673af4d7bcaa0da2c86c..2fccef4b90d097c8f915fd5d0b64039b3feb6b8f 100644 (file)
@@ -3,8 +3,9 @@
 
 #ifndef ALIHLTTPCSLICETRACKERCOMPONENT_H
 #define ALIHLTTPCSLICETRACKERCOMPONENT_H
-/* Copyright(c) 1998-1999, 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   AliHLTTPCSliceTrackerComponent.h
     @author Timm Steinbeck, Matthias Richter
     @brief  The TPC conformal mapping tracker component.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 
 class AliHLTTPCConfMapper;
index 8b6b1d0e254c4f4b993497bc40974d158a40ed29..7d6ac3ba92bfc2bf5beb5dbf92077ccfb5d6fe49 100644 (file)
@@ -5,6 +5,15 @@
 #define SPACEPOINTDATA_H
 
 #include "AliHLTTPCRootTypes.h"
+
+/**
+ * @struct AliHLTTPCSpacePointData
+ * Primitive data exchange structure for TPC clusters.
+ * Together with the AliHLTTPCClusterDataFormat this defines
+ * the output of the TPC online Cluster Finder.
+ *
+ * @ingroup alihlt_tpc_datastructs
+ */
 struct AliHLTTPCSpacePointData{
 #ifdef do_mc
   Int_t fTrackID[3];
index 4241012723e7fd47353b17e276d2272fe185f7b5..c9f23881d627256a1f948bbac16bc5a8272f060f 100644 (file)
@@ -5,8 +5,9 @@
 #ifndef ALIHLTTPCTRACK_H
 #define ALIHLTTPCTRACK_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCTrack.h
     @author Anders Vestbo, Uli Frankenfeld, maintained by Matthias Richter
@@ -26,6 +27,8 @@ class AliHLTTPCSpacePointData;
  * It was originally separated from the offline TPC track class, but in
  * order to adjust the output format to the offline ESD, AliHLTTPCTrack
  * now inherits from AliHLTtrack.
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCTrack : public AliTPCtrack {
 
index 1f6e65c7a9de59ec27f30bde9513720f3a5cd163..c0113202e4af80934994e03f115fb9012b5ef36b 100644 (file)
@@ -4,8 +4,9 @@
 #ifndef ALIHLTTPCTRACKARRAY_H
 #define ALIHLTTPCTRACKARRAY_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCTrackArray.h
     @author Uli Frankenfeld, maintained by Matthias Richter
@@ -23,6 +24,8 @@ class AliHLTTPCTrackSegmentData;
  * @class AliHLTTPCTrackArray
  * Array of AliHLTTrack objects.
  * The class implements a dynamic array and handler methods.
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCTrackArray {
  public:
index 9ffc2a5e282c6487bec82a5ecaf740cf50b63e9f..1a137a12f9fa26c8e471175217309280c96783c0 100644 (file)
@@ -3,8 +3,9 @@
 #ifndef ALIHLTTPCTRACKMERGER_H
 #define ALIHLTTPCTRACKMERGER_H
 
-/* Copyright(c) 1998-1999, 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   AliHLTTPCTrackMerger.h
     @author Uli Frankenfeld, maintained by Matthias Richter
@@ -26,6 +27,8 @@ class AliHLTTPCMerger;
  *
  *   This class is responsible for the merging of the HLT tracks
  *   between TPC sectors and readout patches
+ *
+ * @ingroup alihlt_tpc
  */
 class AliHLTTPCTrackMerger : public AliHLTTPCMerger {
 
index 87c610add63f18ca6517f875353bcba35b3636c9..a5872e0dccaaeeaecb1df38f8c55e02e82da97e3 100644 (file)
@@ -1,10 +1,21 @@
 // @(#) $Id$
 // Original: AliHLTTrackSegmentData.h,v 1.7 2005/03/31 04:48:59 cvetan 
+
+//* 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                               *
+
 #ifndef _ALIHLTTPCTRACKSEGMENTDATA_H_
 #define _ALIHLTTPCTRACKSEGMENTDATA_H_
 
 #include "AliHLTTPCRootTypes.h"
 
+/**
+ * @struct AliHLTTPCTrackSegmentData
+ * Primitive data exchange structure for TPC tracks.
+ *
+ * @ingroup alihlt_tpc_datastructs
+ */
 struct AliHLTTPCTrackSegmentData
     {
        Float_t fX;
index 17d4b5cbb1000a531974cd54aabc50dca25d57ea..3b695952653beedc06c185f0d38df4a476be4052 100644 (file)
@@ -1,15 +1,19 @@
 #ifndef _ALIHLTTPCTRACKLETFORMAT_HPP_
 #define _ALIHLTTPCTRACKLETFORMAT_HPP_
 
-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
- * See cxx source for full Copyright notice                               */
-
-/* AliHLTTPCTrackletData
- */
+//* 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                               *
 
 #include "AliHLTDataTypes.h"
 #include "AliHLTTPCTrackSegmentData.h"
 
+/**
+ * @struct AliHLTTPCTrackletData
+ * Primitive data exchange structure for TPC tracks.
+ *
+ * @ingroup alihlt_tpc_datastructs
+ */
 struct AliHLTTPCTrackletData
     {
        AliHLTUInt32_t fTrackletCnt;
index 8811608d5ec80020ea4a33be19b8288532a2d14f..0dffa84ba15c5bebe00d97b7ac26f574c9c9dac2 100644 (file)
@@ -72,6 +72,7 @@ using namespace std;
 //             fVersion==kVdeprecated: dont use old (before July 2003) style of transformer
 //
 </pre>
+* @ingroup alihlt_tpc
 */
 
 ClassImp(AliHLTTPCTransform)
index e6608dcb119f893fe7b6b814ed1ce1a74a723e5a..a0f2f1c11e2155e97a3a80a8e2ff6844f43eb151 100644 (file)
@@ -1,6 +1,10 @@
 // @(#) $Id$
 // Original: AliHLTTransform.h,v 1.37 2005/06/14 10:55:21 cvetan 
 
+//* 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                               *
+
 #ifndef ALIHLTTPCTRANSFORM_H
 #define ALIHLTTPCTRANSFORM_H
 
index 27cd823d351f2a07b1a994ae41eb17245be0cec6..ffd74abdf7348c461ff19f4a43718621dbc69f47 100755 (executable)
@@ -4,9 +4,9 @@
 #ifndef ALIHLTTPCZEROSUPPRESSIONCOMPONENT_H
 #define ALIHLTTPCZEROSUPPRESSIONCOMPONENT_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   AliHLTTPCZeroSuppressionComponent.h
     @author Kenneth Aamodt
     @brief  Component for ZeroSuppression
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 #include "AliHLTTPCPad.h"
 #include "AliHLTDataTypes.h"
@@ -46,7 +40,7 @@ class AliHLTTPCDigitReader;
  *
  * - sort-pads Flag to switch on pad sorting(needed by the SORTED clusterfinder)
  *
- * @ingroup alihlt_tpc
+ * @ingroup alihlt_tpc_components
  */
 class AliHLTTPCZeroSuppressionComponent : public AliHLTProcessor
     {
diff --git a/HLT/TPCLib/docalihlttpc.c b/HLT/TPCLib/docalihlttpc.c
new file mode 100644 (file)
index 0000000..fe0d5ac
--- /dev/null
@@ -0,0 +1,46 @@
+// $Id$
+/************************************************************************
+**
+** This file is property of and copyright by the ALICE HLT Project
+** ALICE Experiment at CERN, All rights reserved.
+**
+** This file is property of and copyright by the Experimental Nuclear 
+** Physics Group, Dep. of Physics and Technology
+** University of Bergen, Norway, 2004
+** This file has been written by Matthias Richter,
+** Matthias.Richter@ift.uib.no
+**
+** Permission to use, copy, modify and distribute this software and its  
+** documentation strictly for non-commercial purposes is hereby granted  
+** without fee, provided that the above copyright notice appears in all  
+** copies and that both the copyright notice and this permission notice  
+** appear in the supporting documentation. The authors make no claims    
+** about the suitability of this software for any purpose. It is         
+** provided "as is" without express or implied warranty.                 
+**
+*************************************************************************/
+
+/** @file   docalihlttpc.c
+    @author Matthias Richter
+    @date   
+    @brief  Library documentation for the libAliHLTTPC library.
+*/
+
+/** 
+@defgroup alihlt_tpc The libAliHLTTPC library
+*/
+
+/**
+@defgroup alihlt_tpc_components TPC HLT components
+@ingroup alihlt_tpc
+*/
+
+/**
+@defgroup alihlt_tpc_datastructs TPC components data exchange structures
+@ingroup alihlt_tpc
+*/
+
+#error Not for compilation
+//
+// EOF
+//
index a335d7e8bdd369f1a5ee7e73a74a3c590febcb96..52ace65d1ace6ff5023c3a3900f53305ccc444ef 100644 (file)
@@ -10,4 +10,6 @@ removed from the repository:
   the structure has been added to AliHLTTPCDigitData.h
 - AliHLTTPCDDLDataFileHandler.cxx/.h removed 17.10.2007
   the conversion class to old HLT binary formats, deprecated because of completely
-  new framework
\ No newline at end of file
+  new framework
+- AliHLTTPCBenchmark.h/.cxx removed 22.04.2008
+  old benchmark class
index a4e0db2c3cc1655f4a0a215cbe698ddcd4a51f1d..5829aa86c4d2ffb0ca7587bda0e722aaf6ea1d03 100644 (file)
@@ -7,7 +7,6 @@ CLASS_HDRS:=    AliHLTTPCTransform.h \
                AliHLTTPCDataCompressorHelper.h \
                AliHLTTPCFitter.h \
                AliHLTTPCFileHandler.h \
-               AliHLTTPCBenchmark.h \
                AliHLTTPCClusterFinder.h \
                AliHLTTPCMapping.h \
                AliHLTTPCDigitReader.h \