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

#include <PpmByteStreamReadV1V2Tool.h>

Inheritance diagram for LVL1BS::PpmByteStreamReadV1V2Tool:

Collaboration diagram for LVL1BS::PpmByteStreamReadV1V2Tool:

Classes
class	BitReader

struct	State

Public Member Functions
	PpmByteStreamReadV1V2Tool (const std::string &name)

virtual	~PpmByteStreamReadV1V2Tool ()

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	finalize () override

StatusCode	convert (xAOD::TriggerTowerContainer *const ttCollection) const
	Convert ROB fragments to trigger towers. More...

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

virtual void	print () const
	Print the state of the tool. 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

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
enum	RequestType { RequestType::PPM, RequestType::CPM, RequestType::CMX }

typedef IROBDataProviderSvc::VROBFRAG::const_iterator	ROBIterator

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	ROBPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	RODPointer

typedef std::map< uint8_t, std::vector< uint16_t > >	LutsMap

typedef std::map< uint8_t, std::vector< uint16_t > >	FadcsMap

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	convert (State &state, const IROBDataProviderSvc::VROBFRAG &robFrags) const

void	initSourceIDs ()

const std::vector< uint32_t > &	ppmSourceIDs (State &state, const std::string &sgKey) const
	Return reference to vector with all possible Source Identifiers. More...

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, 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) 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, std::vector< uint8_t > &&luts, std::vector< uint8_t > &&lcpBcidVec, std::vector< uint16_t > &&fadc, std::vector< uint8_t > &&bcidExt) const

void	processSubBlockStatus_ (State &state, uint8_t crate, uint8_t module, uint32_t word) const

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
ToolHandle< LVL1BS::L1CaloErrorByteStreamTool >	m_errorTool

ToolHandle< LVL1::IL1CaloMappingTool >	m_ppmMaps
	Channel mapping tool. More...

ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
	Service for reading bytestream. More...

std::vector< uint32_t >	m_ppmSourceIDs

std::vector< uint32_t >	m_ppmSourceIDsMuon

std::vector< uint32_t >	m_ppmSourceIDsSpare

L1CaloSrcIdMap *	m_srcIdMap

std::atomic< size_t >	m_maxSizeSeen

bool	m_useSWROD = false

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

Static Private Attributes
static const uint8_t	s_crates = 8

static const uint8_t	s_modules = 16

static const uint8_t	s_channels = 64

static const uint16_t	s_maxtowers = s_crates * s_modules * s_channels

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 58 of file PpmByteStreamReadV1V2Tool.h.

Member Typedef Documentation

◆ FadcsMap

typedef std::map<uint8_t, std::vector<uint16_t> > LVL1BS::PpmByteStreamReadV1V2Tool::FadcsMap

private

Definition at line 101 of file PpmByteStreamReadV1V2Tool.h.

◆ LutsMap

typedef std::map<uint8_t, std::vector<uint16_t> > LVL1BS::PpmByteStreamReadV1V2Tool::LutsMap

private

Definition at line 100 of file PpmByteStreamReadV1V2Tool.h.

◆ ROBIterator

typedef IROBDataProviderSvc::VROBFRAG::const_iterator LVL1BS::PpmByteStreamReadV1V2Tool::ROBIterator

private

Definition at line 77 of file PpmByteStreamReadV1V2Tool.h.

◆ ROBPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::PpmByteStreamReadV1V2Tool::ROBPointer

private

Definition at line 78 of file PpmByteStreamReadV1V2Tool.h.

◆ RODPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::PpmByteStreamReadV1V2Tool::RODPointer

private

Definition at line 79 of file PpmByteStreamReadV1V2Tool.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 LVL1BS::PpmByteStreamReadV1V2Tool::RequestType

strongprivate

Enumerator
PPM
CPM
CMX

Definition at line 76 of file PpmByteStreamReadV1V2Tool.h.

76 { PPM, CPM, CMX };

Constructor & Destructor Documentation

◆ PpmByteStreamReadV1V2Tool()

LVL1BS::PpmByteStreamReadV1V2Tool::PpmByteStreamReadV1V2Tool ( const std::string & name )

