- fixing protection against writing outside of buffer
[u/mrichter/AliRoot.git] / HLT / CALO / AliHLTCaloClusterizer.h
CommitLineData
ef44ec64 1//-*- Mode: C++ -*-\r
2// $Id$\r
3\r
4/**************************************************************************\r
5 * This file is property of and copyright by the ALICE HLT Project * \r
6 * All rights reserved. *\r
7 * *\r
8 * Primary Authors: Oystein Djuvsland *\r
9 * *\r
10 * Permission to use, copy, modify and distribute this software and its *\r
11 * documentation strictly for non-commercial purposes is hereby granted *\r
12 * without fee, provided that the above copyright notice appears in all *\r
13 * copies and that both the copyright notice and this permission notice *\r
14 * appear in the supporting documentation. The authors make no claims *\r
15 * about the suitability of this software for any purpose. It is * \r
16 * provided "as is" without express or implied warranty. *\r
17 **************************************************************************/\r
18\r
19#ifndef ALIHLTCALOCLUSTERIZER_H\r
20#define ALIHLTCALOCLUSTERIZER_H\r
21\r
22\r
23/**\r
24 * Class does clusterization in for Calorimeters on an event basis. It is intended \r
25 * for use in HLT, but can also be used offline\r
26 *\r
27 * @file AliHLTCaloClusterizer.h\r
28 * @author Oystein Djuvsland\r
29 * @date\r
30 * @brief Clusterizer for CALO HLT\r
31 */\r
32\r
33// see header file for class documentation\r
34// or\r
35// refer to README to build package\r
36// or\r
37// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt\r
38\r
39//#include "AliHLTCaloBase.h"\r
40\r
41#include "AliHLTCaloRecPointContainerStruct.h"\r
42#include "AliHLTCaloRecPointDataStruct.h"\r
43#include "AliHLTCaloDigitContainerDataStruct.h"\r
44#include "AliHLTCaloDigitDataStruct.h"\r
ef44ec64 45#include "TString.h"\r
4f4b7ba4 46#include "AliHLTCaloConstantsHandler.h"\r
ef44ec64 47\r
48//#include "AliPHOSGeometry.h"\r
9bd6f29b 49#include "AliHLTLogging.h"\r
ef44ec64 50\r
51class TClonesArray;\r
ad44d760 52class TString;\r
ef44ec64 53//class AliPHOSDigit;\r
54//class AliPHOSRecoParamEmc;\r
55//class AliPHOSRecoParam;\r
56\r
57/** \r
58 * @class AliHLTCaloClusterizer\r
59 * Clusterizer for CALO HLT. The clusterizer takes digits as input, either\r
60 * in the form of a container of AliHLTCaloDigitDataStruct or a\r
61 * TClonesArray of AliPHOSDigit through an instance of a AliPHOSLoader\r
62 *\r
63 * @ingroup alihlt_calo\r
64 */\r
ef44ec64 65\r
66\r
9bd6f29b 67class AliHLTCaloClusterizer : public AliHLTCaloConstantsHandler, public AliHLTLogging\r
ef44ec64 68{\r
69 \r
70public:\r
71 \r
72 /** Constructor */\r
73 AliHLTCaloClusterizer(TString det); \r
341aab10 74\r
ef44ec64 75 /** Destructor */\r
76 virtual ~AliHLTCaloClusterizer();\r
ef44ec64 77 \r
ef44ec64 78 /** Set digit container */\r
79 void SetDigitContainer(AliHLTCaloDigitContainerDataStruct* digitContainerPtr)\r
80 { fDigitContainerPtr = digitContainerPtr; }\r
81\r
ad44d760 82 /** Set array with digits */\r
83 void SetDigitArray(AliHLTCaloDigitDataStruct **digitPointerArr)\r
84 { fDigitsPointerArray = digitPointerArr; } \r
85\r
ef44ec64 86 /** Set rec point data buffer */\r
87 void SetRecPointDataPtr(AliHLTCaloRecPointDataStruct* recPointDataPtr);\r
88\r
89 /** Set reco parameters */\r
90 // void SetRecoParameters(AliPHOSRecoParam* recoPars);\r
91\r
92 /** Set emc clustering threshold */\r
93 void SetEmcClusteringThreshold(Float_t threshold) { fEmcClusteringThreshold = threshold; }\r
94\r
95 /** Set emc min energy threshold */\r
96 void SetEmcMinEnergyThreshold(Float_t threshold) { fEmcMinEnergyThreshold = threshold; }\r
97\r
98 /** Set emc time gate */\r
99 void SetEmcTimeGate(Float_t gate) { fEmcTimeGate = gate; }\r
100 \r
101 /** Starts clusterization of the event */ \r
ad44d760 102 virtual Int_t ClusterizeEvent(Int_t nDigits, UInt_t availableSize, UInt_t& totSize);\r
ef44ec64 103 \r
104 /**\r
105 * For a given digit this digit scans for neighbouring digits which \r
106 * passes the threshold for inclusion in a rec point. If one is found \r
107 * it is added to the current rec point\r
108 * @param digIndex index of the digit in the digit container\r
109 * @param recPoint pointer to the current rec point\r
110 */\r
9bd6f29b 111 virtual Int_t ScanForNeighbourDigits(Int_t digIndex, AliHLTCaloRecPointDataStruct* recPoint);\r
ef44ec64 112\r
113 /**\r
114 * Checks if two digits are neighbours\r
115 * @param d1 first digit\r
116 * @param d2 second digit\r
117 */\r
118 virtual Int_t AreNeighbours(AliHLTCaloDigitDataStruct* d1, AliHLTCaloDigitDataStruct* d2);\r
119\r
120\r
121protected:\r
122\r
123 /** Pointer to the rec point output */\r
ad44d760 124 AliHLTCaloRecPointDataStruct *fRecPointDataPtr; //! transient\r
ef44ec64 125\r
ad44d760 126 /** Pointer to the digit index array in the rec point */\r
127 Int_t* fDigitIndexPtr; //! transient\r
ef44ec64 128\r
129 /** Energy threshold for starting a cluster for the calorimeter */\r
130 Float_t fEmcClusteringThreshold; //COMMENT\r
131\r
132 /** Energy threshold for including a crystal in a cluster */\r
133 Float_t fEmcMinEnergyThreshold; //COMMENT\r
134\r
135 /** Maximum time difference for inclusion in a rec point */\r
136 Float_t fEmcTimeGate; //COMMENT\r
137\r
138 /** Counts the digits in a rec point */\r
139 Int_t fDigitsInCluster; //COMMENT\r
140\r
ad44d760 141 /** Array of our digits */\r
142 AliHLTCaloDigitDataStruct **fDigitsPointerArray; //! transient\r
143\r
ef44ec64 144 /** Contains the digits from one event */\r
145 AliHLTCaloDigitContainerDataStruct *fDigitContainerPtr; //! transient\r
146\r
147 /** Maximum difference in index to be a neighbour */\r
148 Int_t fMaxDigitIndexDiff; //COMMENT\r
149\r
ad44d760 150 /** Number of digits in event */\r
151 Int_t fNDigits; //COMMENT\r
152\r
ef44ec64 153private:\r
9bd6f29b 154 \r
155 /** Size of the available write buffer */\r
156 UInt_t fAvailableSize; //COMMENT\r
341aab10 157\r
9bd6f29b 158 /** Default constructor, prohibited */\r
159 AliHLTCaloClusterizer(); // COMMENT\r
160 \r
161 /** Copy constructor, prohibited */\r
162 AliHLTCaloClusterizer (const AliHLTCaloClusterizer &); //COMMENT\r
163 \r
164 /** Assignment operator, prohibited */\r
165 AliHLTCaloClusterizer & operator = (const AliHLTCaloClusterizer &); //COMMENT\r
f1bfc65f 166\r
ef44ec64 167 ClassDef(AliHLTCaloClusterizer, 0);\r
168\r
ef44ec64 169};\r
170\r
171#endif\r