ZdcByteStreamReadV1V2Tool Class Reference

Tool to perform ROB fragments to trigger towers and trigger towers to raw data conversions. More...

#include <ZdcByteStreamReadV1V2Tool.h>

Inheritance diagram for ZdcByteStreamReadV1V2Tool:

Collaboration diagram for ZdcByteStreamReadV1V2Tool:

Classes
class	BitReader
struct	State

Public Member Functions
	ZdcByteStreamReadV1V2Tool (const std::string &name)
virtual	~ZdcByteStreamReadV1V2Tool ()
virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function.
virtual StatusCode	finalize ()
StatusCode	convert (const IROBDataProviderSvc::VROBFRAG &robFrags, xAOD::TriggerTowerContainer *const ttCollection) const
	Convert ROB fragments to trigger towers.
StatusCode	convert (const IROBDataProviderSvc::VROBFRAG &robFrags, ZdcDigitsCollection *zdcCollection) const
StatusCode	convert (xAOD::TriggerTowerContainer *const ttCollection) const
StatusCode	convert (const std::string &sgKey, xAOD::TriggerTowerContainer *const ttCollection) const
ZdcDigitsCollection *	convertTT2ZD (xAOD::TriggerTowerContainer *const ttCollection) const
const std::vector< uint32_t > &	ppmSourceIDs (const std::string &sgKey) const
	Return reference to vector with all possible Source Identifiers.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
enum class	RequestType { PPM , CPM , CMX }
typedef IROBDataProviderSvc::VROBFRAG::const_iterator	ROBIterator
typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	ROBPointer
typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	RODPointer
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	processRobFragment_ (State &state, const ROBIterator &robFrag, const RequestType &requestedType) const
StatusCode	processPpmWord_ (State &state, uint32_t word, int indata) const
StatusCode	processPpmBlock_ (State &state) const
StatusCode	processPpmBlockR4V1_ (State &state) const
StatusCode	processPpmBlockR3V1_ (State &state) const
StatusCode	processPpmStandardR4V1_ (State &state) const
StatusCode	processPpmStandardR3V1_ (State &state) const
StatusCode	processPpmStandardR3V1_ (State &state, uint32_t word, int indata) const
StatusCode	processPpmCompressedR3V1_ (State &state) const
std::vector< uint16_t >	getPpmAdcSamplesR3_ (State &state, BitReader &br, uint8_t format, uint8_t minIndex) const
StatusCode	processPpmCompressedR4V1_ (State &state) const
void	interpretPpmHeaderR4V1_ (BitReader &br, uint8_t numAdc, int8_t &encoding, int8_t &minIndex) const
std::vector< uint16_t >	getPpmAdcSamplesR4_ (State &state, BitReader &br, uint8_t encoding, uint8_t minIndex) const
StatusCode	processPpmNeutral_ (State &state) const
StatusCode	addTriggerTowerV2_ (State &state, uint8_t crate, uint8_t module, uint8_t channel, const std::vector< uint8_t > &lcpVal, const std::vector< uint8_t > &lcpBcidVec, const std::vector< uint8_t > &ljeVal, const std::vector< uint8_t > &ljeSat80Vec, const std::vector< uint16_t > &adcVal, const std::vector< uint8_t > &adcExt, const std::vector< int16_t > &pedCor, const std::vector< uint8_t > &pedEn) const
StatusCode	addTriggerTowerV1_ (State &state, uint8_t crate, uint8_t module, uint8_t channel, const std::vector< uint16_t > &luts, const std::vector< uint16_t > &fadc) const
StatusCode	addTriggerTowerV1_ (State &state, uint8_t crate, uint8_t module, uint8_t channel, const std::vector< uint8_t > &luts, const std::vector< uint8_t > &lcpBcidVec, const std::vector< uint16_t > &fadc, const std::vector< uint8_t > &bcidExt) const
void	initSourceIDs ()
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< ZdcL1CaloErrorByteStreamTool >	m_errorTool
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
	Service for reading bytestream.
std::vector< uint32_t >	m_ppmSourceIDs
std::vector< uint32_t >	m_ppmSourceIDsMuon
std::vector< uint32_t >	m_ppmSourceIDsSpare
ZdcSrcIdMap *	m_srcIdMap {}
const ZdcID *	m_zdcID {}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to perform ROB fragments to trigger towers and trigger towers to raw data conversions.

Author

alexa.nosp@m.nder.nosp@m..mazu.nosp@m.rov@.nosp@m.cern..nosp@m.ch

Definition at line 39 of file ZdcByteStreamReadV1V2Tool.h.

Member Typedef Documentation

ROBIterator

typedef IROBDataProviderSvc::VROBFRAG::const_iterator ZdcByteStreamReadV1V2Tool::ROBIterator

private

Definition at line 72 of file ZdcByteStreamReadV1V2Tool.h.

ROBPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType ZdcByteStreamReadV1V2Tool::ROBPointer

private

Definition at line 73 of file ZdcByteStreamReadV1V2Tool.h.

RODPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType ZdcByteStreamReadV1V2Tool::RODPointer

private

Definition at line 74 of file ZdcByteStreamReadV1V2Tool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

RequestType

enum class ZdcByteStreamReadV1V2Tool::RequestType

strongprivate

Enumerator
PPM
CPM
CMX

Definition at line 71 of file ZdcByteStreamReadV1V2Tool.h.

{ PPM, CPM, CMX };

Constructor & Destructor Documentation

ZdcByteStreamReadV1V2Tool()

ZdcByteStreamReadV1V2Tool::ZdcByteStreamReadV1V2Tool

(

const std::string &

name

)

Definition at line 74 of file ZdcByteStreamReadV1V2Tool.cxx.

  :
    AsgTool(name),
    m_errorTool("ZdcL1CaloErrorByteStreamTool/ZdcL1CaloErrorByteStreamTool"),
    //m_ppmMaps("LVL1::PpmMappingTool/PpmMappingTool"),
    m_robDataProvider("ROBDataProviderSvc", name) {
  declareInterface<ZdcByteStreamReadV1V2Tool>(this);
  //declareProperty("PpmMappingTool", m_ppmMaps,
  //    "Crate/Module/Channel to Eta/Phi/Layer mapping tool");
  declareProperty("ROBDataProviderSvc", m_robDataProvider,
        "Get ROB source IDs service");
}