Definition at line 63 of file PpmByteStreamReadV1V2Tool.cxx.

   :
     AsgTool(name),
     m_errorTool("LVL1BS::L1CaloErrorByteStreamTool/L1CaloErrorByteStreamTool"),
     m_ppmMaps("LVL1::PpmMappingTool/PpmMappingTool"),
     m_robDataProvider("ROBDataProviderSvc", name),
     m_srcIdMap(nullptr),
     m_maxSizeSeen(0)
 {
   declareInterface<PpmByteStreamReadV1V2Tool>(this);
     declareProperty("UseSWROD",m_useSWROD = false, "Use SWROD readout instead of legacy (which was removed in 2024)");
   declareProperty("PpmMappingTool", m_ppmMaps,
       "Crate/Module/Channel to Eta/Phi/Layer mapping tool");
   declareProperty("ROBDataProviderSvc", m_robDataProvider,
         "Get ROB source IDs service");
 }

◆ ~PpmByteStreamReadV1V2Tool()

virtual LVL1BS::PpmByteStreamReadV1V2Tool::~PpmByteStreamReadV1V2Tool ( )

inlinevirtual

Definition at line 64 of file PpmByteStreamReadV1V2Tool.h.

64 {};

Member Function Documentation

◆ addTriggerTowerV1_() [1/2]

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::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 1003 of file PpmByteStreamReadV1V2Tool.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,
                             std::move(lcpVal), std::move(lcpBcidVec),
                             std::move(adcVal), std::move(adcExt)));
  
    return StatusCode::SUCCESS;
 }

◆ addTriggerTowerV1_() [2/2]

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

private

Definition at line 976 of file PpmByteStreamReadV1V2Tool.cxx.

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

◆ addTriggerTowerV2_()

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::addTriggerTowerV2_	(	State &	state,
		uint8_t	crate,
		uint8_t	module,
		uint8_t	channel,
		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
	)		const

private

Definition at line 930 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   uint32_t coolId = ::coolId(crate, module, channel);
  
   int layer = 0;
   double eta = 0.;
   double phi = 0.;
  
   bool isData = m_ppmMaps->mapping(crate, module, channel, eta, phi, layer);
  
   if (!isData && !state.m_ppmIsRetSpare && !state.m_ppmIsRetMuon){
     return StatusCode::SUCCESS;
   }
  
   if (!isData) {
     const int pin  = channel % 16;
     const int asic = channel / 16;
     eta = 16 * crate + module;
     phi = 4 * pin + asic;
   }
  
   xAOD::TriggerTower* tt = new xAOD::TriggerTower();
   state.m_triggerTowers->push_back(tt);
  
   tt->initialize(coolId, eta, phi,
                  std::move(lcpVal), std::move(ljeVal),
                  std::move(pedCor), std::move(pedEn),
                  std::move(lcpBcidVec), std::move(adcVal),
                  std::move(adcExt), std::move(ljeSat80Vec),
                  0, state.m_caloUserHeader.lut(),
       state.m_caloUserHeader.ppFadc());
   return StatusCode::SUCCESS;
 }

◆ convert() [1/3]

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

Definition at line 140 of file PpmByteStreamReadV1V2Tool.cxx.

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

◆ convert() [2/3]

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::convert	(	State &	state,
		const IROBDataProviderSvc::VROBFRAG &	robFrags
	)		const

private

Definition at line 107 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   if (m_maxSizeSeen > state.m_triggerTowers->capacity()){
     state.m_triggerTowers->reserve (m_maxSizeSeen);
   }
  
   state.m_subDetectorID = eformat::TDAQ_CALO_PREPROC;
  
   ROBIterator rob = robFrags.begin();
   ROBIterator robEnd = robFrags.end();
  
   int robCounter = 1;
   for (; rob != robEnd; ++rob, ++robCounter) {
  
     StatusCode sc = processRobFragment_(state, rob, RequestType::PPM);
     if (!sc.isSuccess()) {
  
     }
   }
  
   CxxUtils::atomic_fetch_max (&m_maxSizeSeen, state.m_triggerTowers->size());
   return StatusCode::SUCCESS;
 }

◆ convert() [3/3]

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::convert ( xAOD::TriggerTowerContainer *const ttCollection ) const

Convert ROB fragments to trigger towers.

Definition at line 134 of file PpmByteStreamReadV1V2Tool.cxx.

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

◆ 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.

