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

// XEmacs -*-C++-*-
// @(#) $Id$

#ifndef ALIHLTTPCDEFINITIONS_H
#define ALIHLTTPCDEFINITIONS_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                               *

#include "AliHLTDataTypes.h"
#include "Rtypes.h"

/**
 * @class AliHLTTPCDefinitions
 * Data type definitions for the libAliHLTTPC library.
 * 
 * @ingroup alihlt_tpc
 */
class AliHLTTPCDefinitions
{
public:

	static AliHLTUInt8_t GetMinSliceNr( const AliHLTComponentBlockData& block )
		{
		return (AliHLTUInt8_t)( (block.fSpecification & 0x00FF0000) >> 16 );
		}
	static AliHLTUInt8_t GetMinSliceNr( ULong_t spec )
		{
		return (AliHLTUInt8_t)( (spec & 0x00FF0000) >> 16 );
		}
	static AliHLTUInt8_t GetMaxSliceNr( const AliHLTComponentBlockData& block )
		{
		return (AliHLTUInt8_t)( (block.fSpecification & 0xFF000000) >> 24 );
		}
	static AliHLTUInt8_t GetMaxSliceNr( ULong_t spec )
		{
		return (AliHLTUInt8_t)( (spec & 0xFF000000) >> 24 );
		}
	static AliHLTUInt8_t GetMinPatchNr( const AliHLTComponentBlockData& block )
		{
		return (AliHLTUInt8_t)( (block.fSpecification & 0x000000FF) );
		}
	static AliHLTUInt8_t GetMinPatchNr( ULong_t spec )
		{
		return (AliHLTUInt8_t)( (spec & 0x000000FF) );
		}
	static AliHLTUInt8_t GetMaxPatchNr( const AliHLTComponentBlockData& block )
		{
		return (AliHLTUInt8_t)( (block.fSpecification & 0x0000FF00) >> 8 );
		}
	static AliHLTUInt8_t GetMaxPatchNr( ULong_t spec )
		{
		return (AliHLTUInt8_t)( (spec & 0x0000FF00) >> 8 );
		}
	
	static AliHLTUInt32_t EncodeDataSpecification( AliHLTUInt8_t minSliceNr, 
						AliHLTUInt8_t maxSliceNr,
						AliHLTUInt8_t minPatchNr,
						AliHLTUInt8_t maxPatchNr )
		{
		return ((maxSliceNr & 0xFF) << 24) | ((minSliceNr & 0xFF) << 16) | ((maxPatchNr & 0xFF) << 8) | ((minPatchNr & 0xFF));
		}
	
	/**
	 * Converts a slice and patch number to a DDL ID number for TPC.
	 * \param slice  The slice number in the range [0..35] (0..17 for A side and 18..35 for C side).
	 * \param patch  The patch number in the range [0..5].
	 * \returns the DDL ID number of TPC or -1 if the slice or patch was invalid.
	 * \note A side is in the -z axis direction (same side as the muon spectrometer)
	 *       and C side is in the +z axis direction.
	 */
	static AliHLTInt32_t SlicePatchToDDLId(AliHLTUInt8_t slice, AliHLTUInt8_t patch)
		{
		if (slice > 35 or patch > 5) return -1;
		return 768 + (patch > 1 ? 72 + 4*slice + patch - 2 : 2*slice + patch);
		}
		
	/**
	 * Converts a DDL ID number for the TPC to a slice and patch number.
	 * \param [in] ddlid  The DDL ID number to convert.
	 * \param [out] slice  The resultant slice number in the range [0..35].
	 * \param [out] patch  The resultant patch number in the range [0..5].
	 * \returns true if the DDL ID number was valid and slice and patch were set,
	 *     otherwise false for an invalid DDL ID.
	 */
	static bool DDLIdToSlicePatch(AliHLTInt32_t ddlid, AliHLTUInt8_t& slice, AliHLTUInt8_t& patch);

