HLT/CALO/AliHLTCaloClusterizer.cxx

   1 // $Id$\r
   2 \r
   3 /**************************************************************************\r
   4  * This file is property of and copyright by the ALICE HLT Project        *\r
   5  * All rights reserved.                                                   *\r
   6  *                                                                        *\r
   7  * Primary Authors: Oystein Djuvsland                                     *\r
   8  *                                                                        *\r
   9  * Permission to use, copy, modify and distribute this software and its   *\r
  10  * documentation strictly for non-commercial purposes is hereby granted   *\r
  11  * without fee, provided that the above copyright notice appears in all   *\r
  12  * copies and that both the copyright notice and this permission notice   *\r
  13  * appear in the supporting documentation. The authors make no claims     *\r
  14  * about the suitability of this software for any purpose. It is          *\r
  15  * provided "as is" without express or implied warranty.                  *\r
  16  **************************************************************************/\r
  17 \r
  18 /**\r
  19  * @file   AliHLTCaloClusterizer.cxx\r
  20  * @author Oystein Djuvsland\r
  21  * @date\r
  22  * @brief  Clusterizer for PHOS HLT\r
  23  */\r
  24 \r
  25 // see header file for class documentation\r
  26 // or\r
  27 // refer to README to build package\r
  28 // or\r
  29 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt\r
  30 \r
  31 #include "AliHLTCaloClusterizer.h"\r
  32 #include "AliHLTLogging.h"\r
  33 #include "TMath.h"\r
  34 #include "AliHLTCaloRecPointDataStruct.h"\r
  35 #include "AliHLTCaloDigitDataStruct.h"\r
  36 #include "AliHLTCaloDigitContainerDataStruct.h"\r
  37 #include "AliHLTCaloConstantsHandler.h"\r
  38 \r
  39 ClassImp(AliHLTCaloClusterizer);\r
  40 \r
  41 AliHLTCaloClusterizer::AliHLTCaloClusterizer(TString det):\r
  42         AliHLTCaloConstantsHandler(det),\r
  43         fCompareFunction(CompareDigitsByPosition),\r
  44         fRecPointArray(0),\r
  45         fRecPointDataPtr(0),\r
  46         fFirstRecPointPtr(0),\r
  47         fArraySize(0),\r
  48         fAvailableSize(0),\r
  49         fUsedSize(0),\r
  50         fNRecPoints(0),\r
  51         fDigitIndexPtr(0),\r
  52         fEmcClusteringThreshold(0),\r
  53         fEmcMinEnergyThreshold(0),\r
  54         fEmcTimeGate(0),\r
  55         fDigitsInCluster(0),\r
  56         fDigitsPointerArray(0),\r
  57         fDigitContainerPtr(0),\r
  58         fMaxDigitIndexDiff(0),\r
  59         fNDigits(0),\r
  60         fSortedByPosition(false),\r
  61         fSortedByEnergy(false),\r
  62         fSortDigits(false)\r
  63 {\r
  64     //See header file for documentation\r
  65     //fEmcClusteringThreshold = 0.2;\r
  66     //fEmcMinEnergyThreshold = 0.03;\r
  67 \r
  68     fEmcClusteringThreshold = 0.1;\r
  69     fEmcMinEnergyThreshold = 0.01;\r
  70     fEmcTimeGate = 1.e-6 ;\r
  71 \r
  72     fMaxDigitIndexDiff = 2*fCaloConstants->GetNZROWSMOD();\r
  73 \r
  74 \r
  75     fArraySize = 10;\r
  76     fRecPointArray = new AliHLTCaloRecPointDataStruct*[fArraySize];\r
  77 \r
  78     fAvailableSize = sizeof(AliHLTCaloRecPointDataStruct) * 20;\r
  79     fFirstRecPointPtr = reinterpret_cast<AliHLTCaloRecPointDataStruct*>(new UChar_t[fAvailableSize]);\r
  80     fRecPointDataPtr = fFirstRecPointPtr;\r
  81 \r
  82 }//end\r
  83 \r
  84 AliHLTCaloClusterizer::~AliHLTCaloClusterizer()\r
  85 {\r
  86     //See header file for documentation\r
  87   //delete [] fRecPointDataPtr;\r
  88   //delete [] fRecPointArray;\r
  89 }\r
  90 \r
  91 void\r
  92 AliHLTCaloClusterizer::SetRecPointDataPtr(AliHLTCaloRecPointDataStruct* recPointDataPtr)\r
  93 {\r
  94     // See header file for documentation\r
  95     fRecPointDataPtr = recPointDataPtr;\r
  96 }\r
  97 \r
  98 Int_t\r
  99 AliHLTCaloClusterizer::ClusterizeEvent(Int_t nDigits)\r
 100 {\r
 101     //see header file for documentation\r
 102     Int_t nRecPoints = 0;\r
 103     fNRecPoints = 0;\r
 104     fUsedSize = 0;\r
 105     fNDigits = nDigits;\r
 106     fRecPointDataPtr = fFirstRecPointPtr;\r
 107 \r
 108     // Sort our digits\r
 109     SortDigits();\r
 110 \r
 111     //Clusterization starts\r
 112     for (Int_t i = 0; i < nDigits; i++)\r
 113     {\r
 114         fDigitsInCluster = 0;\r
 115 \r
 116          HLTDebug("Digit with energy: %f", fDigitsPointerArray[i]->fEnergy);\r
 117         \r
 118         if (fDigitsPointerArray[i]->fEnergy < fEmcClusteringThreshold && fSortedByEnergy)\r
 119         {\r
 120            // Since we have sorted by energy the next digit will have even lower energy, so we return \r
 121            return fNRecPoints;\r
 122         }\r
 123 \r
 124         if(fDigitsPointerArray[i]->fAssociatedCluster != -1)\r
 125         {\r
 126            // The digit is added to a previous cluster, continue\r
 127            continue;\r
 128         }\r
 129 \r
 130         CheckArray();\r
 131         CheckBuffer();\r
 132 \r
 133         // First digit is placed at the fDigits member variable in the recpoint\r
 134         fDigitIndexPtr = &(fRecPointDataPtr->fDigits);\r
 135 \r
 136         fRecPointDataPtr->fAmp = 0;\r
 137         fRecPointDataPtr->fModule = fDigitsPointerArray[i]->fModule;\r
 138 \r
 139         // Assigning the digit to this rec point\r
 140         fRecPointDataPtr->fDigits = i;\r
 141         fUsedSize += sizeof(AliHLTCaloRecPointDataStruct);\r
 142 \r
 143         // Incrementing the pointer to be ready for new entry\r
 144         fDigitIndexPtr++;\r
 145 \r
 146         fRecPointDataPtr->fAmp += fDigitsPointerArray[i]->fEnergy;\r
 147     \r
 148         \r
 149         //fDigitsPointerArray[i]->fEnergy = 0;\r
 150         fDigitsPointerArray[i]->fAssociatedCluster = fNRecPoints;\r
 151         \r
 152         \r
 153         fDigitsInCluster++;\r
 154         nRecPoints++;\r
 155 \r
 156         // Scanning for the neighbours\r
 157         if (ScanForNeighbourDigits(i, fRecPointDataPtr) != 0)\r
 158         {\r
 159             return -1;\r
 160         }\r
 161 \r
 162         //fUsedSize += sizeof(AliHLTCaloRecPointDataStruct) + (fDigitsInCluster-1)*sizeof(AliHLTCaloDigitDataStruct);\r
 163 \r
 164         fRecPointDataPtr->fMultiplicity = fDigitsInCluster;\r
 165         fRecPointArray[fNRecPoints] = fRecPointDataPtr;\r
 166 \r
 167         fRecPointDataPtr = reinterpret_cast<AliHLTCaloRecPointDataStruct*>(fDigitIndexPtr);\r
 168 \r
 169         fNRecPoints++;\r
 170 \r
 171     }//end of clusterization\r
 172 \r
 173     return nRecPoints;\r
 174 }\r
 175 \r
 176 Int_t\r
 177 AliHLTCaloClusterizer::ScanForNeighbourDigits(Int_t index, AliHLTCaloRecPointDataStruct* recPoint)\r
 178 {\r
 179     //see header file for documentation\r
 180 \r
 181     // The following cuts can be used if we sort by posisiton. Not tested, but it should be fine...\r
 182     Int_t max = TMath::Min(fNDigits, (Int_t)fMaxDigitIndexDiff+index);\r
 183     Int_t min = TMath::Max(0, (Int_t)(index - (Int_t)fMaxDigitIndexDiff));\r
 184 \r
 185     // All digits for now\r
 186     max = fNDigits;\r
 187     min = 0;\r
 188 \r
 189     for (Int_t j = min; j < max; j++)\r
 190     {\r
 191         if (fDigitsPointerArray[j]->fAssociatedCluster == -1 &&  fDigitsPointerArray[j]->fEnergy > fEmcMinEnergyThreshold)\r
 192         {\r
 193             if (j != index)\r
 194             {\r
 195                 if (AreNeighbours(fDigitsPointerArray[index],\r
 196                                   fDigitsPointerArray[j]))\r
 197                 {\r
 198                     // Check that the buffer is large enough for adding a digit (can be heavily improved wrt performance)\r
 199                     CheckBuffer();\r
 200 \r
 201                     // Assigning index to digit\r
 202                     *fDigitIndexPtr = j;\r
 203                     fUsedSize += sizeof(Int_t);\r
 204 \r
 205                     // Incrementing digit pointer to be ready for new entry\r
 206                     fDigitIndexPtr++;\r
 207 \r
 208                     // Adding the digit energy to the rec point\r
 209                     fRecPointDataPtr->fAmp += fDigitsPointerArray[j]->fEnergy;\r
 210 \r
 211                     // Setting energy to 0\r
 212                     //fDigitsPointerArray[j]->fEnergy = 0;\r
 213                     \r
 214                     // Setting the associated cluster \r
 215                     fDigitsPointerArray[j]->fAssociatedCluster = fNRecPoints;\r
 216                     \r
 217                     HLTDebug("Added digit with index: %d, energy: %f, to associated cluster: %d", fDigitsPointerArray[j]->fID, fDigitsPointerArray[j]->fEnergy, fDigitsPointerArray[j]->fAssociatedCluster);\r
 218                     \r
 219                     fDigitsInCluster++;\r
 220 \r
 221                     // Scan for neighbours of this digit\r
 222                     ScanForNeighbourDigits(j, recPoint);\r
 223                 }\r
 224             }\r
 225         }\r
 226     }\r
 227     return 0;\r
 228 }\r
 229 \r
 230 Int_t\r
 231 AliHLTCaloClusterizer::AreNeighbours(AliHLTCaloDigitDataStruct* digit1,\r
 232                                      AliHLTCaloDigitDataStruct* digit2)\r
 233 {\r
 234     //see header file for documentation\r
 235     if ( (digit1->fModule == digit2->fModule) /*&& (coord1[1]==coord2[1])*/ ) // inside the same PHOS module\r
 236     {\r
 237         Int_t rowdiff = TMath::Abs( digit1->fZ - digit2->fZ );\r
 238         Int_t coldiff = TMath::Abs( digit1->fX - digit2->fX );\r
 239 \r
 240         // As in the offline code we define neighbours as cells that share an edge, a corner is not  enough\r
 241         //        if (( coldiff <= 1   &&  rowdiff == 0 ) || ( coldiff == 0 &&  rowdiff <= 1 ))\r
 242         if (( coldiff <= 1) || ( rowdiff <= 1 ))\r
 243         {\r
 244             // Check also for time\r
 245             if (TMath::Abs(digit1->fTime - digit2->fTime ) < fEmcTimeGate)\r
 246             {\r
 247                 return 1;\r
 248             }\r
 249         }\r
 250     }\r
 251     return 0;\r
 252 }\r
 253 \r
 254 \r
 255 \r
 256 Int_t AliHLTCaloClusterizer::CheckArray()\r
 257 {\r
 258     // See header file for class documentation\r
 259     if (fArraySize == fNRecPoints)\r
 260     {\r
 261         fArraySize *= 2;\r
 262         AliHLTCaloRecPointDataStruct **tmp = new AliHLTCaloRecPointDataStruct*[fArraySize];\r
 263         memcpy(tmp, fRecPointArray, fArraySize/2 * sizeof(AliHLTCaloRecPointDataStruct*));\r
 264         delete [] fRecPointArray;\r
 265         fRecPointArray = tmp;\r
 266     }\r
 267     return 0;\r
 268 }\r
 269 \r
 270 Int_t AliHLTCaloClusterizer::CheckBuffer()\r
 271 {\r
 272     // See header file for class documentation\r
 273     if ((fAvailableSize - fUsedSize) < (Int_t)sizeof(AliHLTCaloRecPointDataStruct))\r
 274     {\r
 275         Int_t recPointOffset = reinterpret_cast<UChar_t*>(fRecPointDataPtr) - reinterpret_cast<UChar_t*>(fFirstRecPointPtr);\r
 276         Int_t digitIndexOffset = reinterpret_cast<UChar_t*>(fDigitIndexPtr) - reinterpret_cast<UChar_t*>(fRecPointDataPtr);\r
 277         UChar_t *tmp = new UChar_t[fAvailableSize*2];\r
 278 \r
 279         memcpy(tmp, fFirstRecPointPtr, fUsedSize);\r
 280         fAvailableSize *= 2;\r
 281         for (Int_t n = 0; n < fNRecPoints; n++)\r
 282         {\r
 283             fRecPointArray[n] = reinterpret_cast<AliHLTCaloRecPointDataStruct*>(reinterpret_cast<UChar_t*>(fRecPointArray[n]) - reinterpret_cast<UChar_t*>(fFirstRecPointPtr) + reinterpret_cast<UChar_t*>(tmp));\r
 284         }\r
 285         delete [] fFirstRecPointPtr;\r
 286         fFirstRecPointPtr = reinterpret_cast<AliHLTCaloRecPointDataStruct*>(tmp);\r
 287         fRecPointDataPtr = reinterpret_cast<AliHLTCaloRecPointDataStruct*>(tmp + recPointOffset);\r
 288         fDigitIndexPtr = reinterpret_cast<Int_t*>(reinterpret_cast<UChar_t*>(fRecPointDataPtr) + digitIndexOffset);\r
 289         //fUsedSize = 0;\r
 290     }\r
 291     return 0;\r
 292 }\r
 293 \r
 294 void AliHLTCaloClusterizer::SetSortDigitsByPosition()\r
 295 {\r
 296     // Sort the digit pointers by position\r
 297     fCompareFunction = &CompareDigitsByPosition;\r
 298     fSortDigits = true;\r
 299     fSortedByPosition = true;\r
 300 }\r
 301 \r
 302 void AliHLTCaloClusterizer::SetSortDigitsByEnergy()\r
 303 {\r
 304     // See header file for class documentation\r
 305     fCompareFunction = &CompareDigitsByEnergy;\r
 306     fSortDigits = true;\r
 307     fSortedByEnergy = true;\r
 308 }\r
 309 \r
 310 void AliHLTCaloClusterizer::SortDigits()\r
 311 {\r
 312     // See header file for class documentation\r
 313     if (fSortDigits) qsort(fDigitsPointerArray, fNDigits, sizeof(AliHLTCaloDigitDataStruct*), fCompareFunction);\r
 314 }\r
 315 \r
 316 Int_t\r
 317 AliHLTCaloClusterizer::CompareDigitsByPosition(const void *dig0, const void *dig1)\r
 318 {\r
 319     // See header file for documentation\r
 320     return (*((AliHLTCaloDigitDataStruct**)(dig0)))->fID - (*((AliHLTCaloDigitDataStruct**)(dig1)))->fID;\r
 321 }\r
 322 \r
 323 Int_t\r
 324 AliHLTCaloClusterizer::CompareDigitsByEnergy(const void *dig0, const void *dig1)\r
 325 {\r
 326     // See header file for documentation\r
 327   if ( ((*((AliHLTCaloDigitDataStruct**)(dig1)))->fEnergy - (*((AliHLTCaloDigitDataStruct**)(dig0)))->fEnergy) < 0) return -1;\r
 328   return 1;\r
 329 }\r