95 { 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.

85 { 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.

90 { 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 LVL1BS::PpmByteStreamReadV1V2Tool::finalize ( )

overridevirtual

Definition at line 100 of file PpmByteStreamReadV1V2Tool.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 > LVL1BS::PpmByteStreamReadV1V2Tool::getPpmAdcSamplesR3_	(	State &	state,
		BitReader &	br,
		uint8_t	format,
		uint8_t	minIndex
	)		const

private

Definition at line 500 of file PpmByteStreamReadV1V2Tool.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 > LVL1BS::PpmByteStreamReadV1V2Tool::getPpmAdcSamplesR4_	(	State &	state,
		BitReader &	br,
		uint8_t	encoding,
		uint8_t	minIndex
	)		const

private

Definition at line 787 of file PpmByteStreamReadV1V2Tool.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 LVL1BS::PpmByteStreamReadV1V2Tool::initialize ( )

overridevirtual

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 84 of file PpmByteStreamReadV1V2Tool.cxx.

                                                  {
   ATH_MSG_DEBUG("Initializing " << name());
  
   m_srcIdMap = new L1CaloSrcIdMap();
   m_srcIdMap->useSWROD(m_useSWROD);
   CHECK(m_errorTool.retrieve());
   CHECK(m_ppmMaps.retrieve());
   CHECK(m_robDataProvider.retrieve());
  
   initSourceIDs();
  
   return StatusCode::SUCCESS;
 }

◆ initSourceIDs()

void LVL1BS::PpmByteStreamReadV1V2Tool::initSourceIDs ( )

private

Definition at line 1039 of file PpmByteStreamReadV1V2Tool.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 robId = m_srcIdMap->getRobID(rodId);
       m_ppmSourceIDs.push_back(robId);
       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 LVL1BS::PpmByteStreamReadV1V2Tool::interpretPpmHeaderR4V1_	(	BitReader &	br,
		uint8_t	numAdc,
		int8_t &	encoding,
		int8_t &	minIndex
	)		const

private

Definition at line 736 of file PpmByteStreamReadV1V2Tool.cxx.

 {
  uint8_t minHeader = 0;
  
   if (numAdc == 5) {
     minHeader = br.getField(4);
  
     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() [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);
   }

◆ 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 > & LVL1BS::PpmByteStreamReadV1V2Tool::ppmSourceIDs	(	State &	state,
		const std::string &	sgKey
	)		const

private

Return reference to vector with all possible Source Identifiers.

Definition at line 1065 of file PpmByteStreamReadV1V2Tool.cxx.

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ processPpmBlock_()

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::processPpmBlock_ ( State & state ) const

private

Definition at line 293 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   if (state.m_ppBlock.size() > 0) {
     if (state.m_subBlockHeader.format() == 0) {
       StatusCode sc = processPpmNeutral_(state);
       CHECK(sc);
       return sc;
     }
  
     if (state.m_verCode == 0x31) {
       StatusCode sc = processPpmCompressedR3V1_(state);
       CHECK(sc);
       return sc;
     }
  
     if (state.m_verCode == 0x41 || state.m_verCode == 0x42) {
       StatusCode sc = processPpmBlockR4V1_(state);
       CHECK(sc);
       return sc;
     }
   }
  
   if (state.m_ppLuts.size() > 0) {
     if (state.m_verCode == 0x21 || state.m_verCode == 0x31) {
       StatusCode sc = processPpmBlockR3V1_(state);
       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 LVL1BS::PpmByteStreamReadV1V2Tool::processPpmBlockR3V1_ ( State & state ) const

private

Definition at line 822 of file PpmByteStreamReadV1V2Tool.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 LVL1BS::PpmByteStreamReadV1V2Tool::processPpmBlockR4V1_ ( State & state ) const

private

Definition at line 577 of file PpmByteStreamReadV1V2Tool.cxx.

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

◆ processPpmCompressedR3V1_()

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::processPpmCompressedR3V1_ ( State & state ) const

private

Definition at line 416 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   BitReader br (state.m_ppBlock);
   uint8_t chan = 0;
   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))},
           std::move(adcVal),
           std::move(adcExt)
         ));
       }
       chan++;
     }
   }catch (const std::out_of_range& ex) {
       ATH_MSG_WARNING("Excess Data in Sub-block");
       m_errorTool->rodError(state.m_rodSourceId, L1CaloSubBlock::UNPACK_EXCESS_DATA);
   }
   return StatusCode::SUCCESS;
 }

◆ processPpmCompressedR4V1_()

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::processPpmCompressedR4V1_ ( State & state ) const

private

Definition at line 589 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   BitReader br (state.m_ppBlock);
   uint8_t numAdc = state.m_subBlockHeader.nSlice2();
   uint8_t numLut = state.m_subBlockHeader.nSlice1();
   int16_t pedCorBase = -20;
  
  
   try{
     for(uint8_t chan = 0; chan < s_channels; ++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);
             }
           }
  
         }
  
       }
        // 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,
                              std::move(lcpVal), std::move(lcpBcidVec),
                              std::move(ljeVal), std::move(ljeSat80Vec),
                              std::move(adcVal), std::move(adcExt),
                              std::move(pedCor), std::move(pedEn)));
     } // for
   } catch (const std::out_of_range& ex) {
       ATH_MSG_WARNING("Excess Data in Sub-block");
       m_errorTool->rodError(state.m_rodSourceId, L1CaloSubBlock::UNPACK_EXCESS_DATA);
   }
   //Check status workd
   return StatusCode::SUCCESS;
  
 }

