ZdcByteStreamTool Class Reference

Tool to perform ROB fragments to ZdcDigits and from ZdcDigits to raw data conversions. More...

#include <ZdcByteStreamTool.h>

Inheritance diagram for ZdcByteStreamTool:

Collaboration diagram for ZdcByteStreamTool:

Public Member Functions
	ZdcByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
StatusCode	convert (const IROBDataProviderSvc::VROBFRAG &robFrags, ZdcDigitsCollection *ttCollection)
	Convert ROB fragments to ZdcCollection. More...
const std::vector< uint32_t > &	sourceIDs ()
	Return reference to vector with all possible Source Identifiers. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool InterfaceID. More...
static StatusCode	convert (const ZdcDigitsCollection *ttCollection, RawEventWrite *re)
	Convert ZdcCollection to ROB fragments. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef std::map< unsigned int, ZdcDigits * >	ZdcDigitsMap
typedef std::map< unsigned int, const ZdcDigits * >	ZdcDigitsMapConst
typedef IROBDataProviderSvc::VROBFRAG::const_iterator	ROBIterator
typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	RODPointer
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	addCompStats (const std::vector< uint32_t > &stats)
	Add compression stats to totals. More...
void	printCompStats () const
	Print compression stats. More...
void	printVec (const std::vector< int > &vec) const
	Print a vector. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
int	m_dataFormat
	Sub_block header version. More...
int	m_printCompStats
	Compression version. More...
int	m_channels
	Number of channels per module (may not all be used) More...
int	m_crates
	Number of crates. More...
int	m_slinks
	Number of modules per crate (may not all exist) More...
int	m_dfltSlicesLut
	Default number of LUT slices in simulation. More...
int	m_dfltSlicesFadc
	Default number of FADC slices in simulation. More...
int	m_forceSlicesLut
	Force number of LUT slices in bytestream. More...
int	m_forceSlicesFadc
	Force number of FADC slices in bytestream. More...
int	m_pedestal
	Pedestal value. More...
int	m_fadcBaseline
	FADC baseline lower bound. More...
int	m_fadcThreshold
	FADC threshold for super-compressed format. More...
int	m_zeroSuppress
	Zero suppression on input. More...
std::vector< uint32_t >	m_sourceIDs
	ROB source IDs. More...
eformat::SubDetector	m_subDetector
	Sub-detector type. More...
ZdcSrcIdMap *	m_srcIdMap
	Source ID converter. More...
ZdcPpmSubBlock *	m_errorBlock {}
	Trigger tower key provider. More...
DataVector< ZdcPpmSubBlock >	m_ppmBlocks
	Vector for current PPM sub-blocks. More...
std::vector< uint32_t >	m_compStats
	Vector for compression statistics. More...
std::vector< uint32_t > *	m_rodStatus
	ROD Status words. More...
std::map< uint32_t, std::vector< uint32_t > * >	m_rodStatusMap
	ROD status map. More...
const ZdcID *	m_zdcID {}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to perform ROB fragments to ZdcDigits and from ZdcDigits to raw data conversions.

Based on ROD Tool from Level1 from Peter Faulkner

Definition at line 53 of file ZdcByteStreamTool.h.

Member Typedef Documentation

ROBIterator

typedef IROBDataProviderSvc::VROBFRAG::const_iterator ZdcByteStreamTool::ROBIterator

private

Definition at line 82 of file ZdcByteStreamTool.h.

RODPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType ZdcByteStreamTool::RODPointer

private

Definition at line 83 of file ZdcByteStreamTool.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

ZdcDigitsMap

typedef std::map<unsigned int, ZdcDigits*> ZdcByteStreamTool::ZdcDigitsMap

private

Definition at line 80 of file ZdcByteStreamTool.h.

ZdcDigitsMapConst

typedef std::map<unsigned int, const ZdcDigits*> ZdcByteStreamTool::ZdcDigitsMapConst

