Algorithm creating xAOD::CaloClusters from CaloClusters. More...

#include <ClusterCreator.h>

Inheritance diagram for ClusterCreator:

Collaboration diagram for ClusterCreator:

Public Member Functions
	ClusterCreator (const std::string &name, ISvcLocator *svcLoc)
	Regular algorithm constructor.
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	execute ()
	Function executing the algorithm.
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>

Private Attributes
std::vector< std::string >	m_aodContainerNames
	The keys of the input CaloClusterContainer.
std::vector< std::string >	m_xaodContainerNames
	The keys for the output xAOD::CaloClusterContainer.
bool	m_keySet
	True if keys set by jobO.
ToolHandle< xAODMaker::ICaloClusterCnvTool >	m_cnvTool
	Connection to the converter tool.
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 creating xAOD::CaloClusters from CaloClusters.

   This algorithm can be used to translate the CaloClusters coming
   from an AOD, and create xAOD::CaloCluster object out of them
   for an output xAOD.

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

Revision: 596346

Date: 2014-05-10 15:47:20 +0200 (Sat, 10 May 2014)

Definition at line 34 of file ClusterCreator.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

◆ ClusterCreator()

ClusterCreator::ClusterCreator	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Regular algorithm constructor.

Definition at line 39 of file ClusterCreator.cxx.

   : AthAlgorithm( name, svcLoc ),
     m_keySet( false ),
     m_cnvTool( "xAODMaker::CaloClusterCnvTool/CaloClusterCnvTool", this ) {
 
   declareProperty( "AODContainerNames", m_aodContainerNames );
   declareProperty( "xAODContainerNames", m_xaodContainerNames );
}

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 ClusterCreator::execute ( )

virtual

Function executing the algorithm.

Definition at line 92 of file ClusterCreator.cxx.

                                   {
 
   //
   // If no StoreGate keys were set, convert everything:
   //
   if( ! m_keySet ) {
      // Get the keys from StoreGate:
      evtStore()->keys< CaloClusterContainer >( m_aodContainerNames,
                                                false, false );
 
      // Use same container key for input and output:
      m_xaodContainerNames = m_aodContainerNames;
 
      ATH_MSG_DEBUG( "Found the following CaloClusterContainers: "
                     << m_aodContainerNames );  
   }
 
   //
   // Loop over container keys:
   //
   const size_t nKeys = m_aodContainerNames.size();
   for( size_t iKey = 0; iKey < nKeys; ++iKey ) {
 
      const std::string& aodName  = m_aodContainerNames[ iKey ];
      const std::string& xaodName = m_xaodContainerNames[ iKey ];
 
      // Check if anything needs to be done:
      if( ! evtStore()->contains< CaloClusterContainer >( aodName ) ) {
         ATH_MSG_DEBUG( "AOD cluster container " << aodName
                        << " not found. Ignored." );
         continue;
      }
      if( evtStore()->contains< xAOD::CaloClusterContainer >( xaodName ) ) {
         ATH_MSG_DEBUG( "xAOD::CaloCluster with key " << xaodName
                        << " exists already. No conversion done" );
         continue;
      }
 
      // Retrieve the AOD clusters:
      const CaloClusterContainer* aod = nullptr;
      CHECK( evtStore()->retrieve( aod, aodName ) );
      ATH_MSG_DEBUG( "Retrieved clusters with key: " << aodName );
 
      // Create new Cell-Link container:
      const std::string ccclc_name = xaodName + "_links";
      CaloClusterCellLinkContainer* ccclc =
         new CaloClusterCellLinkContainer();
      CHECK( evtStore()->record( ccclc, ccclc_name ) );
      
      // Create the xAOD container and its auxiliary store:
      xAOD::CaloClusterContainer* xaod = new xAOD::CaloClusterContainer();
      CHECK( evtStore()->record( xaod, xaodName ) );
      
      xAOD::CaloClusterAuxContainer* aux = new xAOD::CaloClusterAuxContainer(); 
      CHECK( evtStore()->record( aux, xaodName + "Aux." ) );
      
      xaod->setStore( aux );
      ATH_MSG_DEBUG( "Recorded xAOD clusters with key: " << xaodName );
 
 
      // Create the xAOD objects:
      CaloClusterContainer::const_iterator itr = aod->begin();
      CaloClusterContainer::const_iterator end = aod->end();
      for(unsigned i = 0 ; itr != end; ++itr, ++i ) {
 
         ATH_MSG_VERBOSE( "Copying cluster #" << i );
 
         // Create the xAOD object:
         xAOD::CaloCluster* cluster = new xAOD::CaloCluster();
         xaod->push_back( cluster );
 
         // Leave the conversion up to the tool:
         CHECK( m_cnvTool->convert( *itr, cluster, ccclc ) );
 
         ATH_MSG_VERBOSE( "Number of dynamic auxiliary variables: "
                          << aux->getDynamicAuxIDs().size() );
 
      } // end loop over clusters
 
   } // end loop over cluster containers
 
   // Return gracefully:
   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();
}

◆ initialize()

StatusCode ClusterCreator::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 49 of file ClusterCreator.cxx.

                                      {
 
   ATH_MSG_INFO( "Initializing" );
 
   // Retrieve the needed tool(s):
   CHECK( m_cnvTool.retrieve() );
 
   if( m_xaodContainerNames.empty() ) {
      // Assume same key in AOD and xAOD if to explicitly set
      m_xaodContainerNames = m_aodContainerNames;
   }
 
   // A sanity check:
   if( m_aodContainerNames.size() != m_xaodContainerNames.size() ) {
      REPORT_MESSAGE( MSG::FATAL )
         << "Job properties 'AODContainerNames' and 'xAODContainerNames' "
         << "have unequal lenght! (" 
         << m_aodContainerNames.size() << " vs "
         << m_xaodContainerNames.size() << ")";
      return StatusCode::FAILURE;
   }
 
   // Tell the user what's going to happen:
   if( ( m_aodContainerNames.empty() ) &&
       ( m_xaodContainerNames.empty() ) ) {
      ATH_MSG_INFO( "Will convert all CaloClusterContainers in the event");
      m_keySet = false;
   }
   else {
      m_keySet = true;
      const size_t nKeys = m_aodContainerNames.size();
      for (size_t i=0;i<nKeys;++i) {
         ATH_MSG_INFO( "Will convert CaloClusterContainer#"
                       << m_aodContainerNames[ i ]
                       << " to xAOD::CaloClusterContainer#"
                       << m_xaodContainerNames[ i ] );
      }
   }
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

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

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

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

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

std::vector< std::string > ClusterCreator::m_aodContainerNames

private

The keys of the input CaloClusterContainer.

Definition at line 47 of file ClusterCreator.h.

◆ m_cnvTool

ToolHandle< xAODMaker::ICaloClusterCnvTool > ClusterCreator::m_cnvTool

private

Connection to the converter tool.

Definition at line 55 of file ClusterCreator.h.

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

bool ClusterCreator::m_keySet

private

True if keys set by jobO.

Definition at line 52 of file ClusterCreator.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.

◆ m_xaodContainerNames

std::vector< std::string > ClusterCreator::m_xaodContainerNames

private

The keys for the output xAOD::CaloClusterContainer.

Definition at line 49 of file ClusterCreator.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

◆ ClusterCreator()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_aodContainerNames

◆ m_cnvTool

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_keySet

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xaodContainerNames