Algorithm fixing the muon RoI information in the data. More...

#include <MuCTPI_RDOToRoIBResult.h>

Inheritance diagram for MuCTPI_RDOToRoIBResult:

Collaboration diagram for MuCTPI_RDOToRoIBResult:

Public Member Functions
	MuCTPI_RDOToRoIBResult (const std::string &name, ISvcLocator *pSvcLocator)
	Regular algorithm constructor.
virtual StatusCode	execute () override
	Regular algorithm execure function.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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>

Static Private Member Functions
static uint32_t	multiplicityBCID (uint32_t multi_word)
	Extract the BCID stored in the multiplicity word.
static uint32_t	toRoIWord (uint32_t data_word)
	Transform a data word into an RoI word.
static uint32_t	roiBCID (uint32_t data_word)
	Extract the BCID stored in the data word.
static bool	roiAccepted (uint32_t data_word)
	Extract whether the candidate was accepted to be sent to LVL2.

Private Attributes
std::string	m_muctpiInputKey
	Key of the MuCTPI_RDO object.
std::string	m_roibInputKey
	Key of the old (incorrect) RoIBResult object.
std::string	m_roibOutputKey
	Key of the new (correct) RoIBResult object.
DataObjIDColl	m_extendedExtraObjects
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

Algorithm fixing the muon RoI information in the data.

   This algorithm can create a fixed ROIB::RoIBResult object from the
   incorrect object in the data, plus the MuCTPI_RDO readout data.

Author: Attila Krasznahorkay Jr.

Revision: 275499

Date: 2010-01-27 19:25:00 +0100 (Wed, 27 Jan 2010)

Definition at line 27 of file MuCTPI_RDOToRoIBResult.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MuCTPI_RDOToRoIBResult()

MuCTPI_RDOToRoIBResult::MuCTPI_RDOToRoIBResult	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Regular algorithm constructor.

Definition at line 22 of file MuCTPI_RDOToRoIBResult.cxx.

   : AthAlgorithm( name, pSvcLocator ) {
 
   declareProperty( "MuCTPIInputKey", m_muctpiInputKey = "MUCTPI_RDO" );
   declareProperty( "RoIBInputKey", m_roibInputKey = "RoIBResult" );
   declareProperty( "RoIBOutputKey", m_roibOutputKey = "CorrectRoIBResult" );
}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode MuCTPI_RDOToRoIBResult::execute ( )

overridevirtual

Regular algorithm execure function.