private

Definition at line 81 of file ZdcByteStreamTool.h.

Constructor & Destructor Documentation

ZdcByteStreamTool()

ZdcByteStreamTool::ZdcByteStreamTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 46 of file ZdcByteStreamTool.cxx.

                                                                        :
            AthAlgTool(type, name, parent),
            //m_version(1),
            //m_compVers(4),
            m_channels(64),
            m_crates(8),
            //m_modules(16),
            m_subDetector(eformat::FORWARD_ZDC),
            m_srcIdMap(nullptr),
            //m_towerKey(0),
            //m_errorBlock(0),
            m_rodStatus(nullptr)
 
{
    declareInterface<ZdcByteStreamTool> (this);
 
    declareProperty("PrintCompStats", m_printCompStats = 0, "Print compressed format statistics");
 
    // Properties for reading bytestream only
    declareProperty("ZeroSuppress", m_zeroSuppress = 0,
                    "Only make trigger towers with non-zero EM or Had energy");
    declareProperty("ROBSourceIDs", m_sourceIDs, "ROB fragment source identifiers");
    declareProperty("PedestalValue", m_pedestal = 10,
                    "Pedestal value - needed for compressed formats 0,1 only");
 
    // Properties for writing bytestream only
    declareProperty("DataFormat", m_dataFormat = 1, "Format identifier (0-3) in sub-block header");
    declareProperty("FADCBaseline", m_fadcBaseline = 0,
                    "FADC baseline lower bound for compressed formats");
    declareProperty("FADCThreshold", m_fadcThreshold = 1,
                    "FADC threshold for super-compressed format");
    declareProperty("SlinksPerCrate", m_slinks = 4, "The number of S-Links per crate");
    declareProperty("SimulSlicesLUT", m_dfltSlicesLut = 1,
                    "The number of LUT slices in the simulation");
    declareProperty("SimulSlicesFADC", m_dfltSlicesFadc = 7,
                    "The number of FADC slices in the simulation");
    declareProperty("ForceSlicesLUT", m_forceSlicesLut = 0,
                    "If >0, the number of LUT slices in bytestream");
    declareProperty("ForceSlicesFADC", m_forceSlicesFadc = 0,
                    "If >0, the number of FADC slices in bytestream");
 
}

Member Function Documentation

addCompStats()

void ZdcByteStreamTool::addCompStats ( const std::vector< uint32_t > &  stats )

private

Add compression stats to totals.

Definition at line 576 of file ZdcByteStreamTool.cxx.

{
    if (stats.empty()) return;
    const int n = stats.size();
    if (m_compStats.empty()) m_compStats.resize(n);
    for (int i = 0; i < n; ++i)
        m_compStats[i] += stats[i];
}

convert() [1/2]

StatusCode ZdcByteStreamTool::convert	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		ZdcDigitsCollection *	ttCollection
	)

Convert ROB fragments to ZdcCollection.

Definition at line 143 of file ZdcByteStreamTool.cxx.

