#include <ITkPixelHitSortingTool.h>

Inheritance diagram for ITkPixelHitSortingTool:

Collaboration diagram for ITkPixelHitSortingTool:

Public Types
typedef ITkPixLayout< uint16_t >	HitMap

Public Member Functions
	ITkPixelHitSortingTool (const std::string &type, const std::string &name, const IInterface *parent)
StatusCode	initialize ()
template<class ContainerType>
std::map< ITkPixelOnlineId, HitMap >	sortRDOHits (const ContainerType rdoContainer, const ITkPixelCablingData cabling) const
template<class ContainerType, class RDOType>
StatusCode	createRDO (std::map< ITkPixelOnlineId, HitMap > &EventHitMaps, ContainerType *rdoContainer) const
template<class ContainerType>
std::map< ITkPixelOnlineId, ITkPixLayout< uint16_t > >	sortRDOHits (const ContainerType rdoContainer, const ITkPixelCablingData cabling) const
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
ServiceHandle< InDetDD::IPixelReadoutManager >	m_pixelReadout {this, "PixelReadoutManager", "ITkPixelReadoutManager", "Pixel readout manager"}
const PixelID *	m_pixIdHelper {}
const InDetDD::PixelDetectorManager *	m_detManager {}
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 30 of file ITkPixelHitSortingTool.h.

Member Typedef Documentation

◆ HitMap

typedef ITkPixLayout<uint16_t> ITkPixelHitSortingTool::HitMap

Definition at line 33 of file ITkPixelHitSortingTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ITkPixelHitSortingTool()

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

Definition at line 20 of file ITkPixelHitSortingTool.cxx.

                                                                                                                   : 
  AthAlgTool(type,name,parent)
{
    //not much to construct as of now
}

Member Function Documentation

◆ createRDO()

template<class ContainerType, class RDOType>

StatusCode ITkPixelHitSortingTool::createRDO	(	std::map< ITkPixelOnlineId, HitMap > &	EventHitMaps,
		ContainerType *	rdoContainer ) const

◆ 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:381

◆ 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:378

◆ 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 ITkPixelHitSortingTool::initialize ( )