Definition at line 31 of file MuCTPI_RDOToRoIBResult.cxx.

                                           {
 
   ATH_MSG_DEBUG( "Executing the MuCTPI RoI fixer algorithm" );
 
   //
   // Retrieve the (hopefully) correct MuCTPI_RDO object:
   //
   const MuCTPI_RDO* muctpi_rdo = 0;
   CHECK( evtStore()->retrieve( muctpi_rdo, m_muctpiInputKey ) );
   ATH_MSG_VERBOSE( "Retrieved the MuCTPI_RDO object with key: "
                    << m_muctpiInputKey );
 
   //
   // Retrieve the (muon-wise) wrong RoIBResult object:
   //
   const ROIB::RoIBResult* roibresult = 0;
   CHECK( evtStore()->retrieve( roibresult, m_roibInputKey ) );
   ATH_MSG_VERBOSE( "Retrieved the old RoIBResult object with key:"
                    << m_roibInputKey );
 
   // Create the correct RoI vector from the RDO data:
   ATH_MSG_VERBOSE( "Now creating the correct RoIs..." );
   std::vector< ROIB::MuCTPIRoI > roi_vector;
 
   uint32_t bcid = multiplicityBCID( muctpi_rdo->candidateMultiplicity() );
 
   //
   // Loop over all "data words" and select the ones that should've been
   // sent ot LVL2:
   //
   std::vector< uint32_t >::const_iterator dword_itr = muctpi_rdo->dataWord().begin();
   std::vector< uint32_t >::const_iterator dword_end = muctpi_rdo->dataWord().end();
   for( ; dword_itr != dword_end; ++dword_itr ) {
 
      // Select which candidates should've gone to LVL2:
      if( roiBCID( *dword_itr ) != bcid ) continue;
      if( ! roiAccepted( *dword_itr ) ) continue;
 
      // Save the candidate:
      roi_vector.push_back( ROIB::MuCTPIRoI( toRoIWord( *dword_itr ) ) );
      ATH_MSG_VERBOSE( "  - Processed data word: 0x" << std::hex << std::setw( 8 )
                       << std::setfill( '0' ) << *dword_itr );
   }
 
   //
   // Create the new MuCTPI result:
   //
   ROIB::MuCTPIResult newResult( ROIB::Header(roibresult->muCTPIResult().header()),
                                 ROIB::Trailer(roibresult->muCTPIResult().trailer()),
                                 std::move(roi_vector) );
 
   //
   // Create and save the new RoIBResult object:
   //
   ROIB::RoIBResult* new_roibresult = new ROIB::RoIBResult( std::move(newResult),
                                                            ROIB::CTPResult(roibresult->cTPResult()),
                                                            std::vector< ROIB::JetEnergyResult >(roibresult->jetEnergyResult()),
                                                            std::vector< ROIB::EMTauResult >(roibresult->eMTauResult()) );
   CHECK( evtStore()->record( new_roibresult, m_roibOutputKey ) );
   ATH_MSG_VERBOSE( "Saved the fixed RoIBResult object with key: "
                    << m_roibOutputKey );
 
   return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ multiplicityBCID()

uint32_t MuCTPI_RDOToRoIBResult::multiplicityBCID ( uint32_t multi_word )

staticprivate

Extract the BCID stored in the multiplicity word.

Parameters

multi_word Multiplicity word from the MuCTPI_RDO object

Returns: The BCID stored in the multiplicity word

Definition at line 100 of file MuCTPI_RDOToRoIBResult.cxx.

                                                                       {
 
   return ( ( multi_word >> 18 ) & 0x7 );
}

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ roiAccepted()

bool MuCTPI_RDOToRoIBResult::roiAccepted ( uint32_t data_word )

staticprivate

Extract whether the candidate was accepted to be sent to LVL2.

Parameters

data_word Data word from the MuCTPI_RDO object

Returns: true if the candidate was destined to go to LVL2, false otherwise

Definition at line 129 of file MuCTPI_RDOToRoIBResult.cxx.

                                                             {
 
   return ( ( data_word >> 26 ) & 0x1 );
}

◆ roiBCID()

uint32_t MuCTPI_RDOToRoIBResult::roiBCID ( uint32_t data_word )

staticprivate

Extract the BCID stored in the data word.

Parameters

data_word Data word from the MuCTPI_RDO object

Returns: the BCID stored in the data word

Definition at line 119 of file MuCTPI_RDOToRoIBResult.cxx.

                                                             {
 
   return ( ( data_word >> 14 ) & 0x7 );
}

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ toRoIWord()

uint32_t MuCTPI_RDOToRoIBResult::toRoIWord ( uint32_t data_word )

staticprivate

Transform a data word into an RoI word.

Parameters

data_word Data word from the MuCTPI_RDO object

Returns: The RoI word created from the data word

Definition at line 109 of file MuCTPI_RDOToRoIBResult.cxx.

                                                               {
 
   return ( ( ( data_word & 0x8000000 ) >> 4 ) | ( ( data_word & 0x3fe0000 ) >> 3 ) |
            ( data_word & 0x3fff ) );
}

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_muctpiInputKey

std::string MuCTPI_RDOToRoIBResult::m_muctpiInputKey

private

Key of the MuCTPI_RDO object.

Definition at line 46 of file MuCTPI_RDOToRoIBResult.h.

◆ m_roibInputKey

std::string MuCTPI_RDOToRoIBResult::m_roibInputKey

private

Key of the old (incorrect) RoIBResult object.

Definition at line 47 of file MuCTPI_RDOToRoIBResult.h.

◆ m_roibOutputKey

std::string MuCTPI_RDOToRoIBResult::m_roibOutputKey

private

Key of the new (correct) RoIBResult object.

Definition at line 48 of file MuCTPI_RDOToRoIBResult.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuCTPI_RDOToRoIBResult()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ multiplicityBCID()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ roiAccepted()

◆ roiBCID()

◆ sysInitialize()

◆ sysStart()

◆ toRoIWord()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_muctpiInputKey

◆ m_roibInputKey

◆ m_roibOutputKey

◆ m_varHandleArraysDeclared

◆ m_vhka