From 297174de488a3c6a9f5c7f90778ce1e1e72a6a70 Mon Sep 17 00:00:00 2001 From: richterm Date: Tue, 22 Apr 2008 11:24:42 +0000 Subject: [PATCH] code documantation and minor cleanup --- HLT/BASE/AliHLTDataTypes.h | 2 +- HLT/RCU/AliHLTAltroEncoder.h | 34 ++- HLT/RCU/AliHLTAltroGenerator.cxx | 4 - HLT/RCU/AliHLTAltroGenerator.h | 14 ++ HLT/TPCLib/AliHLTTPCBenchmark.cxx | 195 ------------------ HLT/TPCLib/AliHLTTPCBenchmark.h | 59 ------ HLT/TPCLib/AliHLTTPCClusterDataFormat.h | 13 +- HLT/TPCLib/AliHLTTPCClusterFinder.cxx | 107 ++-------- HLT/TPCLib/AliHLTTPCClusterFinder.h | 101 +++++++-- .../AliHLTTPCClusterFinderComponent.cxx | 41 ++-- HLT/TPCLib/AliHLTTPCClusterFinderComponent.h | 14 +- HLT/TPCLib/AliHLTTPCConfMapFit.h | 12 +- HLT/TPCLib/AliHLTTPCConfMapPoint.h | 6 +- HLT/TPCLib/AliHLTTPCConfMapTrack.cxx | 33 ++- HLT/TPCLib/AliHLTTPCConfMapTrack.h | 10 +- HLT/TPCLib/AliHLTTPCConfMapper.h | 4 +- HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx | 17 +- HLT/TPCLib/AliHLTTPCDataCompressorHelper.h | 11 +- HLT/TPCLib/AliHLTTPCDefinitions.h | 2 + HLT/TPCLib/AliHLTTPCDigitData.h | 8 +- HLT/TPCLib/AliHLTTPCDigitDumpComponent.h | 12 +- HLT/TPCLib/AliHLTTPCDigitReader.h | 12 +- HLT/TPCLib/AliHLTTPCDigitReaderDecoder.h | 7 +- HLT/TPCLib/AliHLTTPCDigitReaderPacked.h | 1 + HLT/TPCLib/AliHLTTPCDigitReaderRaw.h | 8 +- HLT/TPCLib/AliHLTTPCDigitReaderUnpacked.h | 5 +- HLT/TPCLib/AliHLTTPCEsdWriterComponent.h | 13 +- HLT/TPCLib/AliHLTTPCFileHandler.h | 16 +- HLT/TPCLib/AliHLTTPCFitter.h | 7 +- HLT/TPCLib/AliHLTTPCGlobalMerger.h | 7 +- HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h | 11 +- HLT/TPCLib/AliHLTTPCInterMerger.h | 7 +- HLT/TPCLib/AliHLTTPCKryptonClusterFinder.cxx | 32 +-- HLT/TPCLib/AliHLTTPCKryptonClusterFinder.h | 18 +- .../AliHLTTPCKryptonClusterFinderComponent.h | 12 +- HLT/TPCLib/AliHLTTPCLog.h | 12 +- HLT/TPCLib/AliHLTTPCMemHandler.cxx | 97 ++------- HLT/TPCLib/AliHLTTPCMemHandler.h | 85 ++++++-- HLT/TPCLib/AliHLTTPCMerger.h | 9 +- HLT/TPCLib/AliHLTTPCModelTrack.h | 9 + HLT/TPCLib/AliHLTTPCNoiseMapComponent.h | 6 - HLT/TPCLib/AliHLTTPCPad.h | 12 +- .../AliHLTTPCRawDataUnpackerComponent.h | 16 +- HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h | 11 +- HLT/TPCLib/AliHLTTPCSpacePointData.h | 9 + HLT/TPCLib/AliHLTTPCTrack.h | 7 +- HLT/TPCLib/AliHLTTPCTrackArray.h | 7 +- HLT/TPCLib/AliHLTTPCTrackMerger.h | 7 +- HLT/TPCLib/AliHLTTPCTrackSegmentData.h | 11 + HLT/TPCLib/AliHLTTPCTrackletDataFormat.h | 14 +- HLT/TPCLib/AliHLTTPCTransform.cxx | 1 + HLT/TPCLib/AliHLTTPCTransform.h | 4 + .../AliHLTTPCZeroSuppressionComponent.h | 14 +- HLT/TPCLib/docalihlttpc.c | 46 +++++ HLT/TPCLib/legacy.txt | 4 +- HLT/libAliHLTTPC.pkg | 1 - 56 files changed, 527 insertions(+), 710 deletions(-) delete mode 100644 HLT/TPCLib/AliHLTTPCBenchmark.cxx delete mode 100644 HLT/TPCLib/AliHLTTPCBenchmark.h create mode 100644 HLT/TPCLib/docalihlttpc.c diff --git a/HLT/BASE/AliHLTDataTypes.h b/HLT/BASE/AliHLTDataTypes.h index 91c48d3a27f..b27e7c2b231 100644 --- a/HLT/BASE/AliHLTDataTypes.h +++ b/HLT/BASE/AliHLTDataTypes.h @@ -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 ) diff --git a/HLT/RCU/AliHLTAltroEncoder.h b/HLT/RCU/AliHLTAltroEncoder.h index 058080797fe..ed028a70b10 100644 --- a/HLT/RCU/AliHLTAltroEncoder.h +++ b/HLT/RCU/AliHLTAltroEncoder.h @@ -13,12 +13,6 @@ @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 @@ -31,9 +25,31 @@ * 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. + * + *
+ *  AliHLTAltroEncoder encoder;
+ *  encoder.SetBuffer(pBuffer, size);
+ * 
+ *  for (channel ...) {
+ *    int channelAddress=...;
+ *    ...
+ *    for (int bunch=0; bunch
+ * 
+ * @ingroup alihlt_rcu
  */
 class AliHLTAltroEncoder : AliHLTLogging {
  public:
diff --git a/HLT/RCU/AliHLTAltroGenerator.cxx b/HLT/RCU/AliHLTAltroGenerator.cxx
index 1f146c8b17c..3ccb9dbc0ed 100644
--- a/HLT/RCU/AliHLTAltroGenerator.cxx
+++ b/HLT/RCU/AliHLTAltroGenerator.cxx
@@ -345,7 +345,6 @@ int AliHLTAltroGenerator::EncodeData(AliHLTUInt8_t* pBuffer, int size)
       int time=startTime;
       for (; timeAt(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;
diff --git a/HLT/RCU/AliHLTAltroGenerator.h b/HLT/RCU/AliHLTAltroGenerator.h
index e34599b376d..7af0c3f1a15 100644
--- a/HLT/RCU/AliHLTAltroGenerator.h
+++ b/HLT/RCU/AliHLTAltroGenerator.h
@@ -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
index 1175466f2ad..00000000000
--- a/HLT/TPCLib/AliHLTTPCBenchmark.cxx
+++ /dev/null
@@ -1,195 +0,0 @@
-// @(#) $Id$
-
-// Author: Uli Frankenfeld 
-//*-- Copyright © ALICE HLT Group
-
-/** \class AliHLTTPCBenchmark
-
-//_____________________________________________________________
-//
-// AliHLTTPCBenchmark
-//
-//   Benchmark class for level3 code
-//  
-//
-
-*/ - -#ifndef no_root -#include -#include -#include -#include -#include -#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=0) { - // Resume the existent benchmark - fTimer[bench].Reset(); - fTimer[bench].Start(); - } - else - LOG(AliHLTTPCLog::kWarning,"AliHLTTPCBenchmark::Start","Start") - <<"too many benches"<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;iSetTitle("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 index 26136cea1c7..00000000000 --- a/HLT/TPCLib/AliHLTTPCBenchmark.h +++ /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 diff --git a/HLT/TPCLib/AliHLTTPCClusterDataFormat.h b/HLT/TPCLib/AliHLTTPCClusterDataFormat.h index 1067702e0dc..27ec01d3fac 100644 --- a/HLT/TPCLib/AliHLTTPCClusterDataFormat.h +++ b/HLT/TPCLib/AliHLTTPCClusterDataFormat.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCClusterFinder.cxx b/HLT/TPCLib/AliHLTTPCClusterFinder.cxx index 6f73426afb6..d0747493a9f 100644 --- a/HLT/TPCLib/AliHLTTPCClusterFinder.cxx +++ b/HLT/TPCLib/AliHLTTPCClusterFinder.cxx @@ -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 * +//* 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 @@ -38,81 +40,6 @@ 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() diff --git a/HLT/TPCLib/AliHLTTPCClusterFinder.h b/HLT/TPCLib/AliHLTTPCClusterFinder.h index 69afcd8f774..09c7096dd3d 100644 --- a/HLT/TPCLib/AliHLTTPCClusterFinder.h +++ b/HLT/TPCLib/AliHLTTPCClusterFinder.h @@ -3,29 +3,102 @@ #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 + +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: + * + *
+ * 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;
+ *   }
+ * }
+ * 
+ * @ingroup alihlt_tpc + */ class AliHLTTPCClusterFinder : public AliHLTLogging { public: diff --git a/HLT/TPCLib/AliHLTTPCClusterFinderComponent.cxx b/HLT/TPCLib/AliHLTTPCClusterFinderComponent.cxx index 486a38c4536..97285060e59 100644 --- a/HLT/TPCLib/AliHLTTPCClusterFinderComponent.cxx +++ b/HLT/TPCLib/AliHLTTPCClusterFinderComponent.cxx @@ -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 * - * Timm Steinbeck * - * Jochen Thaeder * - * 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 * +//* 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 @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 diff --git a/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h b/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h index 9e35c70fc68..5444088a3fe 100644 --- a/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h +++ b/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h @@ -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; diff --git a/HLT/TPCLib/AliHLTTPCConfMapFit.h b/HLT/TPCLib/AliHLTTPCConfMapFit.h index 5a188aeeb99..a2422152d6e 100644 --- a/HLT/TPCLib/AliHLTTPCConfMapFit.h +++ b/HLT/TPCLib/AliHLTTPCConfMapFit.h @@ -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 @@ -13,12 +14,6 @@ @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 { diff --git a/HLT/TPCLib/AliHLTTPCConfMapPoint.h b/HLT/TPCLib/AliHLTTPCConfMapPoint.h index d030576a639..b89b67b15c4 100644 --- a/HLT/TPCLib/AliHLTTPCConfMapPoint.h +++ b/HLT/TPCLib/AliHLTTPCConfMapPoint.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCConfMapTrack.cxx b/HLT/TPCLib/AliHLTTPCConfMapTrack.cxx index 0e2f27341a2..7e413b7b30e 100644 --- a/HLT/TPCLib/AliHLTTPCConfMapTrack.cxx +++ b/HLT/TPCLib/AliHLTTPCConfMapTrack.cxx @@ -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 * - * 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 * +//* 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; diff --git a/HLT/TPCLib/AliHLTTPCConfMapTrack.h b/HLT/TPCLib/AliHLTTPCConfMapTrack.h index 90c1f18d61c..9779f213b97 100644 --- a/HLT/TPCLib/AliHLTTPCConfMapTrack.h +++ b/HLT/TPCLib/AliHLTTPCConfMapTrack.h @@ -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 @@ -13,11 +14,7 @@ @brief Track class for conformal mapper */ -#include - #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 { diff --git a/HLT/TPCLib/AliHLTTPCConfMapper.h b/HLT/TPCLib/AliHLTTPCConfMapper.h index 72ccacd45a7..cd19364506a 100644 --- a/HLT/TPCLib/AliHLTTPCConfMapper.h +++ b/HLT/TPCLib/AliHLTTPCConfMapper.h @@ -14,8 +14,8 @@ */ #include +#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 { diff --git a/HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx b/HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx index b54cfb7c5f5..708bf9840c5 100644 --- a/HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx +++ b/HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx @@ -1,8 +1,21 @@ // @(#) $Id$ // Original: AliHLTDataCompressorHelper.cxx,v 1.5 2004/06/15 10:26:57 hristov Exp $ -// Author: Anders Vestbo -//*-- Copyright © 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" diff --git a/HLT/TPCLib/AliHLTTPCDataCompressorHelper.h b/HLT/TPCLib/AliHLTTPCDataCompressorHelper.h index d079a3b7cee..f7e0a0caafc 100644 --- a/HLT/TPCLib/AliHLTTPCDataCompressorHelper.h +++ b/HLT/TPCLib/AliHLTTPCDataCompressorHelper.h @@ -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: diff --git a/HLT/TPCLib/AliHLTTPCDefinitions.h b/HLT/TPCLib/AliHLTTPCDefinitions.h index 0e128c984ee..a013181eb75 100644 --- a/HLT/TPCLib/AliHLTTPCDefinitions.h +++ b/HLT/TPCLib/AliHLTTPCDefinitions.h @@ -13,6 +13,8 @@ /** * @class AliHLTTPCDefinitions * Data type definitions for the libAliHLTTPC library. + * + * @ingroup alihlt_tpc */ class AliHLTTPCDefinitions { diff --git a/HLT/TPCLib/AliHLTTPCDigitData.h b/HLT/TPCLib/AliHLTTPCDigitData.h index 1e6ba7b3b0e..6a53188f244 100644 --- a/HLT/TPCLib/AliHLTTPCDigitData.h +++ b/HLT/TPCLib/AliHLTTPCDigitData.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h b/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h index 6236d93f874..1d4f9126b5e 100644 --- a/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h +++ b/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h @@ -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 @@ -13,12 +13,6 @@ @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" /** diff --git a/HLT/TPCLib/AliHLTTPCDigitReader.h b/HLT/TPCLib/AliHLTTPCDigitReader.h index 1a1e809d00e..40231869541 100644 --- a/HLT/TPCLib/AliHLTTPCDigitReader.h +++ b/HLT/TPCLib/AliHLTTPCDigitReader.h @@ -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 @@ -14,12 +14,6 @@ @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" diff --git a/HLT/TPCLib/AliHLTTPCDigitReaderDecoder.h b/HLT/TPCLib/AliHLTTPCDigitReaderDecoder.h index 1a47f86b8cc..9148e96506f 100644 --- a/HLT/TPCLib/AliHLTTPCDigitReaderDecoder.h +++ b/HLT/TPCLib/AliHLTTPCDigitReaderDecoder.h @@ -14,12 +14,6 @@ @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 { diff --git a/HLT/TPCLib/AliHLTTPCDigitReaderPacked.h b/HLT/TPCLib/AliHLTTPCDigitReaderPacked.h index 54587de2303..3806a1ce730 100644 --- a/HLT/TPCLib/AliHLTTPCDigitReaderPacked.h +++ b/HLT/TPCLib/AliHLTTPCDigitReaderPacked.h @@ -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 kTRUE. + * * @ingroup alihlt_tpc */ class AliHLTTPCDigitReaderPacked : public AliHLTTPCDigitReader{ diff --git a/HLT/TPCLib/AliHLTTPCDigitReaderRaw.h b/HLT/TPCLib/AliHLTTPCDigitReaderRaw.h index db881be8aff..311bc73558b 100644 --- a/HLT/TPCLib/AliHLTTPCDigitReaderRaw.h +++ b/HLT/TPCLib/AliHLTTPCDigitReaderRaw.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCDigitReaderUnpacked.h b/HLT/TPCLib/AliHLTTPCDigitReaderUnpacked.h index f71824131d1..138df29cb3c 100644 --- a/HLT/TPCLib/AliHLTTPCDigitReaderUnpacked.h +++ b/HLT/TPCLib/AliHLTTPCDigitReaderUnpacked.h @@ -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 diff --git a/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h b/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h index ee58b938c93..e2540760e2f 100644 --- a/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h +++ b/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h @@ -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" diff --git a/HLT/TPCLib/AliHLTTPCFileHandler.h b/HLT/TPCLib/AliHLTTPCFileHandler.h index 9ec32d3a38f..fc61790814a 100644 --- a/HLT/TPCLib/AliHLTTPCFileHandler.h +++ b/HLT/TPCLib/AliHLTTPCFileHandler.h @@ -3,9 +3,9 @@ #ifndef ALIHLTTPCFILEHANDLER_H #define ALIHLTTPCFILEHANDLER_H -/* This file is property of and copyright by the ALICE HLT Project * - * ALICE Experiment at CERN, All rights reserved. * - * See cxx source for full Copyright notice */ +//* This file is property of and copyright by the ALICE HLT Project * +//* ALICE Experiment at CERN, All rights reserved. * +//* See cxx source for full Copyright notice * /** @file AliHLTTPCFileHandler.h @author U. Frankenfeld, A. Vestbo, C. Loizides, maintained by @@ -13,13 +13,8 @@ @date @brief file input for the TPC tracking code before migration to the HLT component framework +*/ -// see below for class documentation -// or -// refer to README to build package -// or -// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt - */ #include "AliHLTTPCMemHandler.h" class TClonesArray; @@ -38,10 +33,11 @@ class AliHLTTPCTrackSegmentData; class AliHLTTPCTrackArray; /** - * class AliHLTTPCFileHandler + * @class AliHLTTPCFileHandler * This is the input interface class for the TPC tracking code before conversion to * the HLT component framework. * + * @ingroup alihlt_tpc */ class AliHLTTPCFileHandler:public AliHLTTPCMemHandler { diff --git a/HLT/TPCLib/AliHLTTPCFitter.h b/HLT/TPCLib/AliHLTTPCFitter.h index 79d90e1c5b0..12df2a3be20 100644 --- a/HLT/TPCLib/AliHLTTPCFitter.h +++ b/HLT/TPCLib/AliHLTTPCFitter.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCGlobalMerger.h b/HLT/TPCLib/AliHLTTPCGlobalMerger.h index bca7c38a48e..84dfdbd7aec 100644 --- a/HLT/TPCLib/AliHLTTPCGlobalMerger.h +++ b/HLT/TPCLib/AliHLTTPCGlobalMerger.h @@ -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{ diff --git a/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h b/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h index 77ef16f4055..1b4651195e0 100644 --- a/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h +++ b/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h @@ -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 @@ -12,12 +13,6 @@ @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; diff --git a/HLT/TPCLib/AliHLTTPCInterMerger.h b/HLT/TPCLib/AliHLTTPCInterMerger.h index 7e5b98b4acd..acc1105bafa 100644 --- a/HLT/TPCLib/AliHLTTPCInterMerger.h +++ b/HLT/TPCLib/AliHLTTPCInterMerger.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.cxx b/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.cxx index 32a321b963f..2c375cd51fc 100644 --- a/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.cxx +++ b/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.cxx @@ -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 * - * 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 * +//* 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 diff --git a/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.h b/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.h index 4038706cd48..4dc0d5480fb 100644 --- a/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.h +++ b/HLT/TPCLib/AliHLTTPCKryptonClusterFinder.h @@ -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 @@ -12,13 +12,6 @@ @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" @@ -29,6 +22,11 @@ class AliHLTTPCSpacePointData; class AliHLTTPCDigitReader; +/** + * @class AliHLTTPCKryptonClusterFinder + * + * @ingroup alihlt_tpc + */ class AliHLTTPCKryptonClusterFinder : public AliHLTTPCClusterFinder { public: diff --git a/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h b/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h index 8abb5cf8efe..882547da6dc 100644 --- a/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h +++ b/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h @@ -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 @@ -13,12 +13,6 @@ @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; diff --git a/HLT/TPCLib/AliHLTTPCLog.h b/HLT/TPCLib/AliHLTTPCLog.h index 28146e2ccea..776f976b8a0 100644 --- a/HLT/TPCLib/AliHLTTPCLog.h +++ b/HLT/TPCLib/AliHLTTPCLog.h @@ -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 #include #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: diff --git a/HLT/TPCLib/AliHLTTPCMemHandler.cxx b/HLT/TPCLib/AliHLTTPCMemHandler.cxx index ed3b4a3ed06..8ffa9c0bd6b 100644 --- a/HLT/TPCLib/AliHLTTPCMemHandler.cxx +++ b/HLT/TPCLib/AliHLTTPCMemHandler.cxx @@ -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 * - * 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 * +//* 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 @@ -24,71 +24,8 @@ @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 -
-//_____________________________________________________________
-// 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; ifDigitData;
-//    for(int j=0; jfNDigit; 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.
-
-*/ #include #include "AliHLTTPCRootTypes.h" diff --git a/HLT/TPCLib/AliHLTTPCMemHandler.h b/HLT/TPCLib/AliHLTTPCMemHandler.h index dcac7b0d807..9c2ace4e9a5 100644 --- a/HLT/TPCLib/AliHLTTPCMemHandler.h +++ b/HLT/TPCLib/AliHLTTPCMemHandler.h @@ -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 @@ -12,24 +12,7 @@ @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 , -// Anders Vestbo , -// Constantin Loizides -// *-- Copyright © 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. + *
+ *  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; ifDigitData;
+ *    for(int j=0; jfNDigit; 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.
+ * 
+ * + * @ingroup alihlt_tpc + */ class AliHLTTPCMemHandler { public: diff --git a/HLT/TPCLib/AliHLTTPCMerger.h b/HLT/TPCLib/AliHLTTPCMerger.h index 4f9a92f3fb2..41ec0b32c35 100644 --- a/HLT/TPCLib/AliHLTTPCMerger.h +++ b/HLT/TPCLib/AliHLTTPCMerger.h @@ -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(); diff --git a/HLT/TPCLib/AliHLTTPCModelTrack.h b/HLT/TPCLib/AliHLTTPCModelTrack.h index a29691aa333..5623a70e6d8 100644 --- a/HLT/TPCLib/AliHLTTPCModelTrack.h +++ b/HLT/TPCLib/AliHLTTPCModelTrack.h @@ -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: diff --git a/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h b/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h index 936ff66f2ba..8a4bd293095 100644 --- a/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h +++ b/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h @@ -14,12 +14,6 @@ @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 diff --git a/HLT/TPCLib/AliHLTTPCPad.h b/HLT/TPCLib/AliHLTTPCPad.h index 9faa35e7de0..2e89f7e192c 100644 --- a/HLT/TPCLib/AliHLTTPCPad.h +++ b/HLT/TPCLib/AliHLTTPCPad.h @@ -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 @@ -13,12 +13,6 @@ @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" diff --git a/HLT/TPCLib/AliHLTTPCRawDataUnpackerComponent.h b/HLT/TPCLib/AliHLTTPCRawDataUnpackerComponent.h index 7be86c50686..ec5c5c71eaf 100644 --- a/HLT/TPCLib/AliHLTTPCRawDataUnpackerComponent.h +++ b/HLT/TPCLib/AliHLTTPCRawDataUnpackerComponent.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h b/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h index fcf59036d29..2fccef4b90d 100644 --- a/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h +++ b/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h @@ -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 @@ -12,12 +13,6 @@ @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; diff --git a/HLT/TPCLib/AliHLTTPCSpacePointData.h b/HLT/TPCLib/AliHLTTPCSpacePointData.h index 8b6b1d0e254..7d6ac3ba92b 100644 --- a/HLT/TPCLib/AliHLTTPCSpacePointData.h +++ b/HLT/TPCLib/AliHLTTPCSpacePointData.h @@ -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]; diff --git a/HLT/TPCLib/AliHLTTPCTrack.h b/HLT/TPCLib/AliHLTTPCTrack.h index 4241012723e..c9f23881d62 100644 --- a/HLT/TPCLib/AliHLTTPCTrack.h +++ b/HLT/TPCLib/AliHLTTPCTrack.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCTrackArray.h b/HLT/TPCLib/AliHLTTPCTrackArray.h index 1f6e65c7a9d..c0113202e4a 100644 --- a/HLT/TPCLib/AliHLTTPCTrackArray.h +++ b/HLT/TPCLib/AliHLTTPCTrackArray.h @@ -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: diff --git a/HLT/TPCLib/AliHLTTPCTrackMerger.h b/HLT/TPCLib/AliHLTTPCTrackMerger.h index 9ffc2a5e282..1a137a12f9f 100644 --- a/HLT/TPCLib/AliHLTTPCTrackMerger.h +++ b/HLT/TPCLib/AliHLTTPCTrackMerger.h @@ -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 { diff --git a/HLT/TPCLib/AliHLTTPCTrackSegmentData.h b/HLT/TPCLib/AliHLTTPCTrackSegmentData.h index 87c610add63..a5872e0dcca 100644 --- a/HLT/TPCLib/AliHLTTPCTrackSegmentData.h +++ b/HLT/TPCLib/AliHLTTPCTrackSegmentData.h @@ -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; diff --git a/HLT/TPCLib/AliHLTTPCTrackletDataFormat.h b/HLT/TPCLib/AliHLTTPCTrackletDataFormat.h index 17d4b5cbb10..3b695952653 100644 --- a/HLT/TPCLib/AliHLTTPCTrackletDataFormat.h +++ b/HLT/TPCLib/AliHLTTPCTrackletDataFormat.h @@ -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; diff --git a/HLT/TPCLib/AliHLTTPCTransform.cxx b/HLT/TPCLib/AliHLTTPCTransform.cxx index 8811608d5ec..0dffa84ba15 100644 --- a/HLT/TPCLib/AliHLTTPCTransform.cxx +++ b/HLT/TPCLib/AliHLTTPCTransform.cxx @@ -72,6 +72,7 @@ using namespace std; // fVersion==kVdeprecated: dont use old (before July 2003) style of transformer //
+* @ingroup alihlt_tpc */ ClassImp(AliHLTTPCTransform) diff --git a/HLT/TPCLib/AliHLTTPCTransform.h b/HLT/TPCLib/AliHLTTPCTransform.h index e6608dcb119..a0f2f1c11e2 100644 --- a/HLT/TPCLib/AliHLTTPCTransform.h +++ b/HLT/TPCLib/AliHLTTPCTransform.h @@ -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 diff --git a/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h b/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h index 27cd823d351..ffd74abdf73 100755 --- a/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h +++ b/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h @@ -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 @@ -14,12 +14,6 @@ @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 index 00000000000..fe0d5ac1cda --- /dev/null +++ b/HLT/TPCLib/docalihlttpc.c @@ -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 +// diff --git a/HLT/TPCLib/legacy.txt b/HLT/TPCLib/legacy.txt index a335d7e8bdd..52ace65d1ac 100644 --- a/HLT/TPCLib/legacy.txt +++ b/HLT/TPCLib/legacy.txt @@ -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 diff --git a/HLT/libAliHLTTPC.pkg b/HLT/libAliHLTTPC.pkg index a4e0db2c3cc..5829aa86c4d 100644 --- a/HLT/libAliHLTTPC.pkg +++ b/HLT/libAliHLTTPC.pkg @@ -7,7 +7,6 @@ CLASS_HDRS:= AliHLTTPCTransform.h \ AliHLTTPCDataCompressorHelper.h \ AliHLTTPCFitter.h \ AliHLTTPCFileHandler.h \ - AliHLTTPCBenchmark.h \ AliHLTTPCClusterFinder.h \ AliHLTTPCMapping.h \ AliHLTTPCDigitReader.h \ -- 2.43.0