{
 
  const bool debug = msgLvl(MSG::DEBUG);
  //const bool debug = 1;
  const bool verbose = msgLvl(MSG::VERBOSE);
 
 
  if (debug) msg(MSG::DEBUG);
  if (verbose) msg(MSG::VERBOSE);
 
  // Clear trigger tower map
 
  typedef std::map<uint32_t,ZdcDigits*> hashmapType;
  hashmapType digits_map;
 
  // Loop over ROB fragments
  //msg(MSG::INFO) << "ZDC: Inside EVENT !" << endmsg;
  int robCount = 0;
  ROBIterator rob = robFrags.begin();
  ROBIterator robEnd = robFrags.end();
  for (; rob != robEnd; ++rob)
    {
 
      ++robCount;
      if (debug)
    {
      msg() << "ZDC: Treating ROB fragment " << robCount << endmsg;
    }
 
      // Unpack ROD data (slinks)
 
      RODPointer payloadBeg;
      RODPointer payload;
      RODPointer payloadEnd;
      (*rob)->rod_data(payloadBeg);
      payloadEnd = payloadBeg + (*rob)->rod_ndata();
      payload = payloadBeg;
      if (payload == payloadEnd)
    {
      if (debug) msg() << "ZDC: ROB fragment empty" << endmsg;
      continue;
    }
 
      // Check identifier
      const uint32_t sourceID = (*rob)->rod_source_id();
      if (debug)
    {
      if (ZdcSrcIdMap::subDet(sourceID) != m_subDetector || ZdcSrcIdMap::daqOrRoi(sourceID)
          != 0)
        {
          msg() << "ZDC: Wrong source identifier in data: " << MSG::hex << sourceID << MSG::dec
            << endmsg;
        }
    }
      const int rodCrate = ZdcSrcIdMap::crate(sourceID);
      if (debug)
    {
      msg() << "ZDC: Treating crate " << rodCrate << " slink " << ZdcSrcIdMap::slink(sourceID)
        << "From SubDetectorID " << ZdcSrcIdMap::subDet(sourceID) << endmsg;
    }
 
      /* Comment out - this needs adaptation as there are too much L1 dialect in here
       * for now I wnat ot compile/run the bytestream to esd convertion, as I know how
       * to unpack the ppm data
       *
       */
      // First word is User Header
      ZdcUserHeader userHeader(*payload);
      const int minorVersion = (*rob)->rod_version() & 0xffff;
      userHeader.setVersion(minorVersion);
      const int headerWords = userHeader.words();
      if (headerWords != 1 && debug)
    {
      msg() << "ZDC: Unexpected number of user header words: " << headerWords << endmsg;
    }
      // Does this makes sense??? Look above headerWords == 1
      for (int i = 0; i < headerWords; ++i)
    ++payload;
      // triggered slice offsets
      const int trigLut = userHeader.ppmLut();
      const int trigFadc = userHeader.ppmFadc();
      // FADC baseline lower bound
      m_fadcBaseline = userHeader.lowerBound();
      if (debug)
    {
      msg() << "ZDC: Minor format version number: " << MSG::hex << minorVersion << MSG::dec
        << endmsg << "ZDC: LUT triggered slice offset:  " << trigLut << endmsg
        << "ZDC: FADC triggered slice offset: " << trigFadc << endmsg
        << "ZDC: FADC baseline lower bound:   " << m_fadcBaseline << endmsg;
    }
      const int runNumber = (*rob)->rod_run_no() & 0xffffff;
 
      // Find the number of channels per sub-block
      int chanPerSubBlock = 0;
      if (payload != payloadEnd)
    {
      if (ZdcSubBlock::wordType(*payload) != ZdcSubBlock::HEADER)
        {
          msg(MSG::ERROR) << "Missing Sub-block header" << endmsg;
          return StatusCode::FAILURE;
        }
      ZdcPpmSubBlock testBlock;
      //Fix coverity CID 19251
      //payload = testBlock.read(payload, payloadEnd);
      testBlock.read(payload, payloadEnd);
      chanPerSubBlock = testBlock.channelsPerSubBlock();
      if (chanPerSubBlock == 0)
        {
          msg(MSG::ERROR) << "Unsupported version/data format: " << testBlock.version()
                  << "/" << testBlock.format() << endmsg;
          return StatusCode::FAILURE;
        }
      if (m_channels % chanPerSubBlock != 0)
        {
          msg(MSG::ERROR) << "Invalid channels per sub-block: " << chanPerSubBlock << endmsg;
          return StatusCode::FAILURE;
        }
      if (debug) msg() << "Channels per sub-block: " << chanPerSubBlock << endmsg;
    }
      else
    {
      if (debug) msg() << "ROB fragment contains user header only" << endmsg;
      continue;
    }
      const int numSubBlocks = m_channels / chanPerSubBlock;
 
      // Loop over PPMs
 
      payload = payloadBeg;
      for (int i = 0; i < headerWords; ++i)
    ++payload;
      while (payload != payloadEnd)
    {
 
      // Get all sub-blocks for one PPM
 
      int crate = 0;
      int module = 0;
      m_ppmBlocks.clear();
      for (int block = 0; block < numSubBlocks; ++block)
        {
          if (ZdcSubBlock::wordType(*payload) != ZdcSubBlock::HEADER
          || ZdcPpmSubBlock::errorBlock(*payload))
        {
          msg(MSG::ERROR) << "Unexpected data sequence" << endmsg;
          return StatusCode::FAILURE;
        }
          if (chanPerSubBlock != m_channels && ZdcSubBlock::seqno(*payload) != block
          * chanPerSubBlock)
        {
          if (debug)
            {
              msg() << "Unexpected channel sequence number: "
                << ZdcSubBlock::seqno(*payload) << " expected " << block
            * chanPerSubBlock << endmsg;
            }
          if (!m_ppmBlocks.empty()) break;
          else
            {
              if (!debug)
            {
              msg(MSG::ERROR) << "Unexpected channel sequence number" << endmsg;
            }
              return StatusCode::FAILURE;
            }
        }
          ZdcPpmSubBlock* const subBlock = new ZdcPpmSubBlock();
          m_ppmBlocks.push_back(subBlock);
          payload = subBlock->read(payload, payloadEnd);
          if (block == 0)
        {
          crate = subBlock->crate();
          module = subBlock->module();
          if (debug)
            {
              msg() << "Module " << module << endmsg;
              if (crate != rodCrate)
            {
              msg() << "Inconsistent crate number in ROD source ID" << endmsg;
            }
            }
        }
          else
        {
          if (subBlock->crate() != crate)
            {
              msg(MSG::ERROR) << "Inconsistent crate number in sub-blocks" << endmsg;
              return StatusCode::FAILURE;
            }
          if (subBlock->module() != module)
            {
              msg(MSG::ERROR) << "Inconsistent module number in sub-blocks" << endmsg;
              return StatusCode::FAILURE;
            }
        }
          if (payload == payloadEnd && block != numSubBlocks - 1)
        {
          if (debug) msg() << "Premature end of data" << endmsg;
          break;
        }
        }
 
      // Is there an error block?
 
      //delete m_errorBlock;
      //m_errorBlock = 0;
      m_errorBlock->clear();
      if (payload != payloadEnd)
        {
          if (ZdcSubBlock::wordType(*payload) == ZdcSubBlock::HEADER
          && ZdcPpmSubBlock::errorBlock(*payload))
        {
          if (debug) msg() << "Error block found" << endmsg;
          //m_errorBlock = new ZdcPpmSubBlock();
          payload = m_errorBlock->read(payload, payloadEnd);
          if (m_errorBlock->crate() != crate)
            {
              msg(MSG::ERROR) << "Inconsistent crate number in error block" << endmsg;
              return StatusCode::FAILURE;
            }
          if (m_errorBlock->module() != module)
            {
              msg(MSG::ERROR) << "Inconsistent module number in error block" << endmsg;
              return StatusCode::FAILURE;
            }
          if (m_errorBlock->dataWords() && !m_errorBlock->unpack())
            {
              if (debug)
            {
              std::string errMsg(m_errorBlock->unpackErrorMsg());
              msg() << "Unpacking error block failed: " << errMsg << endmsg;
            }
            }
          //delete m_errorBlock;
        }
        }
 
      // Loop over sub-blocks and fill trigger towers
 
      const int actualSubBlocks = m_ppmBlocks.size();
      for (int block = 0; block < actualSubBlocks; ++block)
        {
          ZdcPpmSubBlock* const subBlock = m_ppmBlocks[block];
          subBlock->setLutOffset(trigLut);
          subBlock->setFadcOffset(trigFadc);
          subBlock->setPedestal(m_pedestal);
          subBlock->setFadcBaseline(m_fadcBaseline);
          subBlock->setRunNumber(runNumber);
          if (debug)
        {
          msg() << "Unpacking sub-block version/format/seqno: " << subBlock->version()
            << "/" << subBlock->format() << "/" << subBlock->seqno() << endmsg;
        }
          if (subBlock->dataWords() && !subBlock->unpack())
        {
          if (debug)
            {
              std::string errMsg(subBlock->unpackErrorMsg());
              msg() << "Unpacking PPM sub-block failed: " << errMsg << endmsg;
            }
        }
          if (m_printCompStats) addCompStats(subBlock->compStats());
          for (int chan = 0; chan < chanPerSubBlock; ++chan)
        {
          const int channel = block * chanPerSubBlock + chan;
          std::vector<int> lut;
          std::vector<int> fadc;
          std::vector<int> bcidLut;
          std::vector<int> bcidFadc;
          subBlock->ppmData(channel, lut, fadc, bcidLut, bcidFadc);
//        int trigLutKeep = trigLut;
//        int trigFadcKeep = trigFadc;
          if (lut.size() < size_t(trigLut + 1))
            {
              if (debug)
            {
              msg() << "Triggered LUT slice from header "
                << "inconsistent with number of slices: " << trigLut << ", "
                << lut.size() << ", reset to 0" << endmsg;
            }
//            trigLutKeep = 0;
            }
          if (fadc.size() < size_t(trigFadc + 1))
            {
              if (debug)
            {
              msg() << "Triggered FADC slice from header "
                << "inconsistent with number of slices: " << trigFadc << ", "
                << fadc.size() << ", reset to 0" << endmsg;
            }
//            trigFadcKeep = 0;
            }
          /*
            LVL1::DataError errorBits(0);
            if (m_errorBlock)
            {
            errorBits.set(LVL1::DataError::PPMErrorWord,
            m_errorBlock->ppmError(channel));
            errorBits.set(LVL1::DataError::SubStatusWord, m_errorBlock->subStatus());
            }
            else
            {
            errorBits.set(LVL1::DataError::PPMErrorWord, subBlock->ppmError(channel));
            const ZdcPpmSubBlock* const lastBlock = m_ppmBlocks[actualSubBlocks - 1];
            errorBits.set(LVL1::DataError::SubStatusWord, lastBlock->subStatus());
            }
            // Wrong bit set for compressed formats 1.01 to 1.03
            if (subBlock->format() > 1 && subBlock->seqno() < 4)
            {
            errorBits.set(LVL1::DataError::ModuleError, (errorBits.error()
            >> (LVL1::DataError::ModuleError + 1)) & 0x1);
            }
            const int error = errorBits.error();
          */
          // Only save non-zero data
 
          const bool any = std::accumulate(lut.begin(), lut.end(), 0)
            || std::accumulate(fadc.begin(), fadc.end(), 0)
            || std::accumulate(bcidLut.begin(), bcidLut.end(), 0)
            || std::accumulate(bcidFadc.begin(), bcidFadc.end(), 0);
 
 
          // Channel as unpacked is a SLink channel ordering, which is different
          // from PPM channel ordering
          // the sequence is :
          // All channel A MCM
          // All channel D MCM
          // All channel B MCM
          // All channel C MCM
          Identifier chan_id;
 
          int ppmChannel = subBlock->getPpmChannel(channel);
 
          msg(MSG::DEBUG) << "--> ZCS: " << ZdcCablingService::getInstance() << endmsg;
          chan_id = ZdcCablingService::getInstance()->h2s_channel_id(module, ppmChannel);
 
          const uint32_t chan_hash = chan_id.get_identifier32().get_compact();
          msg(MSG::DEBUG) << "chan_hash = " << chan_hash << endmsg;
 
          //Change after uncommenting the above
          //if (any || error)
          if (any)
            {
              int gain  = ZdcCablingService::getInstance()->hwid2gain(module,ppmChannel);
              int delay = ZdcCablingService::getInstance()->hwid2delay(module,ppmChannel);
              if (debug)
            {
              msg(MSG::DEBUG) << endmsg;
              msg(MSG::DEBUG) <<" --------------------------------------" << endmsg;
              msg(MSG::DEBUG) <<
                "--> ZDC: [SubDet., Crate, Mod., Slink Chn., PPM Chan.] ";
              msg(MSG::DEBUG) <<
                "[" << m_subDetector << ", " << crate << ", " <<
                module << ", " << channel << "," << ppmChannel << "]" << endmsg;
 
              msg(MSG::DEBUG) << "--> ZDC: LUT:      ";
              printVec(lut);
              msg(MSG::DEBUG) << endmsg;
 
              msg(MSG::DEBUG) << "--> ZDC: FADC:     ";
              printVec(fadc);
              msg(MSG::DEBUG) << endmsg;
 
              msg(MSG::DEBUG) << "--> ZDC: bcidLUT:  ";
              printVec(bcidLut);
              msg(MSG::DEBUG) << endmsg;
 
              msg(MSG::DEBUG) << "--> ZDC: bcidFADC: ";
              printVec(bcidFadc);
              msg(MSG::DEBUG) << endmsg;
 
              msg(MSG::DEBUG) << "--> ZDC ID: " << chan_id.getString() << endmsg;
              msg(MSG::DEBUG) << "--> ID side: " << m_zdcID->side(chan_id) << endmsg;
              msg(MSG::DEBUG) << "--> ID module: " << m_zdcID->module(chan_id) << endmsg;
              msg(MSG::DEBUG) << "--> ID type: " << m_zdcID->type(chan_id) << endmsg;
              msg(MSG::DEBUG) << "--> ID channel: " << m_zdcID->channel(chan_id) << endmsg;
 
              msg(MSG::DEBUG) << "gain=" << gain << " delay=" << delay << endmsg;
 
              msg(MSG::DEBUG) <<" --------------------------------------" << endmsg;
 
            }
 
              hashmapType::iterator iter = digits_map.find(chan_hash);
              if (iter == digits_map.end())
            {
              digits_map.insert(std::pair<uint32_t,ZdcDigits*>(chan_hash,new ZdcDigits(chan_id)));
              iter = digits_map.find(chan_hash);
            }
              if (iter != digits_map.end())
            {
              if (gain==0&&delay==0) (*iter).second->set_digits_gain0_delay0(fadc);
              if (gain==1&&delay==0) (*iter).second->set_digits_gain1_delay0(fadc);
              if (gain==0&&delay==1) (*iter).second->set_digits_gain0_delay1(fadc);
              if (gain==1&&delay==1) (*iter).second->set_digits_gain1_delay1(fadc);
            }
 
            }
        }
        }
    }
    }
 
  hashmapType::iterator iter = digits_map.begin();
  hashmapType::iterator iter_end = digits_map.end();
 
  while (iter != iter_end)
    {
      ttCollection->push_back((*iter).second);
      ++iter;
    }
 
  msg(MSG::DEBUG) << "-->ZDC: Collection has " << ttCollection->size() << " elements " << endmsg;
 
  return StatusCode::SUCCESS;
}

