1 /**************************************************************************
2 * This file is property of and copyright by the ALICE HLT Project *
3 * All rights reserved. *
6 * Indranil Das <indra.das@saha.ac.in> *
8 * Permission to use, copy, modify and distribute this software and its *
9 * documentation strictly for non-commercial purposes is hereby granted *
10 * without fee, provided that the above copyright notice appears in all *
11 * copies and that both the copyright notice and this permission notice *
12 * appear in the supporting documentation. The authors make no claims *
13 * about the suitability of this software for any purpose. It is *
14 * provided "as is" without express or implied warranty. *
15 **************************************************************************/
21 /// The HitRec Component is designed to deal the rawdata inputfiles to findout the
22 /// the reconstructed hits. The output is send to the output block for further
25 /// Author : Indranil Das ( indra.das@saha.ac.in || indra.ehep@gmail.com )
28 #include "AliHLTMUONRecHitsBlockStruct.h"
29 #include "AliHLTMUONHitReconstructorComponent.h"
30 #include "AliHLTMUONHitReconstructor.h"
31 #include "AliHLTMUONConstants.h"
32 #include "AliHLTMUONUtils.h"
33 #include "AliHLTMUONDataBlockWriter.h"
34 #include "AliHLTMUONHitReconstructor.h"
35 #include "AliHLTLogging.h"
36 #include "AliHLTSystem.h"
37 #include "AliHLTDefinitions.h"
44 #include "AliCDBManager.h"
45 #include "AliCDBStorage.h"
46 #include "AliGeomManager.h"
49 #include "AliMUONGeometryTransformer.h"
50 #include "AliMUONCalibrationData.h"
51 #include "AliMUONVCalibParam.h"
56 #include "AliMpSegmentation.h"
57 #include "AliMpDDLStore.h"
58 #include "AliMpDEIterator.h"
59 #include "AliMpVSegmentation.h"
60 #include "AliMpDEManager.h"
61 #include "AliMpDetElement.h"
63 ClassImp(AliHLTMUONHitReconstructorComponent)
66 AliHLTMUONHitReconstructorComponent::AliHLTMUONHitReconstructorComponent() :
67 AliHLTMUONProcessor(),
73 fWarnForUnexpecedBlock(false)
76 /// Default constructor.
81 AliHLTMUONHitReconstructorComponent::~AliHLTMUONHitReconstructorComponent()
84 /// Default destructor.
97 const char* AliHLTMUONHitReconstructorComponent::GetComponentID()
100 /// Inherited from AliHLTComponent. Returns the component ID.
103 return AliHLTMUONConstants::HitReconstructorId();
107 void AliHLTMUONHitReconstructorComponent::GetInputDataTypes( std::vector<AliHLTComponentDataType>& list)
110 /// Inherited from AliHLTProcessor. Returns the list of expected input data types.
114 list.push_back( AliHLTMUONConstants::DDLRawDataType() );
118 AliHLTComponentDataType AliHLTMUONHitReconstructorComponent::GetOutputDataType()
121 /// Inherited from AliHLTComponent. Returns the output data type.
124 return AliHLTMUONConstants::RecHitsBlockDataType();
128 void AliHLTMUONHitReconstructorComponent::GetOutputDataSize( unsigned long& constBase, double& inputMultiplier )
131 /// Inherited from AliHLTComponent. Returns an estimate of the expected output data size.
134 constBase = sizeof(AliHLTMUONRecHitsBlockWriter::HeaderType);
139 AliHLTComponent* AliHLTMUONHitReconstructorComponent::Spawn()
142 /// Inherited from AliHLTComponent. Creates a new object instance.
145 return new AliHLTMUONHitReconstructorComponent;
149 int AliHLTMUONHitReconstructorComponent::DoInit(int argc, const char** argv)
152 /// Inherited from AliHLTComponent.
153 /// Parses the command line parameters and initialises the component.
156 HLTInfo("Initialising dHLT hit reconstruction component.");
158 // Must make sure that fHitRec and fLut is deleted if it is still
159 // allocated for whatever reason.
164 fHitRec = new AliHLTMUONHitReconstructor();
166 catch (const std::bad_alloc&)
168 HLTError("Could not allocate more memory for the hit reconstructor component.");
172 // Initialise fields with default values then parse the command line.
175 fWarnForUnexpecedBlock = false;
177 const char* lutFileName = NULL;
178 const char* cdbPath = NULL;
181 bool tryRecover = false;
183 for (int i = 0; i < argc; i++)
185 HLTDebug("argv[%d] == %s", i, argv[i]);
187 if (strcmp( argv[i], "-ddl" ) == 0)
191 HLTError("The DDL number was not specified. Must be in the range [13..20].");
192 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
197 unsigned long num = strtoul( argv[i+1], &cpErr, 0 );
198 if (cpErr == NULL or *cpErr != '\0')
200 HLTError("Cannot convert '%s' to DDL a number.", argv[i+1] );
201 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
204 if (num < 13 or 20 < num)
206 HLTError("The DDL number must be in the range [13..20].");
207 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
210 fDDL = num - 1; // convert to range [12..19]
216 if (strcmp( argv[i], "-lut" ) == 0)
220 HLTError("The lookup table filename was not specified.");
221 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
224 lutFileName = argv[i+1];
229 if (strcmp( argv[i], "-cdb" ) == 0)
235 if (strcmp( argv[i], "-cdbpath" ) == 0)
239 HLTError("The CDB path was not specified." );
240 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
249 if (strcmp( argv[i], "-run" ) == 0)
253 HLTError("The RUN number was not specified." );
254 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
259 run = Int_t( strtoul(argv[i+1], &cpErr, 0) );
260 if (cpErr == NULL or *cpErr != '\0')
262 HLTError("Cannot convert '%s' to a valid run number."
263 " Expected an integer value.", argv[i+1]
265 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
273 if (strcmp( argv[i], "-warn_on_unexpected_block" ) == 0)
275 fWarnForUnexpecedBlock = true;
279 if (strcmp( argv[i], "-tryrecover" ) == 0)
285 HLTError("Unknown option '%s'", argv[i]);
286 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
291 if (lutFileName == NULL) useCDB = true;
295 HLTWarning("DDL number not specified. Cannot check if incomming data is valid.");
301 HLTInfo("Loading lookup table information from CDB for DDL %d.", fDDL+1);
303 HLTWarning("DDL number not specified. The lookup table loaded from CDB will be empty!");
304 result = ReadCDB(cdbPath, run);
308 HLTInfo("Loading lookup table information from file %s.", lutFileName);
309 result = ReadLookUpTable(lutFileName);
313 // Error messages already generated in ReadCDB or ReadLookUpTable.
314 FreeMemory(); // Make sure we cleanup to avoid partial initialisation.
318 fHitRec->SetLookUpTable(fLut, &fIdToEntry);
319 fHitRec->TryRecover(tryRecover);
325 int AliHLTMUONHitReconstructorComponent::DoDeinit()
328 /// Inherited from AliHLTComponent. Performs a cleanup of the component.
331 HLTInfo("Deinitialising dHLT hit reconstruction component.");
337 int AliHLTMUONHitReconstructorComponent::DoEvent(
338 const AliHLTComponentEventData& evtData,
339 const AliHLTComponentBlockData* blocks,
340 AliHLTComponentTriggerData& /*trigData*/,
341 AliHLTUInt8_t* outputPtr,
342 AliHLTUInt32_t& size,
343 std::vector<AliHLTComponentBlockData>& outputBlocks
347 /// Inherited from AliHLTProcessor. Processes the new event data.
351 unsigned long totalSize = 0; // Amount of memory currently consumed in bytes.
353 HLTDebug("Processing event %llu with %u input data blocks.",
354 evtData.fEventID, evtData.fBlockCnt
357 // Loop over all input blocks in the event
358 for (AliHLTUInt32_t n = 0; n < evtData.fBlockCnt; n++)
360 HLTDebug("Handling block: %u, with fDataType = '%s', fPtr = %p and fSize = %u bytes.",
361 n, DataType2Text(blocks[n].fDataType).c_str(), blocks[n].fPtr, blocks[n].fSize
364 if (blocks[n].fDataType != AliHLTMUONConstants::DDLRawDataType()
365 or not AliHLTMUONUtils::IsTrackerDDL(blocks[n].fSpecification)
368 // Log a message indicating that we got a data block that we
369 // do not know how to handle.
370 if (fWarnForUnexpecedBlock)
371 HLTWarning("Received a data block of a type we cannot handle: '%s', spec: 0x%X",
372 DataType2Text(blocks[n].fDataType).c_str(), blocks[n].fSpecification
375 HLTDebug("Received a data block of a type we cannot handle: '%s', spec: 0x%X",
376 DataType2Text(blocks[n].fDataType).c_str(), blocks[n].fSpecification
384 if (AliHLTMUONUtils::SpecToDDLNumber(blocks[n].fSpecification) != fDDL)
386 HLTWarning("Received raw data from an unexpected DDL.");
390 // Create a new output data block and initialise the header.
391 AliHLTMUONRecHitsBlockWriter block(outputPtr+totalSize, size-totalSize);
392 if (not block.InitCommonHeader())
394 HLTError("There is not enough space in the output buffer for the new data block."
395 " We require at least %u bytes, but have %u bytes left.",
396 sizeof(AliHLTMUONRecHitsBlockWriter::HeaderType),
402 AliHLTUInt32_t totalDDLSize = blocks[n].fSize / sizeof(AliHLTUInt32_t);
403 AliHLTUInt32_t ddlRawDataSize = totalDDLSize - fHitRec->GetkDDLHeaderSize();
404 AliHLTUInt32_t* buffer = reinterpret_cast<AliHLTUInt32_t*>(blocks[n].fPtr)
405 + fHitRec->GetkDDLHeaderSize();
406 AliHLTUInt32_t nofHit = block.MaxNumberOfEntries();
409 HLTDebug("=========== Dumping DDL payload buffer ==========");
410 for (AliHLTUInt32_t j = 0; j < totalDDLSize; j++)
411 HLTDebug("buffer[%d] : %x",j,buffer[j]);
412 HLTDebug("================== End of dump =================");
415 if (not fHitRec->Run(buffer, ddlRawDataSize, block.GetArray(), nofHit))
417 HLTError("Error while processing the hit reconstruction algorithm.");
418 size = totalSize; // Must tell the framework how much buffer space was used.
422 // nofHit should now contain the number of reconstructed hits actually found
423 // and filled into the output data block, so we can set this number.
424 assert( nofHit <= block.MaxNumberOfEntries() );
425 block.SetNumberOfEntries(nofHit);
427 HLTDebug("Number of reconstructed hits found is %d", nofHit);
429 // Fill a block data structure for our output block.
430 AliHLTComponentBlockData bd;
433 // This block's start (offset) is after all other blocks written so far.
434 bd.fOffset = totalSize;
435 bd.fSize = block.BytesUsed();
436 bd.fDataType = AliHLTMUONConstants::RecHitsBlockDataType();
437 bd.fSpecification = blocks[n].fSpecification;
438 outputBlocks.push_back(bd);
440 // Increase the total amount of data written so far to our output memory
441 totalSize += block.BytesUsed();
443 // Finally we set the total size of output memory we consumed.
450 void AliHLTMUONHitReconstructorComponent::FreeMemory()
452 /// Deletes any allocated objects if they are allocated else nothing is
453 /// done for objects not yet allocated.
454 /// This is used as a helper method to make sure the corresponding pointers
455 /// are NULL and we get back to a well defined state.
473 int AliHLTMUONHitReconstructorComponent::ReadLookUpTable(const char* lutFileName)
475 /// Read in the lookup table from a text file.
476 /// Note that this method could leave fLut allocated which is cleaned up
477 /// by DoInit with a call to FreeMemory().
479 assert( fLut == NULL );
480 assert( fLutSize == 0 );
481 assert( fIdToEntry.empty() );
483 std::ifstream file(lutFileName);
486 HLTError("Could not open the LUT file %s", lutFileName);
490 // First count the number of lines of text in the LUT file before decoding.
491 // This is not the most optimal. It would be better to read and decode at the
492 // same time but we are not allowed to use STL and ROOT containers are too
493 // heavy for this task. At least this is done only at the start of run.
495 AliHLTUInt32_t lineCount = 0;
496 while (std::getline(file, str)) lineCount++;
499 HLTError("There was a problem reading the LUT file %s", lutFileName);
504 HLTWarning("The LUT file %s was empty.", lutFileName);
507 // Add one extra LUT line for the first element which is used as a sentinel value.
512 fLut = new AliHLTMUONHitRecoLutRow[lineCount];
513 fLutSize = lineCount;
515 catch (const std::bad_alloc&)
517 HLTError("Could not allocate more memory for the lookuptable.");
521 // Initialise the sentinel value.
522 fLut[0].fDetElemId = 0;
525 fLut[0].fRealX = 0.0;
526 fLut[0].fRealY = 0.0;
527 fLut[0].fRealZ = 0.0;
528 fLut[0].fHalfPadSize = 0.0;
537 // Clear the eof flag and start reading from the beginning of the file again.
539 file.seekg(0, std::ios::beg);
542 HLTError("There was a problem seeking in the LUT file %s", lutFileName);
546 AliHLTInt32_t idManuChannel;
547 for (AliHLTUInt32_t i = 1; i < fLutSize; i++)
549 if (std::getline(file, str).fail())
551 HLTError("There was a problem reading line %d of LUT file %s", i, lutFileName);
556 str.c_str(), "%d\t%d\t%d\t%d\t%e\t%e\t%e\t%e\t%d\t%e\t%e\t%e\t%e\t%d\t%d",
557 &idManuChannel, &fLut[i].fDetElemId, &fLut[i].fIX,
558 &fLut[i].fIY, &fLut[i].fRealX,
559 &fLut[i].fRealY, &fLut[i].fRealZ,
560 &fLut[i].fHalfPadSize, &fLut[i].fPlane,
561 &fLut[i].fPed, &fLut[i].fSigma, &fLut[i].fA0,
562 &fLut[i].fA1, &fLut[i].fThres, &fLut[i].fSat
567 HLTError("Line %d in LUT file %s does not contain 15 elements.", i, lutFileName);
571 fIdToEntry[idManuChannel] = i;
578 int AliHLTMUONHitReconstructorComponent::ReadCDB(const char* cdbPath, Int_t run)
580 /// Reads LUT from CDB.
582 assert( fLut == NULL );
583 assert( fLutSize == 0 );
584 assert( fIdToEntry.empty() );
586 std::vector<AliHLTMUONHitRecoLutRow> lutList;
587 AliHLTMUONHitRecoLutRow lut;
588 AliHLTUInt32_t iEntry = 0;
590 int result = FetchMappingStores(cdbPath, run);
591 // Error message already generated in FetchMappingStores.
592 if (result != 0) return result;
593 AliMpDDLStore* ddlStore = AliMpDDLStore::Instance();
595 AliMpSegmentation* mpSegFactory = AliMpSegmentation::Instance();
596 if (mpSegFactory == NULL)
598 HLTError("Could not find segmentation mapping (AliMpSegmentation) instance.");
602 // Only load geometry if not already loaded.
603 if (AliGeomManager::GetGeometry() == NULL)
605 AliGeomManager::LoadGeometry();
607 AliMUONGeometryTransformer chamberGeometryTransformer;
608 if (not chamberGeometryTransformer.LoadGeometryData())
610 HLTError("Failed to load geomerty data.");
614 AliMUONCalibrationData calibData(run);
618 for(Int_t iCh = 6; iCh < 10; iCh++)
623 for ( it.First(chamberId); ! it.IsDone(); it.Next() )
625 Int_t detElemId = it.CurrentDEId();
626 int iDDL = ddlStore->GetDetElement(detElemId)->GetDdlId();
627 if (iDDL != fDDL) continue;
629 for (Int_t iCath = 0 ; iCath <= 1 ; iCath++)
631 AliMp::CathodType cath;
634 cath = AliMp::kCath0;
636 cath = AliMp::kCath1;
638 const AliMpVSegmentation* seg = mpSegFactory->GetMpSegmentation(detElemId, cath);
639 AliMp::PlaneType plane = seg->PlaneType();
640 Int_t maxIX = seg->MaxPadIndexX();
641 Int_t maxIY = seg->MaxPadIndexY();
643 Int_t idManuChannel, manuId, channelId, buspatchId;
644 AliHLTFloat32_t padSizeX, padSizeY;
645 AliHLTFloat32_t halfPadSize;
646 Double_t realX, realY, realZ;
647 Double_t localX, localY, localZ;
648 Float_t calibA0Coeff,calibA1Coeff,pedestal,sigma;
649 Int_t thresold,saturation;
651 // Pad Info of a slat to print in lookuptable
652 for (Int_t iX = 0; iX<= maxIX ; iX++)
653 for (Int_t iY = 0; iY<= maxIY ; iY++)
655 if (not seg->HasPad(AliMpIntPair(iX,iY))) continue;
657 AliMpPad pad = seg->PadByIndices(AliMpIntPair(iX,iY), kFALSE);
660 manuId = pad.GetLocation().GetFirst();
661 manuId &= 0x7FF; // 11 bits
663 buspatchId = ddlStore->GetBusPatchId(detElemId,manuId);
665 // Getting channel id
666 channelId = pad.GetLocation().GetSecond();
667 channelId &= 0x3F; // 6 bits
669 idManuChannel = buspatchId << 11;
670 idManuChannel = (idManuChannel | manuId) << 6;
671 idManuChannel |= channelId;
673 localX = pad.Position().X();
674 localY = pad.Position().Y();
677 chamberGeometryTransformer.Local2Global(
678 detElemId,localX,localY,localZ,
682 padSizeX = pad.Dimensions().X();
683 padSizeY = pad.Dimensions().Y();
685 calibA0Coeff = (calibData.Gains(detElemId, manuId))->ValueAsFloat(channelId, 0);
686 calibA1Coeff = (calibData.Gains(detElemId, manuId))->ValueAsFloat(channelId, 1);
687 thresold = (calibData.Gains(detElemId, manuId))->ValueAsInt(channelId, 2);
688 saturation = (calibData.Gains(detElemId, manuId))->ValueAsInt(channelId, 4);
690 pedestal = (calibData.Pedestals(detElemId, manuId))->ValueAsFloat(channelId, 0);
691 sigma = (calibData.Pedestals(detElemId, manuId))->ValueAsFloat(channelId, 1);
694 halfPadSize = padSizeX;
696 halfPadSize = padSizeY;
698 fIdToEntry[idManuChannel] = iEntry+1;
700 lut.fDetElemId = detElemId;
706 lut.fHalfPadSize = halfPadSize;
710 lut.fA0 = calibA0Coeff;
711 lut.fA1 = calibA1Coeff;
712 lut.fThres = thresold;
713 lut.fSat = saturation;
715 lutList.push_back(lut);
724 // Use iEntry+1 since we add one extra LUT line for the first element
725 // which is used as a sentinel value.
726 fLut = new AliHLTMUONHitRecoLutRow[iEntry+1];
729 catch (const std::bad_alloc&)
731 HLTError("Could not allocate more memory for the lookuptable.");
735 // Initialise the sentinel value.
736 fLut[0].fDetElemId = 0;
739 fLut[0].fRealX = 0.0;
740 fLut[0].fRealY = 0.0;
741 fLut[0].fRealZ = 0.0;
742 fLut[0].fHalfPadSize = 0.0;
751 for (AliHLTUInt32_t i = 0; i < iEntry; i++)
752 fLut[i+1] = lutList[i];
758 bool AliHLTMUONHitReconstructorComponent::GenerateLookupTable(
759 AliHLTInt32_t ddl, const char* filename,
760 const char* cdbPath, Int_t run
763 /// Generates a ASCII text file containing the lookup table (LUT) from
764 /// the CDB, which can be used for the hit reconstructor component later.
765 /// @param ddl Must be the DDL for which to generate the DDL,
766 /// in the range [13..20].
767 /// @param filename The name of the LUT file to generate.
768 /// @param cdbPath The CDB path to use.
769 /// @param run The run number to use for the CDB.
770 /// @return True if the generation of the LUT file succeeded.
772 AliHLTMUONHitReconstructorComponent comp;
774 if (ddl < 12 or 19 < ddl)
776 std::cerr << "ERROR: the DDL number must be in the range [12..19]." << std::endl;
781 if (comp.ReadCDB(cdbPath, run) != 0) return false;
784 std::fstream file(filename, std::ios::out);
787 std::cerr << "ERROR: could not open file: " << filename << std::endl;
791 assert( comp.fLut != NULL );
793 for (IdManuChannelToEntry::iterator id = comp.fIdToEntry.begin();
794 id != comp.fIdToEntry.end();
798 AliHLTInt32_t idManuChannel = id->first;
799 AliHLTInt32_t row = id->second;
801 assert( row < comp.fLutSize );
803 sprintf(str, "%d\t%d\t%d\t%d\t%.15e\t%.15e\t%.15e\t%.15e\t%d\t%.15e\t%.15e\t%.15e\t%.15e\t%d\t%d",
804 idManuChannel, comp.fLut[row].fDetElemId, comp.fLut[row].fIX,
805 comp.fLut[row].fIY, comp.fLut[row].fRealX,
806 comp.fLut[row].fRealY, comp.fLut[row].fRealZ,
807 comp.fLut[row].fHalfPadSize, comp.fLut[row].fPlane,
808 comp.fLut[row].fPed, comp.fLut[row].fSigma, comp.fLut[row].fA0,
809 comp.fLut[row].fA1, comp.fLut[row].fThres, comp.fLut[row].fSat
815 std::cerr << "ERROR: There was an I/O error when writing to the file: "
816 << filename << std::endl;