#include <PixelRawDataProviderTool.h>

Inheritance diagram for PixelRawDataProviderTool:

Collaboration diagram for PixelRawDataProviderTool:

Public Member Functions
	PixelRawDataProviderTool (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
StatusCode	initialize () override
	initialize
StatusCode	convert (std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vecRobs, IPixelRDO_Container *rdoIdc, IDCInDetBSErrContainer &decodingErrors, const EventContext &ctx) const final
	this is the main decoding method
int	SizeOfIDCInDetBSErrContainer () const final
	Size of IDCInDetBSErrContainer.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool InterfaceID.

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
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IPixelRodDecoder >	m_decoder {this, "Decoder", "PixelRodDecoder", "Tool for PixelRodDecoder"}
SG::WriteHandleKey< InDetTimeCollection >	m_LVL1CollectionKey {this, "LVL1CollectionName", "PixelLVL1ID"}
SG::WriteHandleKey< InDetTimeCollection >	m_BCIDCollectionKey {this, "BCIDCollectionName", "PixelBCID"}
Gaudi::Property< bool >	m_storeInDetTimeColls {this, "StoreInDetTimeCollections", true, "Store LVL1ID and BCID"}
std::atomic_int	m_DecodeErrCount
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

Definition at line 21 of file PixelRawDataProviderTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ PixelRawDataProviderTool()

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

constructor

Definition at line 17 of file PixelRawDataProviderTool.cxx.

                                                                                                                        :
  AthAlgTool(type,name,parent),
  m_DecodeErrCount(0)
{
  declareInterface<IPixelRawDataProviderTool>(this);   
}

Member Function Documentation

◆ convert()

StatusCode PixelRawDataProviderTool::convert	(	std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &	vecRobs,
		IPixelRDO_Container *	rdoIdc,
		IDCInDetBSErrContainer &	decodingErrors,
		const EventContext &	ctx ) const

finalvirtual

this is the main decoding method

Implements IPixelRawDataProviderTool.

Definition at line 34 of file PixelRawDataProviderTool.cxx.

                                                                                                 {
  if (vecRobs.size()==0) { return StatusCode::SUCCESS; }
 
  std::vector<const ROBFragment*>::const_iterator rob_it = vecRobs.begin();
 
#ifdef PIXEL_DEBUG
  ATH_MSG_DEBUG(" New ROD collection found: LVL1=" << (*rob_it)->rod_lvl1_id() << " Size=" << vecRobs.size());
#endif 
#ifdef PLOTS
  std::cout << " New ROD collection found: LVL1=" << (*rob_it)->rod_lvl1_id() << " Size=" << vecRobs.size() << std::endl;
#endif
 
  SG::WriteHandle<InDetTimeCollection> LVL1Collection;
  SG::WriteHandle<InDetTimeCollection> BCIDCollection;
 
  if ( m_storeInDetTimeColls ) {
    //    are we working on a new event ?
    LVL1Collection = SG::makeHandle(m_LVL1CollectionKey,ctx);
    ATH_CHECK(LVL1Collection.record(std::make_unique<InDetTimeCollection>()));
    ATH_MSG_DEBUG("InDetTimeCollection " << LVL1Collection.name() << " registered in StoreGate");
    LVL1Collection->reserve(vecRobs.size());
 
    BCIDCollection = SG::makeHandle(m_BCIDCollectionKey,ctx);
    ATH_CHECK(BCIDCollection.record(std::make_unique<InDetTimeCollection>()));
    ATH_MSG_DEBUG("InDetTimeCollection " << BCIDCollection.name() << " registered in StoreGate");
    BCIDCollection->reserve(vecRobs.size());
  }
 
#ifdef PIXEL_DEBUG
    ATH_MSG_DEBUG(" New event, reset the collection set");
#endif
 
  // loop over the ROB fragments
  for (; rob_it!=vecRobs.end(); ++rob_it) {
    uint32_t robid = (*rob_it)->rob_source_id();
#ifdef PIXEL_DEBUG
    ATH_MSG_DEBUG("Found ROB " << std::hex << robid << std::dec);
#endif
 
  if ( m_storeInDetTimeColls ) {
    unsigned int lvl1id = (*rob_it)->rod_lvl1_id();
    LVL1Collection->emplace_back(robid,lvl1id) ;
 
    unsigned int bcid = (*rob_it)->rod_bc_id();
    BCIDCollection->emplace_back(robid,bcid);
 
#ifdef PIXEL_DEBUG
      ATH_MSG_DEBUG("Stored LVL1ID "<<lvl1id<<" and BCID "<<bcid<<" in InDetTimeCollections");
#endif
 
  }
 
    // here the code for the timing monitoring should be reinserted
    // using 1 container per event and subdetector
    StatusCode sc = m_decoder->fillCollection(&**rob_it, rdoIdc, decodingErrors,nullptr,ctx);
 
    const int issuesMessageCountLimit = 100;
    if (sc==StatusCode::FAILURE) {
      if (m_DecodeErrCount < issuesMessageCountLimit) {
        ATH_MSG_INFO("Problem with Pixel ByteStream Decoding!");
        m_DecodeErrCount++;
      }
      else if (issuesMessageCountLimit == m_DecodeErrCount) {
        ATH_MSG_INFO("Too many Problems with Pixel Decoding messages.  Turning message off.");
        m_DecodeErrCount++;
      }
    }
  }
  return StatusCode::SUCCESS; 
}

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

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ initialize()

StatusCode PixelRawDataProviderTool::initialize ( )

override

initialize

Definition at line 24 of file PixelRawDataProviderTool.cxx.

                                                {
  ATH_CHECK(AthAlgTool::initialize());
  ATH_CHECK(m_decoder.retrieve());
  
  ATH_CHECK(m_LVL1CollectionKey.initialize(m_storeInDetTimeColls));
  ATH_CHECK(m_BCIDCollectionKey.initialize(m_storeInDetTimeColls));
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

◆ interfaceID()

const InterfaceID & IPixelRawDataProviderTool::interfaceID ( )

inlinestaticinherited

AlgTool InterfaceID.

Definition at line 35 of file IPixelRawDataProviderTool.h.

                                                                {
static const InterfaceID IID_IPixelRawDataProviderTool("IPixelRawDataProviderTool", 1, 0);
return IID_IPixelRawDataProviderTool;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

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

◆ SizeOfIDCInDetBSErrContainer()

int PixelRawDataProviderTool::SizeOfIDCInDetBSErrContainer ( ) const

finalvirtual

Size of IDCInDetBSErrContainer.

Implements IPixelRawDataProviderTool.

Definition at line 106 of file PixelRawDataProviderTool.cxx.

                                                                 {
  //=========================================================
  //  Size of Pixel BS Error container
  //
  //  The error would be stored not only for module but also each FE (x16) per module.
  //  In addition, IBL FEI4 provides error counter between trigger, this also extends 
  //  the size beyond nominal module + FE ID. These numbers come from the hardware 
  //  specification so that there is no easy way to document in the header file.
  //  Rather, put the hardcoded number here.
  //
  //      Total number of pixel modules: 2048
  //      Number of FE chips per module:   16
  //     -------------------------------------
  //          2048 x 17 (module + FE) = 34816
  //
  //      IBL extra error information  : 
  //          280(module) x 2(FE) x 32(error counter) = 17920
  //     -------------------------------------
  //
  //      isActive status : 2048
  //     -------------------------------------
  //                             Total : 54784
  //=========================================================
  return PixelRodDecoder::ERROR_CONTAINER_MAX;
}

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

SG::WriteHandleKey<InDetTimeCollection> PixelRawDataProviderTool::m_BCIDCollectionKey {this, "BCIDCollectionName", "PixelBCID"}

private

Definition at line 48 of file PixelRawDataProviderTool.h.

48{this, "BCIDCollectionName", "PixelBCID"};

◆ m_DecodeErrCount

std::atomic_int PixelRawDataProviderTool::m_DecodeErrCount

mutableprivate

Definition at line 51 of file PixelRawDataProviderTool.h.

◆ m_decoder

ToolHandle<IPixelRodDecoder> PixelRawDataProviderTool::m_decoder {this, "Decoder", "PixelRodDecoder", "Tool for PixelRodDecoder"}

private

Definition at line 43 of file PixelRawDataProviderTool.h.

44{this, "Decoder", "PixelRodDecoder", "Tool for PixelRodDecoder"};

◆ 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_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_LVL1CollectionKey

SG::WriteHandleKey<InDetTimeCollection> PixelRawDataProviderTool::m_LVL1CollectionKey {this, "LVL1CollectionName", "PixelLVL1ID"}

private

Definition at line 47 of file PixelRawDataProviderTool.h.

47{this, "LVL1CollectionName", "PixelLVL1ID"};

◆ m_storeInDetTimeColls

Gaudi::Property<bool> PixelRawDataProviderTool::m_storeInDetTimeColls {this, "StoreInDetTimeCollections", true, "Store LVL1ID and BCID"}

private

Definition at line 49 of file PixelRawDataProviderTool.h.

49{this, "StoreInDetTimeCollections", true, "Store LVL1ID and BCID"};

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PixelRawDataProviderTool()

Member Function Documentation

◆ convert()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ SizeOfIDCInDetBSErrContainer()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_BCIDCollectionKey

◆ m_DecodeErrCount

◆ m_decoder

◆ m_detStore

◆ m_evtStore

◆ m_LVL1CollectionKey

◆ m_storeInDetTimeColls

◆ m_varHandleArraysDeclared

◆ m_vhka