- all digit raw data structures added to AliHLTTPCDigitData.h

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

diff --git a/HLT/TPCLib/AliHLTTPCDigitData.h b/HLT/TPCLib/AliHLTTPCDigitData.h
index 0f2a99f90efbd334c47ff0b714a0676c2835b21c..1e6ba7b3b0e0b583ff7c1f9bc8208a1082fc92e0 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCDigitData.h
+++ b/HLT/TPCLib/AliHLTTPCDigitData.h
@@ -6,21 +6,33 @@
 
 #include "AliHLTTPCRootTypes.h" 
 
+/**
+ * @struct AliHLTTPCDigitData
+ * Raw data structure for one row of TPC data. A digit corresponds to one
+ * measured signal in 2 coordinates: pad and time <br>
+ * The hight of the signal is given by the charge. <br>
+ * This structure is only used while runnig HLT analysis in the offline
+ * framework. Thats why it comes with a MC track id by default.
+ *
+ * The exact meaning of the 3 track ID fields is currently not known to me.
+ * (Matthias 18.09.2007) 
+ * @ingroup alihlt-tpc-datastructs
+ */
 struct AliHLTTPCDigitData
 {
-#ifdef do_mc
-  Int_t fTrackID[3];
-#endif
   UShort_t fCharge;
-  UChar_t fPad;
+  UChar_t  fPad;
   UShort_t fTime;
-#ifdef IA64
-  UChar_t dummy1;
-  UChar_t dummy2;
-#endif
+  Int_t    fTrackID[3];
 };
 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
+ */
 struct AliHLTTPCDigitRowData
 {
   UInt_t fNDigit;
@@ -33,6 +45,16 @@ struct AliHLTTPCDigitRowData
 };
 typedef struct AliHLTTPCDigitRowData AliHLTTPCDigitRowData;
 
+/**
+ * @struct AliHLTTPCRandomDigitData
+ * Raw data structure for TPC data. A digit corresponds to one
+ * measured signal in r coordinates: row, pad and time <br>
+ * The hight of the signal is given by the charge. <br>
+ *
+ * The structure is not used for data exchange between components,
+ * it's here for legacy reasons.
+ * @ingroup alihlt-tpc-datastructs
+ */
 struct AliHLTTPCRandomDigitData{
   UChar_t fRow;
   UShort_t fCharge;
@@ -40,4 +62,20 @@ struct AliHLTTPCRandomDigitData{
   UShort_t fTime;
 };
 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
+ */
+struct AliHLTTPCUnpackedRawData
+{
+#ifndef __SUNPRO_CC
+  AliHLTTPCDigitRowData fDigits[];
+#else
+  AliHLTTPCDigitRowData fDigits[1];
+#endif
+};
+
 #endif /* _ALIHLTTPCDIGITDATA_H_ */