LArRodBlockPhysicsV1.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// Implementation of the LArRODBlockStructure_3 class
// This version contains LArRawChannels (=E,t,Q)
// and LArDigits (=5 time samples)
// See .h file for more details.
 
#include "LArByteStream/LArRodBlockPhysicsV1.h"
#include "LArRawEvent/LArRawChannel.h"
#include "LArRawEvent/LArDigit.h"
#include "LArIdentifier/LArOnlineID.h"
#include "GaudiKernel/Bootstrap.h"
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/IToolSvc.h"
#include <stdlib.h>
#include <cstdio>
#include <iostream>
 
#ifdef  LARBSDBGOUTPUT
#define LARBSDBG(text) m_logstr<<MSG::DEBUG<<text<<endmsg
#else
#define LARBSDBG(text)
#endif
 
namespace {
union ShortLong {
  uint16_t s[2];
  uint32_t l;
};
}
 
const uint32_t LArRodBlockPhysicsV1::m_DummyBitMap[4]={0,0,0,0};
 
LArRodBlockPhysicsV1::LArRodBlockPhysicsV1(IMessageSvc* msgSvc)
  : LArRodBlockStructure(msgSvc, BlockType())
{
  // retrieve onlineHelper
  const LArOnlineID* online_id;
  SmartIF<StoreGateSvc> detStore{Gaudi::svcLocator()->service("DetectorStore")};
  if (!detStore) {
    m_logstr << MSG::ERROR << "Unable to locate DetectorStore" << endmsg;
    std::abort();
  }
  StatusCode sc = detStore->retrieve(online_id, "LArOnlineID");
  if (sc.isFailure()) {
    m_logstr << MSG::FATAL << "Could not get LArOnlineID helper !" << endmsg;
    std::abort();
  }
  else {
    m_onlineHelper=online_id;
    m_logstr << MSG::DEBUG << " Found the LArOnlineID helper. " << endmsg;
  }
 
  m_iHeadBlockSize=endtag/2; // The implicit cast rounds down to the right size
  m_NFlaggingWords=4;
  LArRodBlockPhysicsV1::resetPointers();
  m_vFragment=NULL;
  m_FebBlock=NULL;
  m_pRODblock=NULL;
  m_FlagPtr=NULL;
  m_HighEPtr=NULL;
  m_LowEPtr=NULL;
}
 
// clear temporary block vectors 
void LArRodBlockPhysicsV1::clearBlocks()
{
  m_HighEnergyBlock.clear();
  m_LowEnergyBlock.clear();
  m_RawDataBlock.clear();
}
 
inline void LArRodBlockPhysicsV1::resetPointers() 
{
  m_ECounter=0;
  m_RawDataCounter=0;
  m_LowEIndex=0;
  m_RawDataIndex=0;
  m_HighEIndex=0;
  m_EIndex=0;
}
 
//For reading (to speed up the process)
bool LArRodBlockPhysicsV1::setPointers()
{
  //Set pointers to data blocks (pesuming, they exist)
  if (m_FebBlockSize>m_iHeadBlockSize)
  {
    if (getHeader16(LowEBlkOffset))
    {
      m_FlagPtr=m_FebBlock+getHeader16(LowEBlkOffset);
      m_LowEPtr=reinterpret_cast<const int16_t*>(m_FlagPtr+m_NFlaggingWords);
    }
    else 
    {
      //Bugfix, 9.8.2004, WL: Set pointer to dummy map to read FEB with only high energy block
      m_FlagPtr=m_DummyBitMap;
      m_LowEPtr=reinterpret_cast<const int16_t*>(m_FlagPtr);
    }
    if (getHeader16(HighEBlkOffset))
      m_HighEPtr=(const int32_t*)m_FebBlock+getHeader16(HighEBlkOffset);
    else
      m_HighEPtr=NULL;
  }
  else
   {
     m_FlagPtr=NULL;
     m_LowEPtr=NULL;
     m_HighEPtr=NULL;
   }
  return true;
}
 
void LArRodBlockPhysicsV1::setNumberOfSamples(const uint8_t n) 
{
  uint16_t oldword=getVectorHeader16(NGainNSamples);
  setHeader16(NGainNSamples,(oldword & 0xFF00) | n); 
}
 