Definition at line 27 of file ITkPixelHitSortingTool.cxx.

                                             {
    ATH_CHECK(m_pixelReadout.retrieve());
    ATH_CHECK(detStore()->retrieve(m_pixIdHelper, "PixelID"));
    ATH_CHECK(detStore()->retrieve(m_detManager, "ITkPixel"));
    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 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sortRDOHits() [1/2]

template<class ContainerType>

std::map< ITkPixelOnlineId, ITkPixLayout< uint16_t > > ITkPixelHitSortingTool::sortRDOHits	(	const ContainerType *	rdoContainer,
		const ITkPixelCablingData *	cabling ) const

Definition at line 35 of file ITkPixelHitSortingTool.cxx.

                                                                                                                                                                {
 
    std::map<ITkPixelOnlineId, ITkPixLayout<uint16_t>> EventHitMaps;
 
    for(const auto& RDO_Collection : *rdoContainer){
 
      for(const auto *const rdo : *RDO_Collection) {
 
        const Identifier rdoID = rdo->identify();
        const Identifier waferID = m_pixIdHelper->wafer_id(rdoID);
 
        const uint16_t tot  = rdo->getToT();
 
        uint16_t col  = (uint16_t) m_pixIdHelper->eta_index(rdoID);
        uint16_t row  = (uint16_t) m_pixIdHelper->phi_index(rdoID);
        const uint32_t chip = (const uint32_t) ITkPixelCablingData::chipID( cabling->transformType(waferID.get_identifier32().get_compact()), col, row);
 
        ATH_MSG_DEBUG("Before Inverse transform");
        ITkPixelCabling::chipToModuleInverseTransform(cabling->transformType(waferID.get_identifier32().get_compact()), chip, col, row);
        ATH_MSG_DEBUG("After Inverse transform");
        //find out if we're dealing with 25x100 sensors
        const InDetDD::SiDetectorElement *element = m_detManager->getDetectorElement(waferID);
        const InDetDD::PixelModuleDesign *p_design = static_cast<const InDetDD::PixelModuleDesign *>(&element->design());
        const uint nChips = p_design->numberOfCircuits();
        const uint rowsPerFE =  p_design->rowsPerCircuit();
        const uint colsPerFE =  p_design->columnsPerCircuit();
        
        ATH_MSG_DEBUG("Module specs: nChips = " << nChips << ", rows per FE = " << rowsPerFE << " cols per FE = " << colsPerFE);
        //<----------        
        
        //Store ToT+1, reserve 0 for no hit.
        //HitMap and encoder labels rows/cols from 0
 
        //Data from a FE are identified by "DetectorResourceID", which is part
        //of the header delimiting individual FE payloads within a ROD fragment
        //payload. The DetectorResourceID is detector-defined. For pixels, it
        //has an 'online part', containing chipID and information useful for decoding
        //(chipID on/off). Then there's an offline-specific part
        //composed - for convenience - of (offline) module ID. We can mask out
        //the auxiliary online info to get the mapping from FE -> online ID
        //  offlineDetectorResourceID = chipID [2 MSB] | module ID [24 LSB]
        //Furthermore, we need to know which ROB fragment the data will go to,
        //hence we need the 'sourceID' (in eformat vocabulary), which identifies
        //the DMA buffer on the FELIX machine that received the data. This is
        //all provided by the cabling package, which gives
        //  offlineDetectorResourceID -> {DetectorResourceID, sourceID}
        //mapping.
 
        //ITkPixelCabling::ModuleInfo mi = cabling->onlineModuleInfo(waferID);
        uint32_t offlineDetectorResourceID = (waferID.get_identifier32().get_compact() >> 8) | (chip << 30);
       
        ITkPixelOnlineId onlineID = cabling->onlineId(offlineDetectorResourceID);
 
        //Found a valid ID?
        if (onlineID.sourceID() == 0xFFFFFFFF){
            ATH_MSG_WARNING("Cabling not found for module bec " << std::dec << m_pixIdHelper->barrel_ec(waferID) << " ld " << m_pixIdHelper->layer_disk(waferID) << " eta " << m_pixIdHelper->eta_module(waferID) << " phi " << m_pixIdHelper->phi_module(waferID) << ", proceeding with a dummy value");
            onlineID = ITkPixelOnlineId(0x00170000 | (offlineDetectorResourceID & 0x0000FFFF), offlineDetectorResourceID | 0xF0000000);
        }
 
        ATH_MSG_DEBUG(" Chip: " << std::hex << onlineID << std::dec << " ID: " << chip << " col: " << col << "  row: " << row << " ToT: " << tot << " eta_index = " << m_pixIdHelper->eta_index(rdoID) << " phi index = " << m_pixIdHelper->phi_index(rdoID) << " rowsPerFE = " << rowsPerFE << " colsPerFE = " << colsPerFE << "\n");
        
        EventHitMaps[onlineID](col, row) = tot + 1;
 
      };
    };
 
    return EventHitMaps;
 
}

◆ sortRDOHits() [2/2]

template<class ContainerType>

std::map< ITkPixelOnlineId, HitMap > ITkPixelHitSortingTool::sortRDOHits	(	const ContainerType *	rdoContainer,
		const ITkPixelCablingData *	cabling ) const

◆ 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 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detManager

const InDetDD::PixelDetectorManager* ITkPixelHitSortingTool::m_detManager {}

private

Definition at line 52 of file ITkPixelHitSortingTool.h.

52{};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

◆ m_pixelReadout

ServiceHandle< InDetDD::IPixelReadoutManager > ITkPixelHitSortingTool::m_pixelReadout {this, "PixelReadoutManager", "ITkPixelReadoutManager", "Pixel readout manager"}

private

Definition at line 48 of file ITkPixelHitSortingTool.h.

48{this, "PixelReadoutManager", "ITkPixelReadoutManager", "Pixel readout manager"};

◆ m_pixIdHelper

const PixelID* ITkPixelHitSortingTool::m_pixIdHelper {}

private

Definition at line 50 of file ITkPixelHitSortingTool.h.

50{};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HitMap

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ITkPixelHitSortingTool()

Member Function Documentation

◆ createRDO()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sortRDOHits() [1/2]

◆ sortRDOHits() [2/2]

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detManager

◆ m_detStore

◆ m_evtStore

◆ m_pixelReadout

◆ m_pixIdHelper

◆ m_varHandleArraysDeclared

◆ m_vhka