  /** DDL entropy encoded data */
  static const AliHLTComponentDataType fgkDDLEncodedEntropyRawDataType; // see above
  static const AliHLTComponentDataType& DDLEncodedEntropyRawDataType();
  /** packed RAW data */
  static const AliHLTComponentDataType fgkPackedRawDataType;            // see above
  static const AliHLTComponentDataType& PackedRawDataType();
  /** unpacked RAW data */
  static const AliHLTComponentDataType fgkUnpackedRawDataType;          // see above
  static const AliHLTComponentDataType& UnpackedRawDataType();
  /** cluster data */
  static const AliHLTComponentDataType fgkClustersDataType;             // see above
  static const AliHLTComponentDataType& ClustersDataType();
  /** raw cluster data (not transformed) */
  static const AliHLTComponentDataType fgkRawClustersDataType;          // see above
  static const AliHLTComponentDataType& RawClustersDataType();
  /** HW cluster data */
  static const AliHLTComponentDataType fgkHWClustersDataType;           // see above
  static const AliHLTComponentDataType& HWClustersDataType();
  /** HW alternative output cluster data */
  static const AliHLTComponentDataType fgkAlterClustersDataType;        // see above
  static const AliHLTComponentDataType& AlterClustersDataType();
  /** track segments in local coordinates */
  static const AliHLTComponentDataType fgkTrackSegmentsDataType;        // see above
  static const AliHLTComponentDataType& TrackSegmentsDataType();
  /** tracks in global koordinates */
  static const AliHLTComponentDataType fgkTracksDataType;               // see above
  static const AliHLTComponentDataType& TracksDataType();
  /** vertex data structure */
  static const AliHLTComponentDataType fgkVertexDataType;               // see above
  static const AliHLTComponentDataType& VertexDataType();

  // Cluster & Tracks model data
  /** cluster tracks model data type */
  static const AliHLTComponentDataType fgkClusterTracksModelDataType;          // see above
  static const AliHLTComponentDataType& ClusterTracksModelDataType();
  /** remaining clusters model data type */
  static const AliHLTComponentDataType fgkRemainingClustersModelDataType;      // see above
  static const AliHLTComponentDataType& RemainingClustersModelDataType();
  /** track clusters compressed data type */
  static const AliHLTComponentDataType fgkClusterTracksCompressedDataType;     // see above
  static const AliHLTComponentDataType& ClusterTracksCompressedDataType();
  /** track cluster ids data type */
  static const AliHLTComponentDataType& ClusterIdTracksDataType();
  /** remaining clusters compressed data type */
  static const AliHLTComponentDataType fgkRemainingClustersCompressedDataType; // see above
  static const AliHLTComponentDataType& RemainingClustersCompressedDataType();
  /** remaining clusters ids data type */
  static const AliHLTComponentDataType& RemainingClusterIdsDataType();

  // Calibration data
  /** pedestal calibration data */
  static const AliHLTComponentDataType& CalibPedestalDataType();
  /** signal calibration data */
  static const AliHLTComponentDataType& CalibPulserDataType();
  /** central electrode calibration data */
  static const AliHLTComponentDataType& CalibCEDataType();

  // offline calbration components

  /** alignment calibration data */
  static const AliHLTComponentDataType& OfflineCalibAlignDataType();
  /** track calibration data */
  static const AliHLTComponentDataType& OfflineCalibTracksDataType();
  /** gain calibration data */
  static const AliHLTComponentDataType& OfflineCalibTracksGainDataType();
  /** cluster monte carlo information */
  static const AliHLTComponentDataType fgkAliHLTDataTypeClusterMCInfo;    // see above
  static const AliHLTComponentDataType& AliHLTDataTypeClusterMCInfo();

  // ids for the different parameters of a cluster
  enum AliClusterParameterId_t {
    kPadRow = 0,
    kPad,
    kTime,
    kSigmaY2,
    kSigmaZ2,
    kCharge,
    kQMax,
    kResidualPad,
    kResidualTime,
    kClusterCount,
    kLast = kQMax
  };

  // helper struct for the definition of cluster parameters
  struct AliClusterParameter {
    AliClusterParameterId_t fId; //! id of the parameter
    const char* fName;           //! name of the parameter
    int fBitLength;              //! bit length
    int fOptional;               //! optional parameter
    int fScale;                  //! scale for conversion to int number
  };