◆ processPpmNeutral_()

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::processPpmNeutral_ ( State & state ) const

private

Definition at line 331 of file PpmByteStreamReadV1V2Tool.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,
         std::move(lcpVal),
         std::move(lcpBcidVec),
         std::move(ljeVal),
         std::move(ljeSat80Vec),
         std::move(adcVal),
         std::move(adcExt),
         std::move(pedCor),
         std::move(pedEn)));
       // ---------------------------------------------------------------------
       channel++;
     }
   }
   return StatusCode::SUCCESS;
 }

◆ processPpmStandardR3V1_() [1/2]

StatusCode LVL1BS::PpmByteStreamReadV1V2Tool::processPpmStandardR3V1_ ( State & state ) const

private

Definition at line 894 of file PpmByteStreamReadV1V2Tool.cxx.

 {
     for(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 LVL1BS::PpmByteStreamReadV1V2Tool::processPpmStandardR3V1_	(	State &	state,
		uint32_t	word,
		int	indata
	)		const

private

Definition at line 538 of file PpmByteStreamReadV1V2Tool.cxx.

 {
  
   StatusCode sc = StatusCode::SUCCESS;
   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 LVL1BS::PpmByteStreamReadV1V2Tool::processPpmStandardR4V1_ ( State & state ) const

private

Definition at line 834 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   BitReader br (state.m_ppBlock);
   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();
  
   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, L1CaloSubBlock::UNPACK_EXCESS_DATA);
     }
     CHECK(
         addTriggerTowerV2_(state,
                            crate, module, chan,
                            std::move(lcpVal), std::move(lcpBcidVec),
                            std::move(ljeVal), std::move(ljeSat80Vec),
                            std::move(adcVal), std::move(adcExt),
                            std::move(pedCor), std::move(pedEn)));
   }
  
   return StatusCode::SUCCESS;
 }

◆ processPpmWord_()

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

private

Definition at line 273 of file PpmByteStreamReadV1V2Tool.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 LVL1BS::PpmByteStreamReadV1V2Tool::processRobFragment_	(	State &	state,
		const ROBIterator &	robFrag,
		const RequestType &	requestedType
	)		const

private

Definition at line 156 of file PpmByteStreamReadV1V2Tool.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 = m_srcIdMap->crate(state.m_rodSourceId);
   const auto rodSlink = m_srcIdMap->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;
   uint32_t rodRunNumber = rob.rod_run_no() & 0xffffff;
   state.m_verCode = ((rodVer & 0xfff) << 4) | 1;
  
  
   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 = CaloUserHeader(*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 (CaloUserHeader::isValid(*payload) && (subBlock == 0)) {
  
     } else if (SubBlockHeader::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 = SubBlockHeader(*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)) {
         processSubBlockStatus_(state, state.m_subBlockHeader.crate(), state.m_subBlockHeader.module(), *payload);
         subBlock = 0;
       }
     } else {
       switch(state.m_subDetectorID){
       case eformat::TDAQ_CALO_PREPROC:
           CHECK(processPpmWord_(state, *payload, indata));
           break;
       default:
         break;
       }
       indata++;
     }
   }
   CHECK(processPpmBlock_(state));
   state.m_ppLuts.clear();
   state.m_ppFadcs.clear();
   state.m_ppBlock.clear();
   return StatusCode::SUCCESS;
 }

◆ processSubBlockStatus_()

void LVL1BS::PpmByteStreamReadV1V2Tool::processSubBlockStatus_	(	State &	state,
		uint8_t	crate,
		uint8_t	module,
		uint32_t	word
	)		const

private

Definition at line 908 of file PpmByteStreamReadV1V2Tool.cxx.

 {
   LVL1::DataError errorBits(0);
   errorBits.set(LVL1::DataError::SubStatusWord, payload);
  
   const uint32_t error = errorBits.error();
   int curr = state.m_triggerTowers->size() - 1;
   for(int i=0; i < s_channels; ++i){
     if (curr < 0){
       break;
     }
     auto tt = (*state.m_triggerTowers)[curr--];
     if (tt->coolId() >> 16 & crateModuleMask(crate, module)){
       tt->setErrorWord(error);
     }else{
       break;
     }
   }
 }

