Tool doing the ByteStream -> MuCTPI_RIO conversion. More...

#include <RecMuCTPIByteStreamTool.h>

Inheritance diagram for RecMuCTPIByteStreamTool:

Collaboration diagram for RecMuCTPIByteStreamTool:

Public Member Functions
	RecMuCTPIByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor.
virtual StatusCode	initialize () override
	Function to initialise the tool.
StatusCode	convert (const ROBF rob, MuCTPI_RIO &cont)
	Convert ROBFragment to MuCTPI_RIO.
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 OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment	ROBF
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
MuCTPISrcIdMap	m_srcIdMap
	Object storing the various IDs of the MuCTPI fragment.
ToolHandle< LVL1::ITrigT1MuonRecRoiTool >	m_rpcRoITool
ToolHandle< LVL1::ITrigT1MuonRecRoiTool >	m_tgcRoITool
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool doing the ByteStream -> MuCTPI_RIO conversion.

   The actual work of translating the information in a MuCTPI ROB fragment
   into a MuCTPI_RIO object is done with this tool.

See also: CTPByteStreamCnv

Author: Tadashi Maeno; Attila Krasznahorkay; David Berge; Christian Ohm

Definition at line 36 of file RecMuCTPIByteStreamTool.h.

Member Typedef Documentation

◆ ROBF

typedef OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment RecMuCTPIByteStreamTool::ROBF

private

Definition at line 39 of file RecMuCTPIByteStreamTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ RecMuCTPIByteStreamTool()

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

Default constructor.

The constructor takes care of correctly constructing the base class and declaring the tool's interface to the framework.

Definition at line 32 of file RecMuCTPIByteStreamTool.cxx.

  : AthAlgTool( type, name, parent )
 
{
  declareInterface< RecMuCTPIByteStreamTool >( this );
}

Member Function Documentation

◆ convert()

StatusCode RecMuCTPIByteStreamTool::convert	(	const ROBF *	rob,
		MuCTPI_RIO *&	result )

Convert ROBFragment to MuCTPI_RIO.

Conversion from eformat::ROBFragment to RIO.

This is called from the RecMuCTPIByteStreamCnv::createObj method.