~ZdcByteStreamReadV1V2Tool()

virtual ZdcByteStreamReadV1V2Tool::~ZdcByteStreamReadV1V2Tool ( )

inlinevirtual

Definition at line 45 of file ZdcByteStreamReadV1V2Tool.h.

{};

Member Function Documentation

addTriggerTowerV1_() [1/2]

StatusCode ZdcByteStreamReadV1V2Tool::addTriggerTowerV1_ ( State & state, uint8_t crate, uint8_t module, uint8_t channel, const std::vector< uint16_t > & luts, const std::vector< uint16_t > & fadc ) const

private

Definition at line 1035 of file ZdcByteStreamReadV1V2Tool.cxx.

          {
 
    std::vector<uint8_t> lcpVal;
    std::vector<uint8_t> lcpBcidVec;
 
    std::vector<uint16_t> adcVal;
    std::vector<uint8_t> adcExt;
 
    for(auto lut: luts) {
      lcpVal.push_back(BitField::get<uint8_t>(lut, 0, 8));
      lcpBcidVec.push_back(BitField::get<uint8_t>(lut, 8, 3));
    }
 
    for(auto f: fadc) {
      adcExt.push_back(BitField::get<uint8_t>(f, 0, 1));
      adcVal.push_back(BitField::get<uint16_t>(f, 1, 10));
    }
 
   CHECK(addTriggerTowerV1_(state, crate, module, channel, lcpVal, lcpBcidVec,
            adcVal, adcExt));
 
   return StatusCode::SUCCESS;
}

addTriggerTowerV1_() [2/2]

StatusCode ZdcByteStreamReadV1V2Tool::addTriggerTowerV1_ ( State & state, uint8_t crate, uint8_t module, uint8_t channel, const std::vector< uint8_t > & luts, const std::vector< uint8_t > & lcpBcidVec, const std::vector< uint16_t > & fadc, const std::vector< uint8_t > & bcidExt ) const

private

Definition at line 1012 of file ZdcByteStreamReadV1V2Tool.cxx.

          {
 
    std::vector<uint8_t> ljeSat80Vec;
 
    std::vector<int16_t> pedCor;
    std::vector<uint8_t> pedEn;
 
   CHECK(addTriggerTowerV2_(state, crate, module, channel, luts, lcpBcidVec,
            luts , ljeSat80Vec, fadc, bcidExt, pedCor, pedEn)
   );
 
   return StatusCode::SUCCESS;
}

addTriggerTowerV2_()

StatusCode ZdcByteStreamReadV1V2Tool::addTriggerTowerV2_ ( State & state, uint8_t crate, uint8_t module, uint8_t channel, const std::vector< uint8_t > & lcpVal, const std::vector< uint8_t > & lcpBcidVec, const std::vector< uint8_t > & ljeVal, const std::vector< uint8_t > & ljeSat80Vec, const std::vector< uint16_t > & adcVal, const std::vector< uint8_t > & adcExt, const std::vector< int16_t > & pedCor, const std::vector< uint8_t > & pedEn ) const

private

Definition at line 946 of file ZdcByteStreamReadV1V2Tool.cxx.

                                           {
 
  //int layer = 0;
  int error = 0;
  double eta = 0.;
  double phi = 0.;
 
  bool isNotSpare = false; // PAS - just to minimize changing code
  // PAS - not using L1Calo PPMMap
  /*  
  bool isNotSpare = m_ppmMaps->mapping(crate, module, channel, eta, phi, layer);
  if (!isNotSpare && !m_ppmIsRetSpare && !m_ppmIsRetMuon){
    return StatusCode::SUCCESS;
  }
  */
 
  if (!isNotSpare) {
    const int pin  = channel % 16;
    const int asic = channel / 16;
    eta = 16 * crate + module;
    phi = 4 * pin + asic;
  }
 
  uint32_t coolId = ::coolId(crate, module, channel);
  CHECK(state.m_coolIds.count(coolId) == 0);
  state.m_coolIds.insert(coolId);
 
  xAOD::TriggerTower* tt = new xAOD::TriggerTower();
  //std::cout << ZdcToString(*tt) << std::endl;
 
  state.m_triggerTowers->push_back(tt);
  // tt->initialize(
  //         const uint_least32_t& coolId,
  //         const uint_least8_t& layer,
  //         const float& eta,
  //         const float& phi,
  //         const std::vector<uint_least8_t>& lut_cp,
  //         const std::vector<uint_least8_t>& lut_jep,
  //         const std::vector<int_least16_t>& correction,
  //         const std::vector<uint_least8_t>& correctionEnabled,
  //         const std::vector<uint_least8_t>& bcidVec,
  //         const std::vector<uint_least16_t>& adc,
  //         const std::vector<uint_least8_t>& bcidExt,
  //         const std::vector<uint_least8_t>& sat80, 
  //         const uint_least16_t& error,
  //         const uint_least8_t& peak,
  //         const uint_least8_t& adcPeak
  // );
  tt->initialize(coolId, eta, phi, lcpVal, ljeVal, pedCor, pedEn,
      lcpBcidVec, adcVal, adcExt, ljeSat80Vec, error, state.m_caloUserHeader.lut(),
      state.m_caloUserHeader.ppFadc());
  return StatusCode::SUCCESS;
}

convert() [1/4]

StatusCode ZdcByteStreamReadV1V2Tool::convert	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		xAOD::TriggerTowerContainer *const	ttCollection ) const

Convert ROB fragments to trigger towers.

Definition at line 122 of file ZdcByteStreamReadV1V2Tool.cxx.

{
  State state;
  state.m_subDetectorID = eformat::FORWARD_ZDC;
  state.m_triggerTowers = ttCollection;
 
  ROBIterator rob = robFrags.begin();
  ROBIterator robEnd = robFrags.end();
 
  for (; rob != robEnd; ++rob) {
    StatusCode sc = processRobFragment_(state, rob, RequestType::PPM);
    if (!sc.isSuccess()) {
 
    }
  }
  return StatusCode::SUCCESS;
}

convert() [2/4]

StatusCode ZdcByteStreamReadV1V2Tool::convert	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		ZdcDigitsCollection *	zdcCollection ) const

Definition at line 143 of file ZdcByteStreamReadV1V2Tool.cxx.