◆ 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 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_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<LVL1BS::L1CaloErrorByteStreamTool> LVL1BS::PpmByteStreamReadV1V2Tool::m_errorTool

private

Definition at line 201 of file PpmByteStreamReadV1V2Tool.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_maxSizeSeen

std::atomic<size_t> LVL1BS::PpmByteStreamReadV1V2Tool::m_maxSizeSeen

mutableprivate

Definition at line 213 of file PpmByteStreamReadV1V2Tool.h.

◆ m_ppmMaps

ToolHandle<LVL1::IL1CaloMappingTool> LVL1BS::PpmByteStreamReadV1V2Tool::m_ppmMaps

private

Channel mapping tool.

Definition at line 203 of file PpmByteStreamReadV1V2Tool.h.

◆ m_ppmSourceIDs

std::vector<uint32_t> LVL1BS::PpmByteStreamReadV1V2Tool::m_ppmSourceIDs

private

Definition at line 208 of file PpmByteStreamReadV1V2Tool.h.

◆ m_ppmSourceIDsMuon

std::vector<uint32_t> LVL1BS::PpmByteStreamReadV1V2Tool::m_ppmSourceIDsMuon

private

Definition at line 209 of file PpmByteStreamReadV1V2Tool.h.

◆ m_ppmSourceIDsSpare

std::vector<uint32_t> LVL1BS::PpmByteStreamReadV1V2Tool::m_ppmSourceIDsSpare

private

Definition at line 210 of file PpmByteStreamReadV1V2Tool.h.

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> LVL1BS::PpmByteStreamReadV1V2Tool::m_robDataProvider

private

Service for reading bytestream.

Definition at line 205 of file PpmByteStreamReadV1V2Tool.h.

◆ m_srcIdMap

L1CaloSrcIdMap* LVL1BS::PpmByteStreamReadV1V2Tool::m_srcIdMap

private

Definition at line 211 of file PpmByteStreamReadV1V2Tool.h.

◆ m_useSWROD

bool LVL1BS::PpmByteStreamReadV1V2Tool::m_useSWROD = false

private

Definition at line 222 of file PpmByteStreamReadV1V2Tool.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.

◆ s_channels

const uint8_t LVL1BS::PpmByteStreamReadV1V2Tool::s_channels = 64

staticprivate

Definition at line 219 of file PpmByteStreamReadV1V2Tool.h.

◆ s_crates

const uint8_t LVL1BS::PpmByteStreamReadV1V2Tool::s_crates = 8

staticprivate

Definition at line 217 of file PpmByteStreamReadV1V2Tool.h.

◆ s_maxtowers

const uint16_t LVL1BS::PpmByteStreamReadV1V2Tool::s_maxtowers = s_crates * s_modules * s_channels

staticprivate

Definition at line 220 of file PpmByteStreamReadV1V2Tool.h.

◆ s_modules

const uint8_t LVL1BS::PpmByteStreamReadV1V2Tool::s_modules = 16

staticprivate

Definition at line 218 of file PpmByteStreamReadV1V2Tool.h.

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

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ FadcsMap

◆ LutsMap

◆ ROBIterator

◆ ROBPointer

◆ RODPointer

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ RequestType

Constructor & Destructor Documentation

◆ PpmByteStreamReadV1V2Tool()

◆ ~PpmByteStreamReadV1V2Tool()

Member Function Documentation

◆ addTriggerTowerV1_() [1/2]

◆ addTriggerTowerV1_() [2/2]

◆ addTriggerTowerV2_()

◆ convert() [1/3]

◆ convert() [2/3]

◆ convert() [3/3]

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ getKey()

◆ getName()

◆ getPpmAdcSamplesR3_()

◆ getPpmAdcSamplesR4_()

◆ getProperty()

◆ initialize()

◆ initSourceIDs()

◆ inputHandles()

◆ interpretPpmHeaderR4V1_()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ ppmSourceIDs()

◆ print()

◆ processPpmBlock_()

◆ processPpmBlockR3V1_()

◆ processPpmBlockR4V1_()

◆ processPpmCompressedR3V1_()

◆ processPpmCompressedR4V1_()

◆ processPpmNeutral_()

◆ processPpmStandardR3V1_() [1/2]

◆ processPpmStandardR3V1_() [2/2]

◆ processPpmStandardR4V1_()

◆ processPpmWord_()

◆ processRobFragment_()

◆ processSubBlockStatus_()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_errorTool

◆ m_evtStore

◆ m_maxSizeSeen