void LArRodBlockPhysicsV1::setNumberOfGains(const uint8_t n) 
{
  uint16_t oldword=getVectorHeader16(NGainNSamples);
  setHeader16(NGainNSamples,(oldword & 0x00FF) | (n<<8)); 
}
 
 
void LArRodBlockPhysicsV1::setNextEnergy(const int channel, const int32_t energy, 
                     const int32_t time, const int32_t quality, const uint32_t gain) {
  int rcNb=FebToRodChannel(channel);
  //rcNb ist supposed to equal or bigger than m_EIndex.
  //In the latter case, we fill up the missing  channels with zero
  if (rcNb<m_EIndex) {
    m_logstr << MSG::ERROR  << "LArRODBlockStructure Error: Internal error. Channels not ordered correctly. rcNb=" << rcNb
         << " m_EIndex=" << m_EIndex << endmsg;
    return;
  }
  //Fill up missing channels with zeros:
  while (m_EIndex<rcNb)
    setNextEnergy(0,0,-1,0);
  //Add data...
  setNextEnergy(energy,time,quality,gain);
}
//Private function, expects channel number is rod-style ordering
void LArRodBlockPhysicsV1::setNextEnergy(const int32_t energy, const int32_t time, const int32_t quality, const uint32_t gain)
{
  if (m_EIndex>=m_channelsPerFEB)        //Use m_EIndex to count total number of channels
  {
    m_logstr << MSG::ERROR  << "LArRodBlockStructure Error: Attempt to write Energy for channel "
             << m_EIndex << " channels into a FEB!" <<endmsg;
    return;
  }
  LARBSDBG("LArRodBlockStructure: Setting Energy for channel " << m_EIndex << ". E=" << energy);
  if (quality<0 && energy<0x7FFE && gain==0) {     //Write into Low Energy block
    m_LowEIndex++;                       //Use m_LowEIndex to count the channels in the Low Energy block
    ShortLong twoValues{};
    twoValues.s[0]=0;
    twoValues.s[1]=0;
    if (m_LowEIndex%2==1) {            //This is an odd number, simply add data at the bottom of the block
      twoValues.s[0]=(int16_t)energy;
    }
    else {                                //Even number: Merging with previous block
      uint32_t oneValue=m_LowEnergyBlock[m_LowEnergyBlock.size()-1]; //Take last element of vector
      m_LowEnergyBlock.pop_back();
      int16_t* valptr=reinterpret_cast<int16_t*>(&oneValue);
      twoValues.s[0]=valptr[0];
      twoValues.s[1]=(int16_t)energy;
    }
    LARBSDBG("Writing words: val0= " << twoValues.s[0] << " val1= " << twoValues.s[1]);
    m_LowEnergyBlock.push_back(twoValues.l);
    LARBSDBG("Writing Raw data to Low E block. E=" << energy);
  }
  else                                          //Write into High Energy block
  {
    setBit(&m_LowEnergyBlock[0],m_EIndex);
    m_HighEnergyBlock.push_back(energy);
    uint32_t t_sign;
    uint32_t abs_time;
    if (time<0)
      t_sign=1;
    else
      t_sign=0;
    abs_time=abs(time);
    if (abs_time>0x1fff)
      abs_time=0x1fff;
    uint32_t gtQ = (gain << 30) | (t_sign<<29) | ((abs_time & 0x1fff)<<16) | (0xffff & quality);
    m_HighEnergyBlock.push_back(gtQ); 
    LARBSDBG("Writing Raw data to High E block. E=" << energy << " Q=" << quality);
  }
  m_EIndex++;
}
 
 
void LArRodBlockPhysicsV1::setRawData(const int channel, const std::vector<short>& samples, const uint32_t gain) {
  //Convert Feb to Rod Channel Number:
  int rcNb=FebToRodChannel(channel);
  if (rcNb>=m_channelsPerFEB)
  {
    m_logstr << MSG::ERROR << "Attempt to write Energy for channel " << rcNb << " channels into a FEB!" << endmsg;
    return;
  }
  unsigned int nsamples = getVectorHeader16(NGainNSamples) & 0x00FF;
  if(samples.size() != nsamples) {
    m_logstr << MSG::ERROR << "Number of samples mismatch!\n";
    m_logstr << "  nsamples       =" << nsamples;
    m_logstr << "  samples.size() =" << samples.size() << endmsg;
    std::abort();
  }
 
  setBit(&m_RawDataBlock[0],rcNb);
  //Samples have 12 bit and are shifted to the left by 2 bits.
  // odd samples in high bits, even samples in low bits
  if((nsamples/2)*2!=nsamples) { //odd number of samples - gain is alone
    m_RawDataBlock.push_back((gain<<30) | samples[0]<<2);
    for (unsigned int i=1;i<nsamples;i+=2)
      m_RawDataBlock.push_back((samples[i+1]<<18) | samples[i]<<2);
  }
  else { //even number of samples - gain is packed with sample 0
    m_RawDataBlock.push_back((gain<<30) | (samples[1]<<18) | samples[0]<<2);
    for (unsigned int i=2;i<nsamples;i+=2)
      m_RawDataBlock.push_back((samples[i+1]<<18) | samples[i]<<2);
  }
}
 
 
//For writing: takes existing Fragment and splits it into Feb-Blocks
void LArRodBlockPhysicsV1::initializeFragment(std::vector<uint32_t>& fragment)
{
  m_pRODblock=&fragment; //remember pointer to fragment
  if (fragment.size()>m_iHeadBlockSize) {  //Got filled fragment
    unsigned int sizeRead=0;
    //Store existing data in the FEB-Map
    while (sizeRead<fragment.size()) {
      std::vector<uint32_t>::iterator FebIter;
      FebIter=fragment.begin()+sizeRead;     //Store pointer to current Feb-Header
      m_FebBlock=&(*FebIter); //Set m_FebBlock in order to use getHeader-functions.
      uint32_t currFEBid=getHeader32(FEBID); //Get this FEB-ID
      uint16_t currFebSize=getNumberOfWords(); //Size of this FEB-Block
      if (FebIter+currFebSize>fragment.end()) {
    fragment.clear(); //Clear existing vector
    m_logstr << MSG::ERROR  << "Got inconsistent ROD-Fragment!" << endmsg; 
    return;
      }
      m_mFebBlocks[currFEBid].assign(FebIter,FebIter+currFebSize); //Copy data from ROD-fragment into FEB-Block
      sizeRead+=currFebSize+m_MiddleHeaderSize;//6 is the middle header size
      LARBSDBG("Found FEB-id " << currFEBid << " in existing ROD-Fragment");
    } // end while
  }
  fragment.clear(); //Clear existing vector
  return;
}
 