{
 
  xAOD::TriggerTowerContainer* ttCollection = new xAOD::TriggerTowerContainer;
  xAOD::TriggerTowerAuxContainer* aux = new xAOD::TriggerTowerAuxContainer();
  ttCollection->setStore(aux);
 
  ATH_MSG_DEBUG("Getting TT collection!");
  StatusCode sc = convert(robFrags,ttCollection);
 
  ATH_MSG_DEBUG("Got it!");
 
  if (sc != StatusCode::SUCCESS) {
      ATH_MSG_DEBUG("ZDC TT Conversion failed");
      return sc;
  }
  
  ATH_MSG_DEBUG("convertTT2ZD");
  //convertTT2ZD 'new-s' and returns a bare ptr for ZdcDigitsCollection... 
  //return by value or a unique_ptr would be safer
  ZdcDigitsCollection* zc = convertTT2ZD(ttCollection);  
  ATH_MSG_DEBUG("convertedTT2ZD!  Now copying");
  (*zdcCollection) = (*zc); 
  //...so zc should be deleted
  delete zc; 
  ATH_MSG_DEBUG("Copied!");
 
  return StatusCode::SUCCESS;
}

convert() [3/4]

StatusCode ZdcByteStreamReadV1V2Tool::convert	(	const std::string &	sgKey,
		xAOD::TriggerTowerContainer *const	ttCollection ) const

Definition at line 181 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                         {
 
  //std::cout << "convert " << sgKey << std::endl;
 
  const std::vector<uint32_t>& vID(ppmSourceIDs(sgKey));
 
  // // get ROB fragments
  IROBDataProviderSvc::VROBFRAG robFrags;
  m_robDataProvider->getROBData(Gaudi::Hive::currentContext(), vID, robFrags, "ZdcByteStreamxAODReadTool");
  ATH_MSG_DEBUG("Number of ROB fragments:" << robFrags.size());
 
  CHECK(convert(robFrags, ttCollection));
  return StatusCode::SUCCESS;
}

convert() [4/4]

StatusCode ZdcByteStreamReadV1V2Tool::convert

(

xAOD::TriggerTowerContainer *const

ttCollection

)

const

Definition at line 175 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                         {
  //return convert(LVL1::TrigT1CaloDefs::xAODTriggerTowerLocation, ttCollection);
  return convert("ZdcTriggerTowerContainer", ttCollection);
}

convertTT2ZD()

ZdcDigitsCollection * ZdcByteStreamReadV1V2Tool::convertTT2ZD

(

xAOD::TriggerTowerContainer *const

ttCollection

)

const

Definition at line 1134 of file ZdcByteStreamReadV1V2Tool.cxx.

{
  typedef std::map<uint32_t,ZdcDigits*> hashmapType;
  hashmapType digits_map;
  Identifier chan_id;
 
  for (const xAOD::TriggerTower* tt : *ttCollection)
    {
      uint32_t coolId = tt->coolId();
      uint32_t pin = (coolId>>8) & 0xf;
      uint32_t asic = coolId & 0xf;
      uint32_t slinkChannel = asic*16 + pin;
      uint32_t ppmChannel = slink2ppmChannel[slinkChannel];
 
      uint32_t module = (coolId>>16) & 0xf;
 
      ATH_MSG_DEBUG( "--> ZCS: " << ZdcCablingService::getInstance() << " mod=" << module << " slinkC=" << slinkChannel << " ppmC=" << ppmChannel );
      chan_id = ZdcCablingService::getInstance()->h2s_channel_id(module, ppmChannel);
      
      const uint32_t chan_hash = chan_id.get_identifier32().get_compact();
      int gain  = ZdcCablingService::getInstance()->hwid2gain(module,ppmChannel);
      int delay = ZdcCablingService::getInstance()->hwid2delay(module,ppmChannel);
      
      ATH_MSG_DEBUG("Trying to find chan_hash " << chan_hash << " g" << gain << "d" << delay);
 
      hashmapType::iterator iter = digits_map.find(chan_hash);
      if (iter == digits_map.end())
    {
      ATH_MSG_DEBUG("new channel for " << chan_id);
      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())
    {
      ATH_MSG_DEBUG("new auxdata for " << chan_id);
      if (gain==0&&delay==0) (*iter).second->set_digits_gain0_delay0( tt->adc() );
      if (gain==1&&delay==0) (*iter).second->set_digits_gain1_delay0( tt->adc() );
      if (gain==0&&delay==1) (*iter).second->set_digits_gain0_delay1( tt->adc() );
      if (gain==1&&delay==1) (*iter).second->set_digits_gain1_delay1( tt->adc() );
    }
      
    }
 
  ZdcDigitsCollection* zdcCollection = new ZdcDigitsCollection();
 
  hashmapType::iterator iter = digits_map.begin();
  hashmapType::iterator iter_end = digits_map.end();
 
  while (iter != iter_end)
    {
      /*
      Identifier id = ((*iter).second)->identify();
    std::cout  
    << "side=" << m_zdcID->side(id)
    << " mod=" << m_zdcID->module(id)
    << " type=" << m_zdcID->type(id)
    << " chan=" << m_zdcID->channel(id) 
    << std::endl;
    ((*iter).second)->print();
      */ 
      zdcCollection->push_back((*iter).second);
      ++iter;
    }
 
  return zdcCollection;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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()

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; }

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 ZdcByteStreamReadV1V2Tool::finalize ( )

virtual