  static const AliClusterParameter fgkClusterParameterDefinitions[];
  static unsigned GetNumberOfClusterParameterDefinitions();
  static const unsigned fgkMaxClusterDeltaPad;
  static unsigned GetMaxClusterDeltaPad() {return fgkMaxClusterDeltaPad;}
  static const unsigned fgkMaxClusterDeltaTime;
  static unsigned GetMaxClusterDeltaTime() {return fgkMaxClusterDeltaTime;}

private:

  /// Do not allow creation of this class since everything is static.
  AliHLTTPCDefinitions();
  virtual ~AliHLTTPCDefinitions();

  ClassDef(AliHLTTPCDefinitions, 0)  // Useful static definitions and methods for TPC
};

#endif
Commit	Line	Data
71d7c760	1	// XEmacs --C++--
	2	// @(#) $Id$
	3
	4	#ifndef ALIHLTTPCDEFINITIONS_H
	5	#define ALIHLTTPCDEFINITIONS_H
13398559	6	//* This file is property of and copyright by the ALICE HLT Project *
	7	//* ALICE Experiment at CERN, All rights reserved. *
	8	//* See cxx source for full Copyright notice *
71d7c760	9
71d7c760	10	#include "AliHLTDataTypes.h"
96bda103	11	#include "Rtypes.h"
71d7c760	12
13398559	13	/**
	14	* @class AliHLTTPCDefinitions
	15	* Data type definitions for the libAliHLTTPC library.
297174de	16	*
297174de	17	* @ingroup alihlt_tpc
13398559	18	*/
71d7c760	19	class AliHLTTPCDefinitions
96bda103	20	{
96bda103	21	public:
71d7c760	22
8ede8717	23	static AliHLTUInt8_t GetMinSliceNr( const AliHLTComponentBlockData& block )
71d7c760	24	{
	25	return (AliHLTUInt8_t)( (block.fSpecification & 0x00FF0000) >> 16 );
	26	}
a6c02c85	27	static AliHLTUInt8_t GetMinSliceNr( ULong_t spec )
	28	{
	29	return (AliHLTUInt8_t)( (spec & 0x00FF0000) >> 16 );
	30	}
8ede8717	31	static AliHLTUInt8_t GetMaxSliceNr( const AliHLTComponentBlockData& block )
71d7c760	32	{
	33	return (AliHLTUInt8_t)( (block.fSpecification & 0xFF000000) >> 24 );
	34	}
a6c02c85	35	static AliHLTUInt8_t GetMaxSliceNr( ULong_t spec )
	36	{
	37	return (AliHLTUInt8_t)( (spec & 0xFF000000) >> 24 );
	38	}
8ede8717	39	static AliHLTUInt8_t GetMinPatchNr( const AliHLTComponentBlockData& block )
71d7c760	40	{
	41	return (AliHLTUInt8_t)( (block.fSpecification & 0x000000FF) );
	42	}
a6c02c85	43	static AliHLTUInt8_t GetMinPatchNr( ULong_t spec )
	44	{
	45	return (AliHLTUInt8_t)( (spec & 0x000000FF) );
	46	}
8ede8717	47	static AliHLTUInt8_t GetMaxPatchNr( const AliHLTComponentBlockData& block )
71d7c760	48	{
	49	return (AliHLTUInt8_t)( (block.fSpecification & 0x0000FF00) >> 8 );
	50	}
a6c02c85	51	static AliHLTUInt8_t GetMaxPatchNr( ULong_t spec )
	52	{
	53	return (AliHLTUInt8_t)( (spec & 0x0000FF00) >> 8 );
	54	}
71d7c760	55
	56	static AliHLTUInt32_t EncodeDataSpecification( AliHLTUInt8_t minSliceNr,
	57	AliHLTUInt8_t maxSliceNr,
	58	AliHLTUInt8_t minPatchNr,
	59	AliHLTUInt8_t maxPatchNr )
	60	{
	61	return ((maxSliceNr & 0xFF) << 24) \| ((minSliceNr & 0xFF) << 16) \| ((maxPatchNr & 0xFF) << 8) \| ((minPatchNr & 0xFF));
	62	}
625b072f	63
	64	/**
	65	* Converts a slice and patch number to a DDL ID number for TPC.
	66	* \param slice The slice number in the range [0..35] (0..17 for A side and 18..35 for C side).
	67	* \param patch The patch number in the range [0..5].
	68	* \returns the DDL ID number of TPC or -1 if the slice or patch was invalid.
	69	* \note A side is in the -z axis direction (same side as the muon spectrometer)
	70	* and C side is in the +z axis direction.
	71	*/
	72	static AliHLTInt32_t SlicePatchToDDLId(AliHLTUInt8_t slice, AliHLTUInt8_t patch)
	73	{
	74	if (slice > 35 or patch > 5) return -1;
	75	return 768 + (patch > 1 ? 72 + 4slice + patch - 2 : 2slice + patch);
	76	}
	77
	78	/**
	79	* Converts a DDL ID number for the TPC to a slice and patch number.
f08578f1	80	* \param [in] ddlid The DDL ID number to convert.
	81	* \param [out] slice The resultant slice number in the range [0..35].
	82	* \param [out] patch The resultant patch number in the range [0..5].
625b072f	83	* \returns true if the DDL ID number was valid and slice and patch were set,
	84	* otherwise false for an invalid DDL ID.
	85	*/
	86	static bool DDLIdToSlicePatch(AliHLTInt32_t ddlid, AliHLTUInt8_t& slice, AliHLTUInt8_t& patch);
71d7c760	87
9ae1d7d8	88	/** DDL entropy encoded data */
9ae1d7d8	89	static const AliHLTComponentDataType fgkDDLEncodedEntropyRawDataType; // see above
4f82526d	90	static const AliHLTComponentDataType& DDLEncodedEntropyRawDataType();
96bda103	91	/** packed RAW data */
28355ac2	92	static const AliHLTComponentDataType fgkPackedRawDataType; // see above
4f82526d	93	static const AliHLTComponentDataType& PackedRawDataType();
96bda103	94	/** unpacked RAW data */
28355ac2	95	static const AliHLTComponentDataType fgkUnpackedRawDataType; // see above
4f82526d	96	static const AliHLTComponentDataType& UnpackedRawDataType();
96bda103	97	/** cluster data */
28355ac2	98	static const AliHLTComponentDataType fgkClustersDataType; // see above
4f82526d	99	static const AliHLTComponentDataType& ClustersDataType();
5e75f4e0	100	/** raw cluster data (not transformed) */
5e75f4e0	101	static const AliHLTComponentDataType fgkRawClustersDataType; // see above
4f82526d	102	static const AliHLTComponentDataType& RawClustersDataType();
6af4f584	103	/** HW cluster data */
6af4f584	104	static const AliHLTComponentDataType fgkHWClustersDataType; // see above
4f82526d	105	static const AliHLTComponentDataType& HWClustersDataType();
491d6af5	106	/** HW alternative output cluster data */
491d6af5	107	static const AliHLTComponentDataType fgkAlterClustersDataType; // see above
4f82526d	108	static const AliHLTComponentDataType& AlterClustersDataType();
96bda103	109	/** track segments in local coordinates */
28355ac2	110	static const AliHLTComponentDataType fgkTrackSegmentsDataType; // see above
4f82526d	111	static const AliHLTComponentDataType& TrackSegmentsDataType();
96bda103	112	/** tracks in global koordinates */
28355ac2	113	static const AliHLTComponentDataType fgkTracksDataType; // see above
4f82526d	114	static const AliHLTComponentDataType& TracksDataType();
96bda103	115	/** vertex data structure */
28355ac2	116	static const AliHLTComponentDataType fgkVertexDataType; // see above
4f82526d	117	static const AliHLTComponentDataType& VertexDataType();
ff2f0f94	118
	119	// Cluster & Tracks model data
	120	/** cluster tracks model data type */
28355ac2	121	static const AliHLTComponentDataType fgkClusterTracksModelDataType; // see above
4f82526d	122	static const AliHLTComponentDataType& ClusterTracksModelDataType();
ff2f0f94	123	/** remaining clusters model data type */
28355ac2	124	static const AliHLTComponentDataType fgkRemainingClustersModelDataType; // see above
4f82526d	125	static const AliHLTComponentDataType& RemainingClustersModelDataType();
29a647c6	126	/** track clusters compressed data type */
28355ac2	127	static const AliHLTComponentDataType fgkClusterTracksCompressedDataType; // see above
4f82526d	128	static const AliHLTComponentDataType& ClusterTracksCompressedDataType();
29a647c6	129	/** track cluster ids data type */
29a647c6	130	static const AliHLTComponentDataType& ClusterIdTracksDataType();
ff2f0f94	131	/** remaining clusters compressed data type */
ff2f0f94	132	static const AliHLTComponentDataType fgkRemainingClustersCompressedDataType; // see above
4f82526d	133	static const AliHLTComponentDataType& RemainingClustersCompressedDataType();
29a647c6	134	/** remaining clusters ids data type */
29a647c6	135	static const AliHLTComponentDataType& RemainingClusterIdsDataType();
ff2f0f94	136
ff2f0f94	137	// Calibration data
02d01bbf	138	/** pedestal calibration data */
d3dbc486	139	static const AliHLTComponentDataType& CalibPedestalDataType();
02d01bbf	140	/** signal calibration data */
d3dbc486	141	static const AliHLTComponentDataType& CalibPulserDataType();
28355ac2	142	/** central electrode calibration data */
d3dbc486	143	static const AliHLTComponentDataType& CalibCEDataType();
71d7c760	144
e642ae99	145	// offline calbration components
	146
	147	/** alignment calibration data */
d3dbc486	148	static const AliHLTComponentDataType& OfflineCalibAlignDataType();
e642ae99	149	/** track calibration data */
d3dbc486	150	static const AliHLTComponentDataType& OfflineCalibTracksDataType();
e642ae99	151	/** gain calibration data */
d3dbc486	152	static const AliHLTComponentDataType& OfflineCalibTracksGainDataType();
deba5d85	153	/** cluster monte carlo information */
deba5d85	154	static const AliHLTComponentDataType fgkAliHLTDataTypeClusterMCInfo; // see above
4f82526d	155	static const AliHLTComponentDataType& AliHLTDataTypeClusterMCInfo();
e642ae99	156
71300445	157	// ids for the different parameters of a cluster
	158	enum AliClusterParameterId_t {
	159	kPadRow = 0,
	160	kPad,
	161	kTime,
	162	kSigmaY2,
	163	kSigmaZ2,
	164	kCharge,
	165	kQMax,
b97434b7	166	kResidualPad,
b97434b7	167	kResidualTime,
b97434b7	168	kClusterCount,
71300445	169	kLast = kQMax
	170	};
	171
	172	// helper struct for the definition of cluster parameters
	173	struct AliClusterParameter {
	174	AliClusterParameterId_t fId; //! id of the parameter
	175	const char* fName; //! name of the parameter
	176	int fBitLength; //! bit length
	177	int fOptional; //! optional parameter
	178	int fScale; //! scale for conversion to int number
	179	};
	180
	181	static const AliClusterParameter fgkClusterParameterDefinitions[];
	182	static unsigned GetNumberOfClusterParameterDefinitions();
b97434b7	183	static const unsigned fgkMaxClusterDeltaPad;
	184	static unsigned GetMaxClusterDeltaPad() {return fgkMaxClusterDeltaPad;}
	185	static const unsigned fgkMaxClusterDeltaTime;
	186	static unsigned GetMaxClusterDeltaTime() {return fgkMaxClusterDeltaTime;}
71300445	187
625b072f	188	private:
	189
	190	/// Do not allow creation of this class since everything is static.
	191	AliHLTTPCDefinitions();
	192	virtual ~AliHLTTPCDefinitions();
	193
	194	ClassDef(AliHLTTPCDefinitions, 0) // Useful static definitions and methods for TPC
96bda103	195	};
71d7c760	196
71d7c760	197	#endif