convert() [2/2]

StatusCode ZdcByteStreamTool::convert ( const ZdcDigitsCollection *  ttCollection, RawEventWrite *  re  )

static

Convert ZdcCollection to ROB fragments.

Definition at line 565 of file ZdcByteStreamTool.cxx.

{
        //if (re) ttCollection->size();
    //See PpmByteStreamTool for a implementation
    return StatusCode::SUCCESS;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                 {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode ZdcByteStreamTool::finalize ( )

overridevirtual

Definition at line 125 of file ZdcByteStreamTool.cxx.

{
    if (m_printCompStats && msgLvl(MSG::INFO))
    {
        msg(MSG::INFO);
        printCompStats();
    }
 
    delete m_rodStatus;
    delete m_errorBlock;
    //delete m_towerKey;
    delete m_srcIdMap;
    return StatusCode::SUCCESS;
}

initialize()

StatusCode ZdcByteStreamTool::initialize ( )

overridevirtual

Definition at line 93 of file ZdcByteStreamTool.cxx.

{
    /*
     * This would be used for crate/module/channel to eta/phi/layer mappings
    StatusCode sc = m_zdcMaps.retrieve();
    if (sc.isFailure())
    {
        msg(MSG::ERROR) << "Failed to retrieve tool " << m_zdcMaps << endmsg;
        return sc;
    }
    else msg(MSG::INFO) << "Retrieved tool " << m_zdcMaps << endmsg;
    */
    m_srcIdMap = new ZdcSrcIdMap();
    m_errorBlock = new ZdcPpmSubBlock();
    m_rodStatus = new std::vector<uint32_t>(2);
 
    const ZdcID* zdcID = nullptr;
    if (detStore()->retrieve( zdcID ).isFailure() ) {
      msg(MSG::ERROR) << "execute: Could not retrieve ZdcID object from the detector store" << endmsg;
      return StatusCode::FAILURE;
    }
    else {
      msg(MSG::DEBUG) << "execute: retrieved ZdcID" << endmsg;
    }
    m_zdcID = zdcID;
 
    return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & ZdcByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

Definition at line 40 of file ZdcByteStreamTool.cxx.

{
    return IID_IZdcByteStreamTool;
}

msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

printCompStats()

void ZdcByteStreamTool::printCompStats ( ) const

private

Print compression stats.

Definition at line 588 of file ZdcByteStreamTool.cxx.

{
    msg() << "Compression stats format/count: ";
    const int n = m_compStats.size();
    for (int i = 0; i < n; ++i)
    {
        msg() << " " << i << "/" << m_compStats[i];
    }
    msg() << endmsg;
}

printVec()

void ZdcByteStreamTool::printVec ( const std::vector< int > &  vec ) const

private

Print a vector.

Definition at line 622 of file ZdcByteStreamTool.cxx.

{
    std::vector<int>::const_iterator pos;
    //msg() << "-----> " ;
    for (pos = vec.begin(); pos != vec.end(); ++pos)
    {
        if (pos != vec.begin()) msg() << ",";
        msg() << *pos;
    }
    //msg() << endmsg;
}

renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sourceIDs()

const std::vector< uint32_t > & ZdcByteStreamTool::sourceIDs

(

)

Return reference to vector with all possible Source Identifiers.

Definition at line 602 of file ZdcByteStreamTool.cxx.

{
  if (m_sourceIDs.empty()) {
    const int maxlinks = ZdcSrcIdMap::maxSlinks();
    for (int crate = 0; crate < m_crates; ++crate) {
      for (int slink = 0; slink < maxlinks; ++slink) {
        const int daqOrRoi = 0;
        const uint32_t rodId = ZdcSrcIdMap::getRodID(crate, slink, daqOrRoi,
                                                            m_subDetector);
        const uint32_t robId = ZdcSrcIdMap::getRobID(rodId);
        m_sourceIDs.push_back(robId);
      }
    }
  }
  return m_sourceIDs;
}

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_channels

int ZdcByteStreamTool::m_channels

private

Number of channels per module (may not all be used)

Definition at line 101 of file ZdcByteStreamTool.h.

m_compStats

std::vector<uint32_t> ZdcByteStreamTool::m_compStats

private

Vector for compression statistics.

Definition at line 135 of file ZdcByteStreamTool.h.

m_crates

int ZdcByteStreamTool::m_crates

private

Number of crates.

Definition at line 103 of file ZdcByteStreamTool.h.

m_dataFormat

int ZdcByteStreamTool::m_dataFormat

private

Sub_block header version.

Data compression format

Definition at line 95 of file ZdcByteStreamTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_dfltSlicesFadc

int ZdcByteStreamTool::m_dfltSlicesFadc

private

Default number of FADC slices in simulation.

Definition at line 111 of file ZdcByteStreamTool.h.

m_dfltSlicesLut

int ZdcByteStreamTool::m_dfltSlicesLut

private

Default number of LUT slices in simulation.

Definition at line 109 of file ZdcByteStreamTool.h.

m_errorBlock

ZdcPpmSubBlock* ZdcByteStreamTool::m_errorBlock {}

private

Trigger tower key provider.

Definition at line 131 of file ZdcByteStreamTool.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_fadcBaseline

int ZdcByteStreamTool::m_fadcBaseline

private

FADC baseline lower bound.

Definition at line 119 of file ZdcByteStreamTool.h.

m_fadcThreshold

int ZdcByteStreamTool::m_fadcThreshold

private

FADC threshold for super-compressed format.

Definition at line 121 of file ZdcByteStreamTool.h.

m_forceSlicesFadc

int ZdcByteStreamTool::m_forceSlicesFadc

private

Force number of FADC slices in bytestream.

Definition at line 115 of file ZdcByteStreamTool.h.

m_forceSlicesLut

int ZdcByteStreamTool::m_forceSlicesLut

private

Force number of LUT slices in bytestream.

Definition at line 113 of file ZdcByteStreamTool.h.

m_pedestal

int ZdcByteStreamTool::m_pedestal

private

Pedestal value.

Definition at line 117 of file ZdcByteStreamTool.h.

m_ppmBlocks

DataVector<ZdcPpmSubBlock> ZdcByteStreamTool::m_ppmBlocks

private

Vector for current PPM sub-blocks.

Definition at line 133 of file ZdcByteStreamTool.h.

m_printCompStats

int ZdcByteStreamTool::m_printCompStats

private

Compression version.

Compression statistics print flag

Definition at line 99 of file ZdcByteStreamTool.h.

m_rodStatus

std::vector<uint32_t>* ZdcByteStreamTool::m_rodStatus

private

ROD Status words.

Definition at line 137 of file ZdcByteStreamTool.h.

m_rodStatusMap

std::map<uint32_t, std::vector<uint32_t>*> ZdcByteStreamTool::m_rodStatusMap

private

ROD status map.

Definition at line 139 of file ZdcByteStreamTool.h.

m_slinks

int ZdcByteStreamTool::m_slinks

private

Number of modules per crate (may not all exist)

Number of slinks per crate when writing out bytestream

Definition at line 107 of file ZdcByteStreamTool.h.

m_sourceIDs

std::vector<uint32_t> ZdcByteStreamTool::m_sourceIDs

private

ROB source IDs.

Definition at line 125 of file ZdcByteStreamTool.h.

m_srcIdMap

ZdcSrcIdMap* ZdcByteStreamTool::m_srcIdMap

private

Source ID converter.

Definition at line 129 of file ZdcByteStreamTool.h.

m_subDetector

eformat::SubDetector ZdcByteStreamTool::m_subDetector

private

Sub-detector type.

Definition at line 127 of file ZdcByteStreamTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_zdcID

const ZdcID* ZdcByteStreamTool::m_zdcID {}

private

Definition at line 141 of file ZdcByteStreamTool.h.

m_zeroSuppress

int ZdcByteStreamTool::m_zeroSuppress

private

Zero suppression on input.

Definition at line 123 of file ZdcByteStreamTool.h.

---

The documentation for this class was generated from the following files:

• ZdcByteStreamTool.h
• ZdcByteStreamTool.cxx