//For writing: Initalizes a single FEB-Block
void LArRodBlockPhysicsV1::initializeFEB(const uint32_t id)
{
  m_vFragment=&(m_mFebBlocks[id]);
  if (m_vFragment->size()<m_iHeadBlockSize) //Got empty or spoiled fragment
  {
    m_vFragment->resize(m_iHeadBlockSize,0); //Initialize FEB-Header
    setHeader32(FEBID,id);                //Set Feb ID
  }
 
  m_LowEnergyBlock.assign(m_NFlaggingWords,0);
  m_RawDataBlock.assign(m_NFlaggingWords,0);
  resetPointers();
}
 
void LArRodBlockPhysicsV1::finalizeFEB()
{
  //Complete non-complete Energy block
  while (m_EIndex<m_channelsPerFEB)
    setNextEnergy(0,0,-1,0);//E=0,t=0,q=-1,G=0
  // Energies
  unsigned int n;
  uint16_t BlockOffset;
  //Low energy block....
  n = m_LowEnergyBlock.size();
  BlockOffset=getVectorHeader16(LowEBlkOffset);
  //Check if Low Energy Block exists and is not yet part of the fragment
  LARBSDBG("Checking Low Energy Block n=" << n << "BlockOffset=" << BlockOffset);
  if (n>m_NFlaggingWords && !BlockOffset)
  {
    setHeader16(LowEBlkOffset,m_vFragment->size());
    for (unsigned i=0;i<n;i++)
      m_vFragment->push_back(m_LowEnergyBlock[i]);
  }
  //High energy block...
  n = m_HighEnergyBlock.size();
  BlockOffset=getVectorHeader16(HighEBlkOffset);
  LARBSDBG("Checking High Energy Block n=" << n << "BlockOffset=" << BlockOffset);
  //Check if High Energy-Block exists and is not yet part of the fragment
  if (n && !BlockOffset)
  {
    setHeader16(HighEBlkOffset,m_vFragment->size());
    for(unsigned int i=0;i<n;i++)
      m_vFragment->push_back(m_HighEnergyBlock[i]);
  }
 
  // Raw data
  LARBSDBG("Checking Raw Data Block");
  n = m_RawDataBlock.size();
  BlockOffset=getVectorHeader16(RawDataBlkOffset);
  LARBSDBG("Checking Raw Data Block. n=" << n << "BlockOffset=" << BlockOffset);
  //Check if Raw Data block exists and is not yet part of the fragment
  if (n>m_NFlaggingWords && !BlockOffset)
  {setHeader16(RawDataBlkOffset,m_vFragment->size());
    for(unsigned int i=0;i<n;i++)
      m_vFragment->push_back(m_RawDataBlock[i]);
  }
  setHeader32(NWTot,m_vFragment->size());
  LARBSDBG("Offsets:" << std::endl
           << "Raw Data: " << getVectorHeader16(RawDataBlkOffset) << std::endl
           <<"Low Energy: " << getVectorHeader16(LowEBlkOffset)<< std::endl
           << "High Energy: " << getVectorHeader16(HighEBlkOffset)<< std::endl
           << "Energy-index:" << m_EIndex << std::endl
           << "Filled channels: " << m_ECounter << std::endl);
  clearBlocks();
}
 
 
void  LArRodBlockPhysicsV1::concatinateFEBs( ) 
{
  FEBMAPTYPE::const_iterator feb_it_b=m_mFebBlocks.begin();
  FEBMAPTYPE::const_iterator feb_it_e=m_mFebBlocks.end();
  FEBMAPTYPE::const_iterator feb_it;
  for (feb_it=feb_it_b;feb_it!=feb_it_e;++feb_it) {
    if (feb_it!=feb_it_b) //Not first Feb
      m_pRODblock->resize( m_pRODblock->size()+m_MiddleHeaderSize);
   
    //Add feb data to rod data block
    m_pRODblock->insert (m_pRODblock->end(),
                         feb_it->second.begin(), feb_it->second.end());
  } //end for feb_it
 
  m_mFebBlocks.clear();
}
 
