xAODMaker::CaloClusterCnvTool Class Reference

Implementation of the ICaloClusterCnvTool interface. More...

#include <CaloClusterCnvTool.h>

Inheritance diagram for xAODMaker::CaloClusterCnvTool:

Collaboration diagram for xAODMaker::CaloClusterCnvTool:

Public Member Functions
	CaloClusterCnvTool (const std::string &type, const std::string &name, const IInterface *parent)
	Regular AlgTool constructor.
virtual StatusCode	convert (const CaloCluster *aod, xAOD::CaloCluster *xaod, CaloClusterCellLinkContainer *ccclc=0) const override
	Function that fill an existing xAOD::CaloCluster object with info.
virtual StatusCode	convert (const CaloClusterContainer *aod, xAOD::CaloClusterContainer *xaod) const override
	Function usable by TrigBStoxAODTool.
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 ()
	Gaudi interface definition.

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

Implementation of the ICaloClusterCnvTool interface.

   This tool holds the code doing the actual heavy lifting in
   converting an old CaloCluster object into an xAOD::CaloCluster
   one. It is used both by the package's main algorithm, and the
   trigger code when reading old BS files.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Walter Lampl Walte.nosp@m.r.La.nosp@m.mpl@c.nosp@m.ern..nosp@m.ch

Definition at line 29 of file CaloClusterCnvTool.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

CaloClusterCnvTool()

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

Regular AlgTool constructor.

Definition at line 47 of file CaloClusterCnvTool.cxx.

      : AthAlgTool( type, name, parent ) {
 
      // Declare the interface(s) that the tool implements:
      declareInterface< ICaloClusterCnvTool >( this );
   }

Member Function Documentation

convert() [1/2]

StatusCode xAODMaker::CaloClusterCnvTool::convert ( const CaloCluster * aod, xAOD::CaloCluster * xaod, CaloClusterCellLinkContainer * ccclc = 0 ) const

overridevirtual

Function that fill an existing xAOD::CaloCluster object with info.

Implements xAODMaker::ICaloClusterCnvTool.