Definition at line 70 of file RecMuCTPIByteStreamTool.cxx.

                                                                                  {
 
  ATH_MSG_DEBUG("executing convert() from ROBFragment to RIO");
 
  // L1Menu
  const TrigConf::L1Menu * l1menu = nullptr;
  ATH_CHECK( detStore()->retrieve(l1menu) );
 
  // Source ID of MIROD
  const uint32_t miRodId = m_srcIdMap.getRodID();
 
  /* get ROD source ID */
  uint32_t rodId = rob->rod_source_id();
 
  if( rodId == miRodId ) {
    
    // result
    MuCTPI_RIO* muCTPI_RIO = new MuCTPI_RIO;
 
    // get the ROD header data and store it
    const uint32_t bcid = rob->rod_bc_id();
    const uint32_t ndata = rob->rod_ndata();
    const uint32_t detev_type = rob->rod_detev_type();
    const uint32_t lvl1_type = rob->rod_lvl1_trigger_type();
    const uint32_t lvl1_id = rob->rod_lvl1_id();
    const uint32_t run_no = rob->rod_run_no();
    const uint32_t nstatus = rob->rod_nstatus();
    OFFLINE_FRAGMENTS_NAMESPACE::PointerType it_statusData;
    rob->rod_status( it_statusData );
    
    ATH_MSG_VERBOSE(" Dumping CTP ROD fragment Header data:");
    ATH_MSG_VERBOSE("Source ID            0x" << MSG::hex << rodId << MSG::dec);
    ATH_MSG_VERBOSE("BCID                 0x" << MSG::hex << bcid << MSG::dec 
        << " (dec " << bcid << ")");
    ATH_MSG_VERBOSE("Detector event type  0x" << MSG::hex << detev_type 
        << MSG::dec << " (dec " << detev_type << ")");
    ATH_MSG_VERBOSE("Level-1 ID           0x" << MSG::hex << lvl1_id << MSG::dec 
        << " (dec " << lvl1_id << ")");
    ATH_MSG_VERBOSE("Level-1 type         0x" << MSG::hex << lvl1_type << MSG::dec 
        << " (dec " << lvl1_type << ")");
    ATH_MSG_VERBOSE("Run number             " << run_no);
    ATH_MSG_VERBOSE("Number of data words   " << ndata);
    ATH_MSG_VERBOSE("Number of status words ");
    for ( uint32_t i = 0; i < nstatus; ++i , ++it_statusData) {
      ATH_MSG_VERBOSE("Status word # " << i << ": 0x" << MSG::hex << (*it_statusData) << MSG::dec
          << " (dec " << (*it_statusData) << ")");      
      muCTPI_RIO->headerStatusWords().push_back( static_cast<uint32_t>( *it_statusData ) );
    }
    muCTPI_RIO->headerSourceId(rodId);
    muCTPI_RIO->headerRunNumber(run_no);
    muCTPI_RIO->headerLVL1ID(lvl1_id);
    muCTPI_RIO->headerBCID(bcid);
    muCTPI_RIO->headerLVL1TriggerType(lvl1_type);
    muCTPI_RIO->headerDetectorEventType(detev_type);
    muCTPI_RIO->headerNumberDataWords(ndata);
    muCTPI_RIO->headerNumberStatusWords(nstatus);
 
    ATH_MSG_DEBUG("  Dumping MuCTPI words:");
 
    OFFLINE_FRAGMENTS_NAMESPACE::PointerType it_data;
    rob->rod_data( it_data );
 
    //First count mult words
    int nMultWords = 0;
    for( uint32_t i = 0; i < ndata; ++i ) {
      if( ((*it_data) & 0x20000000) != 0 ) nMultWords++;
      ++it_data;
    }
 
    rob->rod_data( it_data );
    
    it_data+=(nMultWords-1)/2;//Goes to the central BC of the RO window
 
    ATH_MSG_DEBUG("     0x" << MSG::hex << std::setw( 8 ) << *it_data
        << " (candidate multiplicity)");
 
    // candidate multiplicities
    uint16_t sum[ MuCTPI_RIO::N_SUM ];
    for ( int i = 0; i < MuCTPI_RIO::N_SUM; ++i )
      sum[ i ] = ( *it_data >> ( i * 3 ) ) & 0x1F;
    muCTPI_RIO->setSum( sum );
 
    // BCID
    uint16_t g_bcId = ( (*it_data) & 0x001C0000 ) >> 18;
    muCTPI_RIO->setBCID( g_bcId );
 
    it_data+=(nMultWords+1)/2;//Goes to the first candidate word;
 
    // data words
    for( uint32_t i = nMultWords; i < ndata; ++i, ++it_data ) {
 
      ATH_MSG_DEBUG("     0x" << MSG::hex << std::setw( 8 ) << *it_data);
 
      // extract BCID
      const uint32_t tmpWord = static_cast<uint32_t>( *it_data ); // The two types are the same right now, but it might change.
      uint16_t bcId = ( tmpWord & 0x0001C000 ) >> 14;
 
      // accepted bit
      bool accepted = true;
      if ( ( tmpWord & 0x04000000 ) == 0 )
        accepted = false;
 
      // make RoI word
      uint32_t roiWord = ( tmpWord & 0x00003FFF ) + ( ( tmpWord & 0x03FE0000 ) >> 3 );
 
      ATH_MSG_DEBUG(MSG::hex << std::setw( 8 ) << *it_data
          << " : ROI=" << std::setw( 8 ) << roiWord);
 
      // reconstruct
      LVL1::RecMuonRoI thisRoI( roiWord, m_rpcRoITool.isSet() ? m_rpcRoITool.get() : 0,
                                m_tgcRoITool.isSet() ? m_tgcRoITool.get() : 0, l1menu );
 
      uint16_t pTVal = thisRoI.getThresholdValue();
      uint16_t pTNumber = thisRoI.getThresholdNumber();
      uint16_t roiNumber = thisRoI.getRoINumber();
      uint16_t secId = thisRoI.sectorID();
      uint16_t sysId = thisRoI.sysID();
      uint16_t hemisphere = thisRoI.subsysID();
      double eta = thisRoI.eta();
      double phi = thisRoI.phi();
      bool first = thisRoI.firstCandidate();
      bool duplicatedRoI = thisRoI.padOverflow();
      bool duplicatedSector = thisRoI.sectorOverflow();
 
      // fill
      muCTPI_RIO->setRoI( bcId, pTVal,pTNumber, eta, phi, secId, sysId, hemisphere, roiNumber,
                          accepted, first, duplicatedRoI, duplicatedSector );
    }
 
    /* set return value */
    result = muCTPI_RIO;
 
    return StatusCode::SUCCESS;
 
  } else {
  
    ATH_MSG_WARNING("Expected source ID 0x" << MSG::hex << miRodId << " but found 0x" 
        << rodId << MSG::dec);
    return StatusCode::FAILURE;
  
  }
}

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