int LArRodBlockPhysicsV1::getNextRawData(int& channelNumber, std::vector<short>& samples, uint32_t& gain)
{
  LARBSDBG("in LArRodBlockPhysicsV1::getNextRawData.");
  LARBSDBG("m_RawDataCounter=" << m_RawDataCounter << "  m_RawDataIndex="<<  m_RawDataIndex); 
  LARBSDBG("m_channelsPerFEB=" << m_channelsPerFEB);
  const int flags=(int) getHeader16(RawDataBlkOffset);
  if (!flags)
    return 0;                                             //Block not existing
  if (m_RawDataCounter>=m_channelsPerFEB)                  //Already beyond maximal number of channels
    return 0; 
  
  LARBSDBG("Flags="<<flags);
  while (!getBit(m_FebBlock+flags,m_RawDataCounter))      //Look for next filled channel
  {
    ++m_RawDataCounter;
    LARBSDBG("RawDataCounter ist now " << m_RawDataCounter);
    if (m_RawDataCounter>=m_channelsPerFEB)              //No more channel availible
      return 0;
  }
  LARBSDBG("Found filled channel at positon " << m_RawDataCounter);
  //Found next filled channel
  channelNumber=(m_RawDataCounter>>4) + ((m_RawDataCounter&0xf)<<3); //Convert ROD to FEB channel ordering
  unsigned int nsamples = getHeader16(NGainNSamples) & 0x00FF;
  LARBSDBG("This run has " << nsamples <<  " samples");
  int index = flags+m_NFlaggingWords+m_RawDataIndex*((int) (nsamples+1)/2);
  LARBSDBG( "index="<<index);
  ++m_RawDataIndex;
  LARBSDBG("In getnextRawData(). index= " << index);
  if((nsamples/2)*2!=nsamples) { //odd number of samples
    const uint32_t& x = m_FebBlock[index];
    gain = x >> 30;
    samples.push_back((short) (x>>2 & 0xfff));
    for(unsigned int i=1;i<=(nsamples-1)/2;i++) {
      const uint32_t& x = m_FebBlock[index+i];
      samples.push_back((short) (x>>2 & 0xfff));
      samples.push_back((short) (x>>18));
    }
  }
  else { //even number of samples
    const uint32_t& x = m_FebBlock[index];
    gain = x >> 30;
    samples.push_back((short) (x>>2 & 0xfff));
 
    samples.push_back((short) ((x>>18) & 0xfff));
   
    for (unsigned int i=1;i<nsamples/2;i++) {
      const uint32_t& x = m_FebBlock[index+i];
      samples.push_back((short) (x>>2 & 0xfff));
      samples.push_back((short) (x >> 18));
    }
  } //end even numer of sample
  ++m_RawDataCounter;
  return 1;
}
 
 
//Sort functions & ordering relation:
template<class RAWDATA>
bool LArRodBlockPhysicsV1::operator () 
  (const RAWDATA* ch1, const RAWDATA* ch2) const
{
  HWIdentifier id1 = ch1->channelID(); 
  HWIdentifier id2 = ch2->channelID(); 
  
  HWIdentifier febId1= m_onlineHelper->feb_Id(id1); 
  HWIdentifier febId2= m_onlineHelper->feb_Id(id2); 
 
  if(febId1 == febId2 ){
    int cId1 =  m_onlineHelper->channel(id1); 
    int cId2 =  m_onlineHelper->channel(id2);
    return FebToRodChannel(cId1) < FebToRodChannel(cId2);
  } 
 
  return febId1 < febId2 ; 
}
 
 
void LArRodBlockPhysicsV1::sortDataVector(std::vector<const LArRawChannel*>& vRC)
{
  std::sort(vRC.begin(),vRC.end(),*this);
}
 
void LArRodBlockPhysicsV1::sortDataVector( std::vector<const LArDigit*>& vDigit) 
{
  std::sort(vDigit.begin(),vDigit.end(),*this);
}