CaloClusterCopier Class Reference

#include <CaloClusterCopier.h>

Inheritance diagram for CaloClusterCopier:

Collaboration diagram for CaloClusterCopier:

Public Member Functions
	CaloClusterCopier (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~CaloClusterCopier () override
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *) const override
	Execute on an entire collection of clusters.
void	getClusterSize ()
virtual StatusCode	execute (xAOD::CaloClusterContainer *collection) final
	Execute on an entire collection of clusters.
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
	DeclareInterfaceID (CaloClusterCollectionProcessor, 1, 0)

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
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clustersKey
bool	m_copyCells
bool	m_useClusterPosition
float	m_etCut
xAOD::CaloCluster::ClusterSize	m_clusterSize
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 34 of file CaloClusterCopier.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

CaloClusterCopier()

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

Definition at line 28 of file CaloClusterCopier.cxx.

                                            :
  AthAlgTool(type, name, parent),
  m_clustersKey(""),
  m_copyCells(true),m_useClusterPosition(false),m_etCut(-1.), m_clusterSize(xAOD::CaloCluster_v1::CSize_Unknown)
{ 
  declareInterface<CaloClusterCollectionProcessor> (this);
  declareProperty("ClustersName",m_clustersKey);
  declareProperty("CopyCells",m_copyCells);
  declareProperty("UseClusterPosition",m_useClusterPosition);
  declareProperty("etCut",m_etCut);
}

~CaloClusterCopier()

CaloClusterCopier::~CaloClusterCopier ( )

overridevirtualdefault

Member Function Documentation

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

DeclareInterfaceID()

CaloClusterCollectionProcessor::DeclareInterfaceID ( CaloClusterCollectionProcessor , 1 , 0  )

inherited

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

execute() [1/2]

StatusCode CaloClusterCopier::execute ( const EventContext & ctx, xAOD::CaloClusterContainer * collection ) const

overridevirtual

Execute on an entire collection of clusters.

Parameters

collection

The container of clusters. param ctx The event context.

Implements CaloClusterCollectionProcessor.

Definition at line 66 of file CaloClusterCopier.cxx.

{
  ATH_MSG_DEBUG("Executing CaloClusterCopier");
  SG::ReadHandle<xAOD::CaloClusterContainer> inputContainer( m_clustersKey, ctx);
  
  xAOD::CaloClusterContainer::const_iterator it = inputContainer->begin();
  xAOD::CaloClusterContainer::const_iterator it_e = inputContainer->end();
  for(; it!=it_e;++it) {
    const xAOD::CaloCluster* old = *it; 
    if (m_etCut < 0 || std::fabs(old->et()) > m_etCut) {
      // make the cluster
      xAOD::CaloCluster* cluster_ptr = CaloClusterStoreHelper::makeCluster(clusColl,old->getCellLinks()->getCellContainer());
      if (m_useClusterPosition) {
    cluster_ptr->setEta0(old->eta());
    cluster_ptr->setPhi0(old->phi());
      } else {
    cluster_ptr->setEta0(old->eta0());
    cluster_ptr->setPhi0(old->phi0());
      }
 
      cluster_ptr->setClusterSize(m_clusterSize);
 
      if (m_copyCells){
    //Copy constructor for cell-link object??
    //CaloClusterCellLink* links=new CaloClusterCellLink(oldCellLinks->getCellContainer());
    //cluster_ptr->addCellLink(links);
    // get all the cells 
    xAOD::CaloCluster::const_cell_iterator it_cell=old->cell_begin(); 
    xAOD::CaloCluster::const_cell_iterator it_cell_e=old->cell_end(); 
    // put the cell in cluster  
    int nhit = 0; 
    for(; it_cell!=it_cell_e; ++it_cell)  {
      cluster_ptr->addCell(it_cell.index(),1.0); 
      ++nhit; 
    }
    //update kine!
    CaloClusterKineHelper::calculateKine(cluster_ptr,false,true); //No weight at this point! 
    ATH_MSG_DEBUG(" Number of cells = " <<nhit);
      }// end if m_copyCells
    }//end if et cut
  }//end loop over input clusters
 
  ATH_MSG_DEBUG("Done with copying clusters, number of clusters= " << clusColl->size());
  return StatusCode::SUCCESS;
}

execute() [2/2]

virtual StatusCode CaloClusterCollectionProcessor::execute ( xAOD::CaloClusterContainer * collection )

inlinefinalvirtual

Execute on an entire collection of clusters.

Parameters

collection

The container of clusters. (deprecated)

Reimplemented from CaloClusterCollectionProcessor.

Definition at line 50 of file CaloClusterCollectionProcessor.h.

  {
    return execute (Gaudi::Hive::currentContext(), collection);
  }

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

getClusterSize()

void CaloClusterCopier::getClusterSize

(

)

Definition at line 114 of file CaloClusterCopier.cxx.

                                      {
 
  if(name()=="LArgamClusterMaker.larClusterCopier"){
    m_clusterSize = xAOD::CaloCluster::SW_55ele; 
  }else if(name()=="LAr35ClusterMaker.larClusterCopier35"){
    m_clusterSize = xAOD::CaloCluster::SW_35ele; 
  }else if(name()=="LAr37ClusterMaker.larClusterCopier37"){
    m_clusterSize = xAOD::CaloCluster::SW_37ele; 
  }else if(name()=="LArgamClusterMaker.larClusterCopiergam"){
    m_clusterSize = xAOD::CaloCluster::SW_55gam; 
  }else if(name()=="LArgam35ClusterMaker.larClusterCopiergam35"){
    m_clusterSize = xAOD::CaloCluster::SW_35gam; 
  }else if(name()=="LArgam37ClusterMaker.larClusterCopiergam37"){
    m_clusterSize = xAOD::CaloCluster::SW_37gam; 
  }else if (name()=="EMTopo35ClusterMaker.TopoEMCopier35") {
    m_clusterSize = xAOD::CaloCluster::SW_35gam;
  }
 
  ATH_MSG_DEBUG("Name, Cluster size = " << name() << " " << m_clusterSize);
 
}

initialize()

StatusCode CaloClusterCopier::initialize ( )

overridevirtual

Definition at line 48 of file CaloClusterCopier.cxx.

                                         {
 
  ATH_MSG_INFO( " Careful: CaloClusterCopier only copy eta0 phi0"  );
  
  if (!m_copyCells){
    ATH_MSG_INFO( " Do not copy cells "  );
    //    ATH_MSG_ERROR( " CopyCell=False : Possibility to copy cluster without cells not implemented yet. Ignored."  );
    
  } else {
    ATH_MSG_WARNING( " Copy of cluster with cells not well tested "  );
  }
  ATH_CHECK(m_clustersKey.initialize());
  
  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 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_clusterSize

xAOD::CaloCluster::ClusterSize CaloClusterCopier::m_clusterSize

private

Definition at line 57 of file CaloClusterCopier.h.

m_clustersKey

SG::ReadHandleKey<xAOD::CaloClusterContainer> CaloClusterCopier::m_clustersKey

private

Definition at line 53 of file CaloClusterCopier.h.

m_copyCells

bool CaloClusterCopier::m_copyCells

private

Definition at line 54 of file CaloClusterCopier.h.

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_etCut

float CaloClusterCopier::m_etCut

private

Definition at line 56 of file CaloClusterCopier.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_useClusterPosition

bool CaloClusterCopier::m_useClusterPosition

private

Definition at line 55 of file CaloClusterCopier.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:

• CaloClusterCopier.h
• CaloClusterCopier.cxx