overridevirtual

Function to initialise the tool.

The function connects to all services being used, resets the internally used variables, and initialises the base class.

Definition at line 45 of file RecMuCTPIByteStreamTool.cxx.

                                               {
 
  StatusCode sc = m_rpcRoITool.retrieve();
  if( sc.isFailure() ) {
    ATH_MSG_WARNING("Couldn't access RPC RecMuonRoISvc");
  } else {
    ATH_MSG_DEBUG("Connected to RPC RecMuonRoISvc");
  }
 
  sc = m_tgcRoITool.retrieve();
  if( sc.isFailure() ) {
    ATH_MSG_WARNING("Couldn't access TGC RecMuonRoISvc");
  } else {
    ATH_MSG_DEBUG("Connected to TGC RecMuonRoISvc");
  }
 
  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 & RecMuCTPIByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

This function is needed by the framework to know what kind of tool this is.

Definition at line 22 of file RecMuCTPIByteStreamTool.cxx.

                                                        {
 
  return IID_IRecMuCTPIByteStreamTool;
 
}

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

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_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_rpcRoITool

ToolHandle<LVL1::ITrigT1MuonRecRoiTool> RecMuCTPIByteStreamTool::m_rpcRoITool

private

Initial value:

{
    this, "RPCRecRoiSvc", "LVL1::TrigT1RPCRecRoiTool/TrigT1RPCRecRoiTool", "RPC RoI reconstruction tool"
  }

Definition at line 59 of file RecMuCTPIByteStreamTool.h.

                                                     {
    this, "RPCRecRoiSvc", "LVL1::TrigT1RPCRecRoiTool/TrigT1RPCRecRoiTool", "RPC RoI reconstruction tool"
  };

◆ m_srcIdMap

MuCTPISrcIdMap RecMuCTPIByteStreamTool::m_srcIdMap

private

Object storing the various IDs of the MuCTPI fragment.

Definition at line 57 of file RecMuCTPIByteStreamTool.h.

◆ m_tgcRoITool

ToolHandle<LVL1::ITrigT1MuonRecRoiTool> RecMuCTPIByteStreamTool::m_tgcRoITool

private

Initial value:

{
    this, "TGCRecRoiSvc", "LVL1::TrigT1TGCRecRoiTool/TrigT1TGCRecRoiTool", "TGC RoI reconstruction tool"
  }

Definition at line 62 of file RecMuCTPIByteStreamTool.h.

                                                     {
    this, "TGCRecRoiSvc", "LVL1::TrigT1TGCRecRoiTool/TrigT1TGCRecRoiTool", "TGC RoI reconstruction tool"
  };

◆ 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

◆ ROBF

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ RecMuCTPIByteStreamTool()

Member Function Documentation

◆ convert()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_rpcRoITool

◆ m_srcIdMap

◆ m_tgcRoITool

◆ m_varHandleArraysDeclared

◆ m_vhka