Definition at line 56 of file CaloClusterCnvTool.cxx.

   {
 
      //
      // Deal with the cell association:
      //
      if( aod->isCellLinkValid() && ccclc ) {
 
         ATH_MSG_DEBUG( "Found cluster with valid cell link" );
 
         CaloCluster::cell_iterator cit   = aod->begin();
         CaloCluster::cell_iterator cit_e = aod->end();
         if( cit != cit_e ) { //Protect against empty-cluster case
 
            //Get underlying cell container
            const CaloCellContainer* ccc = aod->getContainer( cit );
 
            if( ccc && ( !ccc->empty() ) ) { 
 
               CaloClusterCellLink* cccl = new CaloClusterCellLink( ccc );
               xaod->addCellLink( cccl );
               for( ; cit != cit_e; ++cit ) {
                  xaod->addCell( cit.getElement().index(), cit.getParameter() );
               }//end loop over cells of a cluster
 
               // Move cell links to external cell-link container:
               xaod->setLink( ccclc );
 
            } //end cell container ptr not NULL
            else {
               ATH_MSG_INFO( "Got NULL ptr to CaloCellContainer" );
            }
 
         }//end check cluster not-empty
         else {
            ATH_MSG_DEBUG( "Found cluster with empty list of constituents" );
         }
      }//end if isCellLink valid
      else {
         ATH_MSG_DEBUG( "Found cluster without valid cell link" );
      }
 
      // Set basic quantities:
      xaod->setSamplingPattern( aod->samplingPattern() );
      const xAOD::CaloCluster::ClusterSize clSize =
         static_cast< xAOD::CaloCluster::ClusterSize >( aod->getClusterSize() );
      xaod->setClusterSize( clSize );
      xaod->setEta0( ( double ) aod->eta0() );
      xaod->setPhi0( ( double ) aod->phi0() );
      xaod->setTime( aod->getTime() );
 
      xaod->setCalE(   aod->e   (P4SignalState::CALIBRATED) );
      xaod->setCalEta( aod->eta (P4SignalState::CALIBRATED) );
      xaod->setCalPhi( aod->phi (P4SignalState::CALIBRATED) );
      xaod->setCalM(   aod->m   (P4SignalState::CALIBRATED) );
 
      xaod->setRawE(   aod->e   (P4SignalState::UNCALIBRATED) );
      xaod->setRawEta( aod->eta (P4SignalState::UNCALIBRATED) );
      xaod->setRawPhi( aod->phi (P4SignalState::UNCALIBRATED) );
      xaod->setRawM(   aod->m   (P4SignalState::UNCALIBRATED) );
 
      xaod->setAltE(   aod->e   (P4SignalState::ALTCALIBRATED) );
      xaod->setAltEta( aod->eta (P4SignalState::ALTCALIBRATED) );
      xaod->setAltPhi( aod->phi (P4SignalState::ALTCALIBRATED) );
      xaod->setAltM(   aod->m   (P4SignalState::ALTCALIBRATED) );
 
      //
      // Copy the energy depositions per sampling:
      copyClusterVariables (aod, xaod,
                            CaloVariableType::ETA,
                            &xAOD::CaloCluster::setEta);
      copyClusterVariables (aod, xaod,
                            CaloVariableType::PHI,
                            &xAOD::CaloCluster::setPhi);
      copyClusterVariables (aod, xaod,
                            CaloVariableType::ENERGY,
                            &xAOD::CaloCluster::setEnergy);
 
      //
      // Copy bad-channel data:
      //
      xAOD::CaloClusterBadChannelList badChanList;
      const std::vector< CaloClusterBadChannelData >* bcvec =
         aod->getBadChannel();
      for( const CaloClusterBadChannelData& bcd : *bcvec ) {
         badChanList.emplace_back( bcd.getEta(), bcd.getPhi(),
                                   bcd.getLayer(), bcd.getFlag().packedData() );
      }
      xaod->setBadChannelList( badChanList );
 
      //
      // Copy the moments:
      //
      CaloCluster::moment_iterator mom_itr = aod->beginMoment();
      CaloCluster::moment_iterator mom_end = aod->endMoment();
      for( ; mom_itr != mom_end; ++mom_itr ) {
 
         // Forcibly convert between the two types:
     const CaloCluster::moment_type aod_type =
           static_cast<CaloCluster::moment_type>(mom_itr.getMomentType());
         const xAOD::CaloCluster_v1::MomentType xaod_type =
            static_cast< xAOD::CaloCluster_v1::MomentType >( aod_type );
 
         // Insert the moment:
         xaod->insertMoment( xaod_type,
                             mom_itr.getMoment().getValue() );
         ATH_MSG_VERBOSE( "Copied moment " << aod_type );
      }
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

convert() [2/2]

StatusCode xAODMaker::CaloClusterCnvTool::convert ( const CaloClusterContainer * aod, xAOD::CaloClusterContainer * xaod ) const

overridevirtual

Function usable by TrigBStoxAODTool.

Implements xAODMaker::ICaloClusterCnvTool.

Definition at line 172 of file CaloClusterCnvTool.cxx.

                                                   {
     
     CaloClusterContainer::const_iterator it = aod->begin();
     CaloClusterContainer::const_iterator itE = aod->end();
     CaloClusterCellLinkContainer* ccclc = nullptr;
 
     for( ; it!= itE; ++it){
       xAOD::CaloCluster* xcluster = new xAOD::CaloCluster();
       xaod->push_back( xcluster );
       CHECK( convert( *it, xcluster, ccclc) );       
     }
     
     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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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

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 & xAODMaker::ICaloClusterCnvTool::interfaceID ( )

inlinestaticinherited

Gaudi interface definition.

Definition at line 53 of file ICaloClusterCnvTool.h.

                                              {
         return IID_ICaloClusterCnvTool;
      }

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_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:

• CaloClusterCnvTool.h
• CaloClusterCnvTool.cxx