Definition at line 115 of file ZdcByteStreamReadV1V2Tool.cxx.

                                               {
  delete m_srcIdMap;
 
  return StatusCode::SUCCESS;
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getPpmAdcSamplesR3_()

std::vector< uint16_t > ZdcByteStreamReadV1V2Tool::getPpmAdcSamplesR3_ ( State & state, BitReader & br, uint8_t format, uint8_t minIndex ) const

private

Definition at line 543 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                         {
 
  std::vector<uint16_t> adc = {0, 0, 0, 0, 0};
  uint8_t minAdc = 0;
 
  for(uint8_t i = 0; i <5; ++i) {
    uint8_t longField = 0;
    uint8_t numBits = 0;
    if (format > 2) {
      longField = br.getField (1);
      numBits = longField == 0? 4: (format * 2);
    } else {
      numBits = i == 0? 4: (format + 2);
    }
 
    if (i == 0) {
      minAdc = br.getField (numBits);
      if (longField == 0) {
        minAdc += state.m_caloUserHeader.ppLowerBound();
      }
    } else {
        adc[i] = minAdc + br.getField (numBits);
    }
  }
 
  if (minIndex == 0) {
    adc[0] = minAdc;
  } else {
    adc[0] = adc[minIndex];
    adc[minIndex] = minAdc;
  }
  return adc;
}

getPpmAdcSamplesR4_()

std::vector< uint16_t > ZdcByteStreamReadV1V2Tool::getPpmAdcSamplesR4_ ( State & state, BitReader & br, uint8_t encoding, uint8_t minIndex ) const

private

Definition at line 831 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                           {
  uint8_t numAdc = state.m_subBlockHeader.nSlice2();
 
  if (encoding == 6) {
    uint16_t val = br.getField (6);
    return std::vector<uint16_t>(numAdc, val);
  } else if ( encoding < 3) {
    std::vector<uint16_t> adc(numAdc, 0);
    uint16_t minAdc = br.getField (5) + state.m_caloUserHeader.ppLowerBound();
    adc[minIndex] = minAdc;
    for(uint8_t i = 1; i < numAdc; ++i) {
      adc[i == minIndex? 0: i] = br.getField (encoding + 2) + minAdc;
    } 
    return adc;   
  } else {
    std::vector<uint16_t> adc(numAdc, 0);
    uint16_t minAdc = br.getField (1)
                      ? br.getField (encoding * 2)
                      : (br.getField (5) + 
                          state.m_caloUserHeader.ppLowerBound());
 
    adc[minIndex] = minAdc;
    for (uint8_t i = 1; i < numAdc; ++i) {
      adc[minIndex == i? 0: i] = br.getField (
                              br.getField (1)? encoding * 2: 4
                            ) + minAdc;
    }
   return adc;
  }
}

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

initialize()

StatusCode ZdcByteStreamReadV1V2Tool::initialize ( void )

virtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 91 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                 {
 
  m_srcIdMap = new ZdcSrcIdMap();
  CHECK(m_errorTool.retrieve());
  //CHECK(m_ppmMaps.retrieve());
  CHECK(m_robDataProvider.retrieve());
 
  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;
 
  initSourceIDs();
  
  return StatusCode::SUCCESS;
}

initSourceIDs()

void ZdcByteStreamReadV1V2Tool::initSourceIDs ( )

private

Definition at line 1066 of file ZdcByteStreamReadV1V2Tool.cxx.

{
  const int crates = 8;
  m_ppmSourceIDs.clear();
  m_ppmSourceIDsSpare.clear();
  m_ppmSourceIDsMuon.clear();
 
  for (int crate = 0; crate < crates; ++crate) {
    for (int slink = 0; slink < m_srcIdMap->maxSlinks(); ++slink) {
      //const uint32_t rodId = m_srcIdMap->getRodID(crate, slink, 0,
      //    eformat::TDAQ_CALO_PREPROC);
      const uint32_t rodId = m_srcIdMap->getRodID(crate, slink, 0,
                                                  eformat::FORWARD_ZDC);
      const uint32_t robId = m_srcIdMap->getRobID(rodId);
      m_ppmSourceIDs.push_back(robId);
      //std::cout << "robId=" << std::hex << robId << std::dec << std::endl;
      if (crate > 1 && crate < 6) {
        m_ppmSourceIDsSpare.push_back(robId);
        if (crate < 4 && slink == 0) {
          m_ppmSourceIDsMuon.push_back(robId);
        }
      }
    }
  }
}

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.

interpretPpmHeaderR4V1_()

void ZdcByteStreamReadV1V2Tool::interpretPpmHeaderR4V1_ ( BitReader & br, uint8_t numAdc, int8_t & encoding, int8_t & minIndex ) const

private

Definition at line 781 of file ZdcByteStreamReadV1V2Tool.cxx.

                                            {
 uint8_t minHeader = 0;
 
  if (numAdc == 5) {
    minHeader = br.getField (4);
    //ATH_MSG_DEBUG("SASHA: minHeader=" << int(minHeader));
    minIndex = minHeader % 5;
    if (minHeader < 15){ // Encodings 0-5
      if (minHeader < 10) {
        encoding = minHeader / 5;
      } else {
        encoding = 2 + br.getField (2);
      }
    } else {
      encoding = 6;
    }
  } else {
      uint8_t numBits = 0;
      if (numAdc ==3 ) {
        numBits = 2;
      } else if (numAdc == 7) {
        numBits = 3;
      } else if (numAdc < 16) {
        numBits = 4;
      }
 
      if (numBits > 0) {
        uint8_t fieldSize = 1 << numBits;
        minHeader = br.getField (numBits);
        uint8_t encValue = fieldSize - 1;
        if (minHeader == encValue) { // Encoding 6
          encoding = 6;
          minIndex = 0; 
        } else {
          minHeader += br.getField (2) << numBits;
          minIndex = minHeader % fieldSize;
          encValue = 3 * fieldSize;
 
          if (minHeader < encValue) { // Encodings 0-2
            encoding = minHeader / fieldSize;
          } else {
            encoding = 3 + br.getField (2);
          }
        }
      }
  }
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

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.

ppmSourceIDs()

const std::vector< uint32_t > & ZdcByteStreamReadV1V2Tool::ppmSourceIDs

(

const std::string &

sgKey

)

const

Return reference to vector with all possible Source Identifiers.

Definition at line 1094 of file ZdcByteStreamReadV1V2Tool.cxx.

{
  if (sgKey.find("Muon") != std::string::npos) {
    return m_ppmSourceIDsMuon;
  }
  else if (sgKey.find("Spare") != std::string::npos) {
    return m_ppmSourceIDsSpare;
  }
 
  return m_ppmSourceIDs;
}

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

processPpmBlock_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmBlock_ ( State & state ) const

private

Definition at line 335 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                         {
  if (!state.m_ppBlock.empty()) {
    if (state.m_subBlockHeader.format() == 0) {
      StatusCode sc = processPpmNeutral_(state);
      state.m_ppBlock.clear();
      CHECK(sc);
      return sc;
    }
 
    if (state.m_verCode == 0x31) {
      StatusCode sc = processPpmCompressedR3V1_(state);
      state.m_ppBlock.clear();
      CHECK(sc);
      return sc;
    }
 
    if (state.m_verCode == 0x41 || state.m_verCode == 0x42) {
      StatusCode sc = processPpmBlockR4V1_(state);
      state.m_ppBlock.clear();
      CHECK(sc);
      return sc;
    }
  }
 
  if (!state.m_ppLuts.empty()) {
    if (state.m_verCode == 0x21 || state.m_verCode == 0x31) {
      StatusCode sc = processPpmBlockR3V1_(state);
      state.m_ppLuts.clear();
      state.m_ppFadcs.clear();
      CHECK(sc);
      return sc;
    }
    ATH_MSG_ERROR("Unknown PPM subheader format '" 
      << int(state.m_subBlockHeader.format()) 
      << "' for rob version '"
      << MSG::hex << int(state.m_verCode) 
      << MSG::dec << "'" );
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

processPpmBlockR3V1_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmBlockR3V1_ ( State & state ) const

private

Definition at line 864 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                             {
  if (state.m_subBlockHeader.format() == 1) {
    CHECK(processPpmStandardR3V1_(state));
    return StatusCode::SUCCESS;
  } else if (state.m_subBlockHeader.format() >= 2) {
    // TODO: convert compressed
    return StatusCode::FAILURE;
  }
  return StatusCode::FAILURE;
}

processPpmBlockR4V1_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmBlockR4V1_ ( State & state ) const

private

Definition at line 618 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                             {
  if (state.m_subBlockHeader.format() == 1) {
    CHECK(processPpmStandardR4V1_(state));
    return StatusCode::SUCCESS;
  } else if (state.m_subBlockHeader.format() >= 2) {
    // TODO: convert compressed
    CHECK(processPpmCompressedR4V1_(state));
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

processPpmCompressedR3V1_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmCompressedR3V1_ ( State & state ) const

private

Definition at line 460 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                                  {
  uint8_t chan = 0;
  BitReader br (state.m_ppBlock);
  try{
    while (chan < 64) {
      uint8_t present = 1;
      if (state.m_subBlockHeader.format() == 3) {
        present = br.getField (1); 
      } 
 
      if (present == 1) {
        uint8_t lutVal = 0;
        uint8_t fmt = 6;
        uint8_t lutSat=0;
        uint8_t lutExt=0;
        uint8_t lutPeak=0;
 
        std::vector<uint16_t> adcVal = {0 , 0, 0, 0, 0};
        std::vector<uint8_t> adcExt = {0 , 0, 0, 0, 0};
 
        uint8_t minHeader = br.getField (4);
        uint8_t minIndex = minHeader % 5;
        if (minHeader < 15) { // Formats 0-5
          if (minHeader < 10) { // Formats 0-1
            fmt = minHeader / 5;
          } else { // Formats 2-5
            fmt = 2 + br.getField (2);
            uint8_t haveLut = br.getField (1);
            if (fmt == 2) {
              if (haveLut == 1) {
                lutVal = br.getField (3);
                lutPeak = 1; // Even if LutVal==0 it seems
              }
            } else {
              uint8_t haveExt = br.getField (1);
              if (haveLut == 1) {
                lutVal = br.getField (8);
                lutExt = br.getField (1);
                lutSat = br.getField (1);
                lutPeak = br.getField (1);
              }
 
              if (haveExt == 1){
                for(uint8_t i = 0; i < 5; ++i) {
                  adcExt[i] = br.getField (1);
                }
              } else {
                adcExt[2] = lutExt;
              }
            }
          }
          adcVal = getPpmAdcSamplesR3_(state, br, fmt, minIndex);
        } else {
          uint8_t haveAdc = br.getField (1);
          if (haveAdc == 1) {
            uint16_t val = br.getField (10);
            for(uint8_t i = 0; i < 5; ++i) {
                  adcVal[i] = val;
            }
          }
        }
        // Add Trigger Tower
        //std::vector<uint8_t> luts = {lutVal};
        CHECK(addTriggerTowerV1_(
          state,
          state.m_subBlockHeader.crate(),
          state.m_subBlockHeader.module(),
          chan,
          std::vector<uint8_t> {lutVal},
          std::vector<uint8_t> {uint8_t(lutExt | (lutSat << 1) | (lutPeak << 2))},
          adcVal,
          adcExt
        ));
      }
      chan++;
    }
  }catch (const std::out_of_range& ex) {
      ATH_MSG_WARNING("Excess Data in Sub-block");
      m_errorTool->rodError(state.m_rodSourceId, ZdcL1CaloSubBlock::UNPACK_EXCESS_DATA);
  } 
  return StatusCode::SUCCESS;
}

processPpmCompressedR4V1_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmCompressedR4V1_ ( State & state ) const

private

Definition at line 630 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                                  {
  BitReader br (state.m_ppBlock);
 
  uint8_t numAdc = state.m_subBlockHeader.nSlice2();
  uint8_t numLut = state.m_subBlockHeader.nSlice1();
  int16_t pedCorBase = -20;
 
 
  // for(size_t i = 0; i < state.m_ppBlock.size(); ++i) {
  //   std::bitset<32> x(state.m_ppBlock[i]);
  //   std::cout << i << " " << x << std::endl;
  // }
 
  try{
    for(uint8_t chan = 0; chan < 64; ++chan) {
      uint8_t present = 1;
 
      std::vector<uint8_t> haveLut(numLut, 0);
      std::vector<uint8_t> lcpVal(numLut, 0);
      
      std::vector<uint8_t> lcpExt(numLut, 0);
      std::vector<uint8_t> lcpSat(numLut, 0);
      std::vector<uint8_t> lcpPeak(numLut, 0);
      std::vector<uint8_t> lcpBcidVec(numLut, 0);
      
      std::vector<uint8_t> ljeVal(numLut, 0);
      
      std::vector<uint8_t> ljeLow(numLut, 0);
      std::vector<uint8_t> ljeHigh(numLut, 0);
      std::vector<uint8_t> ljeRes(numLut, 0);
      std::vector<uint8_t> ljeSat80Vec(numLut, 0);
 
      std::vector<uint16_t> adcVal(numAdc, 0);
      std::vector<uint8_t> adcExt(numAdc, 0);
      std::vector<int16_t> pedCor(numLut, 0);
      std::vector<uint8_t> pedEn(numLut, 0);
  
      int8_t encoding = -1;
      int8_t minIndex = -1;
 
      if (state.m_subBlockHeader.format() == 3) {
        present = br.getField (1);
      }
      if (present == 1) {
        interpretPpmHeaderR4V1_(br, numAdc, encoding, minIndex);
        CHECK((encoding != -1) && (minIndex != -1));
        // First get the LIT related quantities
        if (encoding < 3) {
          // Get the peal finder bits
          for(uint i=0; i < numLut; ++i) {
            lcpPeak[i] = br.getField (1);
          }
          // Get Sat80 low bits
          if (encoding > 0) {
            for (uint8_t i = 0; i < numLut; ++i) {
              ljeLow[i] = br.getField (1);
            }
          }
          // Get LutCP and LutJEP values (these are
          // only present if the peak finder is set).
          if (encoding == 2) {
            for (uint8_t i = 0; i < numLut; ++i) {
              if (lcpPeak[i] == 1) {
                lcpVal[i] = br.getField (4);
              }
            }
            for(uint8_t i = 0; i < numLut; ++i) {
              if (lcpPeak[i] == 1){
                ljeVal[i] = br.getField (3);
              }
            }
          }            
        } else if (encoding < 6) {
          // Get LUT presence flag for each LUT slice. 
          for(uint8_t i = 0; i < numLut; ++i){
            haveLut[i] = br.getField (1);
          }
 
          // Get external BCID bits (if block is present).
          uint8_t haveExt = br.getField (1);
 
          if (haveExt == 1) {
            for (uint8_t i = 0; i < numAdc; ++i) {
              adcExt[i] = br.getField (1);
            }
          }
          
          for(uint8_t i = 0; i < numLut; ++i){
            if (haveLut[i] == 1) {
              lcpVal[i] = br.getField (8);
              lcpExt[i] = br.getField (1);
              lcpSat[i] = br.getField (1);
              lcpPeak[i] = br.getField (1);
            }
          }
          // Get JEP LUT values and corresponding bits.         
          for(uint8_t i = 0; i < numLut; ++i){
            if (haveLut[i] == 1) {
              ljeVal[i] = br.getField (8);
              ljeLow[i] = br.getField (1);
              ljeHigh[i] = br.getField (1);
              ljeRes[i] = br.getField (1);
            }
          }
  
        }
 
      }
 
      if (minIndex < 0)
        return StatusCode::FAILURE;
 
       // Next get the ADC related quantities (all encodings).
      adcVal = getPpmAdcSamplesR4_(state, br, encoding, minIndex);
      // Finally get the pedestal correction.
      if ((encoding < 3) || (encoding == 6)) {
        for (uint8_t i = 0; i < numLut; ++i)
        {
          pedCor[i] = br.getField (6) + pedCorBase;
          if (state.m_subBlockHeader.compVer() > 0) {
            pedEn[i] = 1;
          }
        }
      } else {
        // At the moment there is an enabled bit for every LUT slice
        // (even though its really a global flag).
        // The correction values is a twos complement signed value.
        for (uint8_t i = 0; i < numLut; ++i)
        {
          uint16_t val = br.getField (10);
          pedCor[i] = ::pedCorrection(val);
          pedEn[i] = br.getField (1);
        }
      }
 
    for(uint8_t i=0; i < numLut; ++i){
      lcpBcidVec[i] = uint8_t((lcpPeak[i] << 2) | (lcpSat[i] << 1) | lcpExt[i]);
      ljeSat80Vec[i] = uint8_t((ljeRes[i] << 2) | (ljeHigh[i] << 1) | ljeLow[i]); 
    }
    CHECK(addTriggerTowerV2_(state, state.m_subBlockHeader.crate(), state.m_subBlockHeader.module(),
      chan, lcpVal, lcpBcidVec, ljeVal, ljeSat80Vec, adcVal, adcExt, pedCor,
      pedEn));
    }
  } catch (const std::out_of_range& ex) {
      ATH_MSG_WARNING("Excess Data in Sub-block");
      m_errorTool->rodError(state.m_rodSourceId, ZdcL1CaloSubBlock::UNPACK_EXCESS_DATA);
  }
  return StatusCode::SUCCESS;
 
}

processPpmNeutral_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmNeutral_ ( State & state ) const

private

Definition at line 377 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                           {
  uint8_t numLut = state.m_subBlockHeader.nSlice1();
  uint8_t numFadc = state.m_subBlockHeader.nSlice2();
  uint8_t totSlice = 3 * numLut + numFadc;
 
  uint8_t channel = 0;
  for ( int asic = 0 ; asic < 4 ; ++asic ) {
    for ( int mcm = 0 ; mcm < 16 ; ++mcm ) {
      // ----------------------------------------------------------------------
      std::vector<uint32_t> rotated(totSlice);
 
      for ( uint8_t slice = 0 ; slice < totSlice ; ++slice ) {
        for ( uint8_t bit = 0 ; bit < 11 ; ++bit ) {
          if ( state.m_ppBlock[slice * 11 + asic * (11 * totSlice) + bit + 1] & (1 << mcm))
              rotated[slice] |= (1 << bit);
          }
      }
 
      bool nonZeroData = false;
      for (uint8_t slice = 0; slice < numLut; ++slice) {
        if (rotated[slice] 
            || rotated[slice + numLut] 
            || rotated[slice + 2 * numLut + numFadc]) { // CP, JET
          nonZeroData = true;
          break;
        }
      }
 
      std::vector<uint8_t> lcpVal;
      std::vector<uint8_t> lcpBcidVec;
      std::vector<uint8_t> ljeVal;
      std::vector<uint8_t> ljeSat80Vec;
      std::vector<int16_t> pedCor;
      std::vector<uint8_t> pedEn;
 
      std::vector<uint16_t> adcVal;
      std::vector<uint8_t> adcExt;
 
      if (nonZeroData) {
        for (uint8_t slice = 0; slice < numLut; ++slice) {
          lcpVal.push_back(rotated[slice] & 0xff);
          ljeVal.push_back(rotated[slice + numLut] & 0xff);
          pedCor.push_back(::pedCorrection(rotated[slice + 2 * numLut + numFadc] & 0x3ff));
          
          lcpBcidVec.push_back((rotated[slice] >> 8) & 0x7);
          ljeSat80Vec.push_back((rotated[slice + numLut] >> 8) & 0x7);
          pedEn.push_back((rotated[slice + 2 * numLut + numFadc] >> 10) & 0x1);
        }
      }
 
      for (uint8_t slice = 0; slice < numFadc; ++slice) {
        if (rotated[slice + numLut]) { // CP, JET
          nonZeroData = true;
          break;
        }
      }
 
      if (nonZeroData) {
        for (uint8_t slice = 0; slice < numFadc; ++ slice) {
          adcVal.push_back(rotated[slice + 2 * numLut] & 0x3ff);
          adcExt.push_back((rotated[slice + 2 * numLut] >> 10 & 0x1) & 0x3ff);
        }
      }
 
      CHECK(addTriggerTowerV2_(
        state,
        state.m_subBlockHeader.crate(),
        state.m_subBlockHeader.module(),
        channel,
        lcpVal,
        lcpBcidVec,
        ljeVal,
        ljeSat80Vec, adcVal,
        adcExt,
        pedCor,
        pedEn));
      // ---------------------------------------------------------------------
      channel++;
    }
  }
  return StatusCode::SUCCESS;
}

processPpmStandardR3V1_() [1/2]

StatusCode ZdcByteStreamReadV1V2Tool::processPpmStandardR3V1_ ( State & state ) const

private

Definition at line 933 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                                {
    for(const auto& lut : state.m_ppLuts) {
      CHECK(addTriggerTowerV1_(
        state,
        state.m_subBlockHeader.crate(), 
        state.m_subBlockHeader.module(),
        lut.first,
        lut.second,
        state.m_ppFadcs[lut.first]));
    }
    return StatusCode::SUCCESS;
}

processPpmStandardR3V1_() [2/2]

StatusCode ZdcByteStreamReadV1V2Tool::processPpmStandardR3V1_ ( State & state, uint32_t word, int indata ) const

private

Definition at line 581 of file ZdcByteStreamReadV1V2Tool.cxx.

                      {
  StatusCode sc;
  if (state.m_subBlockHeader.seqNum() == 63) { // Error block
    ATH_MSG_DEBUG("Error PPM subblock");
    //TODO: errorTool
  } else {
    const uint8_t numAdc = state.m_subBlockHeader.nSlice2();
    const uint8_t numLut = state.m_subBlockHeader.nSlice1();
    const uint8_t nTotal = numAdc + numLut;
    const uint8_t wordsPerBlock = 8; // 16 towers (4 MCMs) / 2 per word
    const uint8_t iBlk =  inData / wordsPerBlock;
    uint8_t iChan =  state.m_subBlockHeader.seqNum() + 2 * (inData % wordsPerBlock);
    
    if (iBlk < numLut) { // First all LUT values
      for(uint8_t i = 0; i < 2; ++i) {
        uint16_t subword = (word >> 16 * i) & 0x7ff;
        state.m_ppLuts[iChan].push_back(subword);
        iChan++;
      }
    } else if (iBlk < nTotal) { // Next all FADC values
      for(uint8_t i = 0; i < 2; ++i) {
        uint16_t subword = (word >> (16 * i)) & 0x7ff;
        state.m_ppFadcs[iChan].push_back(subword);
        iChan++;
      }
    
    } else{
      ATH_MSG_WARNING("Error decoding Ppm word (run1)");
      sc = StatusCode::FAILURE;
    }
 
  }
  return sc;
}

processPpmStandardR4V1_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmStandardR4V1_ ( State & state ) const

private

Definition at line 875 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                                                {
 
  //std::cout << "Here I am in  processPpmStandardR4V1_" << std::endl;
  uint8_t numAdc = state.m_subBlockHeader.nSlice2();
  uint8_t numLut = state.m_subBlockHeader.nSlice1();
  uint8_t crate = state.m_subBlockHeader.crate();
  uint8_t module = state.m_subBlockHeader.module();
 
 
  BitReader br (state.m_ppBlock);
 
  for (uint8_t chan = 0; chan < 64; ++chan) {
    //for (uint8_t k = 0; k < 4; ++k) {
    std::vector<uint8_t> lcpVal;
    std::vector<uint8_t> lcpBcidVec;
 
    std::vector<uint8_t> ljeVal;
    std::vector<uint8_t> ljeSat80Vec;
 
 
 
    std::vector<uint16_t> adcVal;
    std::vector<uint8_t> adcExt;
    std::vector<int16_t> pedCor;
    std::vector<uint8_t> pedEn;
    try {
      for (int i = 0; i < numLut; ++i) {
        lcpVal.push_back(br.getField (8));
        lcpBcidVec.push_back(br.getField (3));
      }
 
      for (int i = 0; i < numLut; ++i) {
        ljeVal.push_back(br.getField (8));
        ljeSat80Vec.push_back(br.getField (3));
      }
 
      for (int i = 0; i < numAdc; ++i) {
        adcVal.push_back(br.getField (10));
        adcExt.push_back(br.getField (1));
      }
 
      for (int i = 0; i < numLut; ++i) {
        uint16_t pc = br.getField (10);
        pedCor.push_back(pedCorrection(pc));
        pedEn.push_back(br.getField (1));
      }
    } catch (const std::out_of_range& ex) {
      ATH_MSG_WARNING("Excess Data in Sub-block");
      m_errorTool->rodError(state.m_rodSourceId, ZdcL1CaloSubBlock::UNPACK_EXCESS_DATA);
    }
    CHECK(
        addTriggerTowerV2_(state, crate, module, chan, lcpVal, lcpBcidVec,
            ljeVal, ljeSat80Vec, adcVal, adcExt, pedCor, pedEn));
  }
 
  return StatusCode::SUCCESS;
}

processPpmWord_()

StatusCode ZdcByteStreamReadV1V2Tool::processPpmWord_ ( State & state, uint32_t word, int indata ) const

private

Definition at line 316 of file ZdcByteStreamReadV1V2Tool.cxx.

                      {
  if ( (state.m_subBlockHeader.format() == 0) 
      || (state.m_subBlockHeader.format() >= 2) 
      || (state.m_verCode >= 0x41)) {
    state.m_ppBlock.push_back(word);
  } else if ((state.m_verCode == 0x21) || (state.m_verCode == 0x31)) {
    return processPpmStandardR3V1_(state, word, indata);
  } else {
    ATH_MSG_ERROR("Unsupported PPM version:format (" 
      << state.m_verCode << ":" << state.m_subBlockHeader.format() 
      <<") combination");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

processRobFragment_()

StatusCode ZdcByteStreamReadV1V2Tool::processRobFragment_ ( State & state, const ROBIterator & robFrag, const RequestType & requestedType ) const

private

Definition at line 198 of file ZdcByteStreamReadV1V2Tool.cxx.

                                                            {
 
  auto rob = **robIter;
 
  ATH_MSG_DEBUG(
      "Treating ROB fragment source id #" << MSG::hex << rob.rob_source_id());
 
 
  state.m_rodSourceId = rob.rod_source_id();
  state.m_robSourceId = rob.source_id();
  const auto sourceID = (state.m_rodSourceId >> 16) & 0xff;
  const auto rodCrate = ZdcSrcIdMap::crate(state.m_rodSourceId);
  const auto rodSlink = ZdcSrcIdMap::slink(state.m_rodSourceId);
  // -------------------------------------------------------------------------
  // Check Rob status
  if (rob.nstatus() > 0) {
    ROBPointer robData;
    rob.status(robData);
    if (*robData != 0) {
      ATH_MSG_WARNING("ROB status error - skipping fragment");
      m_errorTool->robError(state.m_rodSourceId, *robData);
      return StatusCode::FAILURE;
    }
  }
  // -------------------------------------------------------------------------
  RODPointer payloadBeg;
  RODPointer payloadEnd;
  RODPointer payload;
 
  rob.rod_data(payloadBeg);
  payloadEnd = payloadBeg + rob.rod_ndata();
  payload = payloadBeg;
  // -------------------------------------------------------------------------
  if (payload == payloadEnd) {
    ATH_MSG_DEBUG("ROB fragment empty");
    return StatusCode::FAILURE;
  }
  // -------------------------------------------------------------------------
 
 
  uint16_t rodVer = rob.rod_version() & 0xffff;
  state.m_verCode = ((rodVer & 0xfff) << 4) | 1;
  uint32_t rodRunNumber = rob.rod_run_no() & 0xffffff;
 
 
  if (sourceID != state.m_subDetectorID) {
    ATH_MSG_ERROR("Wrong subdetector source id for requested objects: " << state.m_rodSourceId);
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Treating crate " << rodCrate << " slink " << rodSlink);
 
  state.m_caloUserHeader = ZdcCaloUserHeader(*payload);
  if (!state.m_caloUserHeader.isValid()) {
    ATH_MSG_ERROR("Invalid or missing user header");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG(
                "Run number: " << MSG::dec << rodRunNumber << endmsg
                << "Version code: 0x" << MSG::hex << int(state.m_verCode) << MSG::dec
                << endmsg << "LUT triggered slice offset:  "
                << int(state.m_caloUserHeader.lut()) << endmsg
                << "FADC triggered slice offset: " << int(state.m_caloUserHeader.ppFadc())
                << endmsg << "FADC baseline lower bound:   "
                << int(state.m_caloUserHeader.ppLowerBound()));
 
  int indata = 0;
  uint8_t blockType = 0;
  int subBlock = 0;
 
  for (; payload != payloadEnd; ++payload) {
    if (ZdcCaloUserHeader::isValid(*payload) && (subBlock == 0)) {
 
    } else if (ZdcSubBlockHeader::isSubBlockHeader(*payload)) {
      indata = 0;
      CHECK(processPpmBlock_(state));
      
      state.m_ppLuts.clear();
      state.m_ppFadcs.clear();
      state.m_ppBlock.clear();
 
      blockType = (*payload >> 28) & 0xf;
 
      if ((blockType & 0xd) == 0xc) {
        state.m_subBlockHeader = ZdcSubBlockHeader(*payload);
        ATH_MSG_VERBOSE(
            "SubBlock version #" << int(state.m_subBlockHeader.version())
             << " format #" << int(state.m_subBlockHeader.format())
             << " seqNum (compVer) #" << int(state.m_subBlockHeader.seqNum())
             << " nslice1 #" << int(state.m_subBlockHeader.nSlice1())
             << " nslice2 #" << int(state.m_subBlockHeader.nSlice2())
        );
        subBlock = blockType & 0xe;
      } else if (blockType == (subBlock | 1)) {
        //m_subBlockStatus = ZdcSubBlockStatus(*payload);
        subBlock = 0;
      }
    } else {
      switch(state.m_subDetectorID){
      case eformat::TDAQ_CALO_PREPROC:
          CHECK(processPpmWord_(state, *payload, indata));
          break;
      case eformat::FORWARD_ZDC:
          CHECK(processPpmWord_(state, *payload, indata));
          break;
      default:
        break;
      }
      indata++;
    }
  }
  CHECK(processPpmBlock_(state));
  return StatusCode::SUCCESS;
}

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();
  }

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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_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_errorTool

ToolHandle<ZdcL1CaloErrorByteStreamTool> ZdcByteStreamReadV1V2Tool::m_errorTool

private

Definition at line 184 of file ZdcByteStreamReadV1V2Tool.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_ppmSourceIDs

std::vector<uint32_t> ZdcByteStreamReadV1V2Tool::m_ppmSourceIDs

private

Definition at line 190 of file ZdcByteStreamReadV1V2Tool.h.

m_ppmSourceIDsMuon

std::vector<uint32_t> ZdcByteStreamReadV1V2Tool::m_ppmSourceIDsMuon

private

Definition at line 191 of file ZdcByteStreamReadV1V2Tool.h.

m_ppmSourceIDsSpare

std::vector<uint32_t> ZdcByteStreamReadV1V2Tool::m_ppmSourceIDsSpare

private

Definition at line 192 of file ZdcByteStreamReadV1V2Tool.h.

m_robDataProvider

ServiceHandle<IROBDataProviderSvc> ZdcByteStreamReadV1V2Tool::m_robDataProvider

private

Service for reading bytestream.

Definition at line 187 of file ZdcByteStreamReadV1V2Tool.h.

m_srcIdMap

ZdcSrcIdMap* ZdcByteStreamReadV1V2Tool::m_srcIdMap {}

private

Definition at line 193 of file ZdcByteStreamReadV1V2Tool.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* ZdcByteStreamReadV1V2Tool::m_zdcID {}

private

Definition at line 194 of file ZdcByteStreamReadV1V2Tool.h.

{};

---

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

• ZdcByteStreamReadV1V2Tool.h
• ZdcByteStreamReadV1V2Tool.cxx