This tool orchestrates the individual steps in the BS conversion - sorting the hits into individual FEs, encoding the data streams and formatting them into eformat fragments. More...

#include <ITkPixelCnvTool.h>

Inheritance diagram for ITkPixelCnvTool:

Collaboration diagram for ITkPixelCnvTool:

Public Member Functions
	ITkPixelCnvTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
	Retrieve helper tools.
template<class ContainerType>
StatusCode	convertToByteStream (const ContainerType *cont) const
	Take ITkPixelRDO_Container or PixelRDO_Container and translate it to bytestream.
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

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< ITkPixelHitSortingTool >	m_hitSortingTool {this, "HitSortingTool", ""}
ToolHandle< ITkPixelEncodingTool >	m_encodingTool {this, "EncodingTool", "", "The encoding tool"}
ServiceHandle< IByteStreamCnvSvc >	m_byteStreamCnvSvc {this, "ByteStreamConvertionService", "ByteStreamCnvSvc", "The Byte stream coversion service"}
SG::ReadCondHandleKey< ITkPixelCablingData >	m_pixelCablingKey {this, "PixelCablingKey", "", "Cond Key of Pixel Cabling"}
ToolHandle< ITkPixelDataRateMonTool >	m_dataRateMonTool {this, "DataRateMonitoringTool", "", "Monitoring tool for data rate evaluation"}
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

This tool orchestrates the individual steps in the BS conversion - sorting the hits into individual FEs, encoding the data streams and formatting them into eformat fragments.

Definition at line 32 of file ITkPixelCnvTool.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

◆ ITkPixelCnvTool()

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

Definition at line 19 of file ITkPixelCnvTool.cxx.

20 : AthAlgTool(type, name, parent)

21{}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Member Function Documentation

◆ convertToByteStream()

template<class ContainerType>

template StatusCode ITkPixelCnvTool::convertToByteStream< PixelRDO_Container > ( const ContainerType * cont ) const

Take ITkPixelRDO_Container or PixelRDO_Container and translate it to bytestream.

Definition at line 47 of file ITkPixelCnvTool.cxx.

                                                                               {
 
    //Get the cabling
    SG::ReadCondHandle<ITkPixelCablingData> cablingData(m_pixelCablingKey);
    const ITkPixelCablingData* cabling = *cablingData;
 
    //Get the full event assembler from ByteStreamCnvSvcBase
    //SrcIdMap translates lower lvl IDs into higher lvl, e. g. ROD -> ROB, ROB -> ROS, ROS -> Det
    FullEventAssembler<SrcIdMap>* fea = 0;
    ATH_CHECK(m_byteStreamCnvSvc->getFullEventAssembler(fea, "ITkPixelRawCont"));
 
    fea->setDetEvtType(0x0);
    fea->setLvl1TriggerType(0x0);
    
    //Expose the buffer to be filled with the encoded data
    //Other BS converters use FullEventAssembler<SrcIdMap>::RODDATA,
    //which is just a typedef for std::vector<uint32_t>. Why the extra
    //layer of renaming?
    std::vector<uint32_t>* rod;
 
    //sort the RDO hits based on the FE
    const std::map<ITkPixelOnlineId, ITkPixLayout<uint16_t>> EventHitMaps = m_hitSortingTool->sortRDOHits(cont, cabling);
 
    for (const auto& [onlineID, hitMap] : EventHitMaps){
 
        //make a copy of the onlineID
        uint64_t onID = (uint64_t)onlineID;
 
        //Encode the FE hits
        std::vector<uint32_t> encodedStream = m_encodingTool->encodeFE(hitMap, onID & 0x3000000000000000);
 
        //Build the ROD payload header. First word is size of the packet in 32bit words
        //including the header (16b), felix status (8b), swrod status (8b),
        //second is the DetectorResourceID
        uint32_t chipPayloadHeader_1 = (static_cast<uint16_t>(encodedStream.size()) + 2) << 16;
        uint32_t chipPayloadHeader_2 = onlineID.detectorResourceID();
 
        // passing information to the monitoring tool if initialised
        if (not m_dataRateMonTool.empty()) {
            m_dataRateMonTool->fill(onlineID.offlineModuleID(), encodedStream, hitMap);
        }
 
        //The ROD identifier, the sourceID, is defined in the cabling
        //and passed here from the ITkPixelHitSortingTool as part of
        //the online ID
 
        //Create ROD and insert the payload
        rod = fea->getRodData(onlineID.sourceID());
        rod->insert(rod->end(), {chipPayloadHeader_1, chipPayloadHeader_2});
        rod->insert(rod->end(), encodedStream.begin(), encodedStream.end());
 
    }
 
    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 ITkPixelCnvTool::initialize ( )

overridevirtual

Retrieve helper tools.

Definition at line 26 of file ITkPixelCnvTool.cxx.

                                      {
 
    //Initialize the sub-tools
    ATH_CHECK(m_hitSortingTool.retrieve());
 
    ATH_CHECK(m_encodingTool.retrieve());
 
    ATH_CHECK(m_pixelCablingKey.initialize());
 
    if (not m_dataRateMonTool.empty())
        ATH_CHECK(m_dataRateMonTool.retrieve());
 
    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.

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

◆ 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 >, and AthCheckedComponent<::AthAlgTool >.

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

ServiceHandle<IByteStreamCnvSvc> ITkPixelCnvTool::m_byteStreamCnvSvc {this, "ByteStreamConvertionService", "ByteStreamCnvSvc", "The Byte stream coversion service"}

private

Definition at line 49 of file ITkPixelCnvTool.h.

49{this, "ByteStreamConvertionService", "ByteStreamCnvSvc", "The Byte stream coversion service"};

◆ m_dataRateMonTool

ToolHandle<ITkPixelDataRateMonTool> ITkPixelCnvTool::m_dataRateMonTool {this, "DataRateMonitoringTool", "", "Monitoring tool for data rate evaluation"}

private

Definition at line 53 of file ITkPixelCnvTool.h.

53{this, "DataRateMonitoringTool", "", "Monitoring tool for data rate evaluation"};

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

ToolHandle<ITkPixelEncodingTool> ITkPixelCnvTool::m_encodingTool {this, "EncodingTool", "", "The encoding tool"}

private

Definition at line 47 of file ITkPixelCnvTool.h.

47{this, "EncodingTool", "", "The encoding tool"};

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

ToolHandle<ITkPixelHitSortingTool> ITkPixelCnvTool::m_hitSortingTool {this, "HitSortingTool", ""}

private

Definition at line 45 of file ITkPixelCnvTool.h.

45{this, "HitSortingTool", ""};

◆ m_pixelCablingKey

SG::ReadCondHandleKey<ITkPixelCablingData> ITkPixelCnvTool::m_pixelCablingKey {this, "PixelCablingKey", "", "Cond Key of Pixel Cabling"}

private

Definition at line 51 of file ITkPixelCnvTool.h.

51{this, "PixelCablingKey", "", "Cond Key of Pixel Cabling"};

◆ 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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ITkPixelCnvTool()

Member Function Documentation

◆ convertToByteStream()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_byteStreamCnvSvc

◆ m_dataRateMonTool

◆ m_detStore

◆ m_encodingTool

◆ m_evtStore

◆ m_hitSortingTool

◆ m_pixelCablingKey

◆ m_varHandleArraysDeclared

◆ m_vhka