Algorithm to create a eta ordered ROIs in the eta phi plane. More...

#include <CaloClusterROIPhiRZContainerMaker.h>

Inheritance diagram for InDet::CaloClusterROIPhiRZContainerMaker:

Collaboration diagram for InDet::CaloClusterROIPhiRZContainerMaker:

Public Member Functions
	CaloClusterROIPhiRZContainerMaker (const std::string &name, ISvcLocator *pSvcLocator)

	~CaloClusterROIPhiRZContainerMaker ()

StatusCode	initialize () override

StatusCode	finalize () override

StatusCode	execute (const EventContext &ctx) const override

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
const Trk::Surface *	getCaloSurface (const xAOD::CaloCluster &cluster, const CaloDetDescrManager &caloDDMgr) const

void	addROI (const xAOD::CaloCluster &cluster, const CaloDetDescrManager &caloDDMgr, ROIPhiRZContainer &output_rois, std::vector< uint_fast8_t > &max_output, std::vector< unsigned int > &n_rois) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Static Private Member Functions
static Trk::LocalParameters	getClusterLocalParameters (const xAOD::CaloCluster &cluster, const Trk::Surface &surf)

Private Attributes
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_inputClusterContainerName {this, "InputClusterContainerName", "egammaTopoCluster", "Input cluster for egamma objects"}
	Name of the cluster intput collection. More...

SG::WriteHandleKeyArray< ROIPhiRZContainer >	m_outputClusterContainerName {this, "OutputROIContainerName", {}, "Output collection of eta ordered ROIs"}
	Name of the ROI output collection. More...

SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey { this,"CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" }
	Name of the CaloDetDescrManager condition object. More...

ToolHandle< ICaloSurfaceBuilder >	m_calosurf { this, "CaloSurfaceBuilder", "CaloSurfaceBuilder", "Tool to build calorimeter layer surfaces"}
	Tool to build calorimeter layer surfaces. More...

ToolHandle< IegammaCaloClusterSelector >	m_egammaCaloClusterSelector {this, "egammaCaloClusterSelector", "egammaCaloClusterSelector","Tool that makes the cluster selection"}
	Tool to filter the calo clusters. More...

Gaudi::Property< bool >	m_EMEnergyOnly {this, "EMEnergyOnly", false, "Only use EM energy as the ROI energy" }

Gaudi::Property< std::vector< float > >	m_phiWidth {this, "phiWidth", {} }

Gaudi::Property< std::vector< float > >	m_minPtEm {this, "minPt", {}, "Minimum pt of cluster ROIs (EMFraction corrected if EMEnerygOnly is set)."}

std::vector< unsigned int >	m_outputIndex

std::vector< unsigned int >	m_outputSorted

std::vector< unsigned int >	m_outputUnsorted

std::vector< float >	m_sortedMinPtEm

float	m_maxPhiWidth = 0.0F

std::atomic_uint	m_allClusters {0}

std::atomic_uint	m_selectedClusters {0}

std::atomic_uint	m_duplicateROI {0}

std::atomic_uint	m_maxNROIs {0}

DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Algorithm to create a eta ordered ROIs in the eta phi plane.

The algorithm creates ROIs ordered by eta in the eta phi plane from selected calorimer clusters.

Definition at line 32 of file CaloClusterROIPhiRZContainerMaker.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CaloClusterROIPhiRZContainerMaker()

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

Definition at line 24 of file CaloClusterROIPhiRZContainerMaker.cxx.

                                                                                                 :
     AthReentrantAlgorithm(name, pSvcLocator)
 {
 }

◆ ~CaloClusterROIPhiRZContainerMaker()

InDet::CaloClusterROIPhiRZContainerMaker::~CaloClusterROIPhiRZContainerMaker ( )

default

Member Function Documentation

◆ addROI()

void InDet::CaloClusterROIPhiRZContainerMaker::addROI	(	const xAOD::CaloCluster &	cluster,
		const CaloDetDescrManager &	caloDDMgr,
		ROIPhiRZContainer &	output_rois,
		std::vector< uint_fast8_t > &	max_output,
		std::vector< unsigned int > &	n_rois
	)		const

private

Definition at line 225 of file CaloClusterROIPhiRZContainerMaker.cxx.

                                                                                         {
  
   double energy = cluster.e();
  
   // do we want to make energy be EM energy only?
   if (m_EMEnergyOnly) {
     static const SG::AuxElement::ConstAccessor<float> acc("EMFraction");
     double emFrac(0.);
     if (acc.isAvailable(cluster)) {
       emFrac = acc(cluster);
     } else if (!cluster.retrieveMoment(xAOD::CaloCluster::ENG_FRAC_EM,
                                         emFrac)) {
       ATH_MSG_ERROR("EM energy requested, but No EM fraction momement stored");
       return;
     }
     energy *= emFrac;
   }
  
   std::unique_ptr<const Trk::Surface> surface( getCaloSurface(cluster, caloDDMgr) );
   if (!surface) {
      ATH_MSG_ERROR( "Failed to create surface for cluster");
      return;
   }
  
   const Trk::LocalParameters localParams( getClusterLocalParameters(cluster, *surface) );
  
   Amg::Vector3D global_position( surface->localToGlobal( localParams) );
   double et = energy * std::sin(global_position.theta());
   if ( et >= m_sortedMinPtEm[0]){
      unsigned int roi_idx=output_rois.size();
      output_rois.addROI(global_position, m_maxPhiWidth);
  
      unsigned int n_duplicates = output_rois.size()-roi_idx-1;
      if (n_duplicates>0) {
         m_duplicateROI += n_duplicates;
      }
  
      unsigned int output_idx=0;
      for ( ; output_idx<m_outputIndex.size(); ++output_idx) {
         if (et < m_sortedMinPtEm[output_idx]) break;
         n_rois[output_idx] += n_duplicates+1;
      }
      // addROI may duplicate the ROI at phi - 2 pi
      // So, have to set the last output_idx for all newly added ROIs
      if (max_output.size() < output_rois.size()) {
        max_output.resize (output_rois.size());
      }
      for (; roi_idx < output_rois.size(); ++roi_idx) {
         max_output[roi_idx]=output_idx;
      }
  
   }
   else {
      ATH_MSG_DEBUG("Skip selected cluster " << energy << " * " << std::sin(global_position.theta()) << " = " << energy * std::sin(global_position.theta())<< " >= " << m_sortedMinPtEm[0] );
   }
 }

◆ cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & 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< Gaudi::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; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::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; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode InDet::CaloClusterROIPhiRZContainerMaker::execute ( const EventContext & ctx ) const

override

Definition at line 99 of file CaloClusterROIPhiRZContainerMaker.cxx.

 {
  
     if (m_inputClusterContainerName.key().empty()) {
         return StatusCode::SUCCESS;
     }
  
     // retrieve cluster containers, return `failure' if not existing
     SG::ReadHandle<xAOD::CaloClusterContainer> inputClusterContainer(m_inputClusterContainerName,ctx);
     ATH_CHECK(inputClusterContainer.isValid());
  
     SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey,ctx};
     ATH_CHECK(caloMgrHandle.isValid());
     const CaloDetDescrManager *caloMgr =  caloMgrHandle.cptr();
  
     unsigned int all_clusters{};
     unsigned int selected_clusters{};
     ROIPhiRZContainer          rois;      // temporary ROI container
     std::vector<unsigned int >   n_rois;   // number of ROIs per output container
     n_rois.resize(m_outputIndex.size(),0);
  
     std::vector<uint8_t >       max_output;// the outputs are ordered by the pt-cut, this is the index of the last output which passed the pt-cut per ROI
     rois.reserve( inputClusterContainer->size());
     max_output.resize(inputClusterContainer->size());
  
     // create ROIs.
     // first they are only stored in the temporary container
     for(const xAOD::CaloCluster* cluster : *inputClusterContainer )
     {
         all_clusters++;
         if (m_egammaCaloClusterSelector->passSelection(cluster,*caloMgr))
         {
             selected_clusters++;
             addROI(*cluster, *caloMgr, rois, max_output, n_rois);
         }
     }
     // This may happen if a ROI close to +-pi gets duplicated...
     //   so don't warn.  See ATLASRECTS-7160.
     //if  (rois.size()  > inputClusterContainer->size() ) {
     //   ATH_MSG_INFO( "Did not reserve enough storage for " << m_outputClusterContainerName[m_outputIndex[0]].key() );
     //}
  
  
     // create ROI output container
     std::vector< SG::WriteHandle<ROIPhiRZContainer> > output_rois;
     output_rois.reserve(m_outputIndex.size());
     for (unsigned int output_idx : m_outputIndex) {
        unsigned int the_size = n_rois[output_rois.size()];
        output_rois.emplace_back( m_outputClusterContainerName[output_idx], ctx);
        ATH_CHECK( output_rois.back().record( std::make_unique<ROIPhiRZContainer>() ) );
        output_rois.back()->reserve( the_size);
     }
  
     if (!m_outputSorted.empty()) {
        // sort ROIs by phi
        std::vector<unsigned int> roi_order;
        roi_order.reserve( rois.size() );
        for (unsigned int idx=0; idx< rois.size(); ++idx) { roi_order.push_back( idx ); }
        std::sort(roi_order.begin(),roi_order.end(),[&rois](unsigned int a, unsigned int b) { return rois[a][0] < rois[b][0]; });
        // copy ROIs in sort order to output container which are to be sorted
        for (unsigned int roi_i : roi_order) {
           for (unsigned int output_i : m_outputSorted) {
              if  (output_i>=max_output[roi_i]) break;
              output_rois[output_i]->push_back( rois[ roi_i ] );
           }
        }
     }
  
     // copy ROIs in original order to output container which should have the original order
     // also remove duplicates
     if (!m_outputUnsorted.empty()) {
        for (unsigned int roi_unordered_i=0;  roi_unordered_i < rois.size(); ++roi_unordered_i) {
           for (unsigned int output_i : m_outputUnsorted) {
              if  (output_i>=max_output[roi_unordered_i]) break;
              if (std::abs(rois[ roi_unordered_i ][0])<PI_F  or (rois[ roi_unordered_i ][0] == PI_F)) {
                 output_rois[output_i]->push_back( rois[ roi_unordered_i ] );
              }
           }
        }
     }
  
     // gather statistics
     {
        unsigned int max_size;
        do {
           max_size = m_maxNROIs;
        } while (rois.size()>max_size && ! m_maxNROIs.compare_exchange_weak(max_size, rois.size()));
     }
     m_allClusters += all_clusters;
     m_selectedClusters += selected_clusters;
     return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 79 of file AthReentrantAlgorithm.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();
 }

◆ filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ finalize()

StatusCode InDet::CaloClusterROIPhiRZContainerMaker::finalize ( )

override

Definition at line 88 of file CaloClusterROIPhiRZContainerMaker.cxx.

 {
     //
     // finalize method
     //
    ATH_MSG_DEBUG ("AllClusters " << m_allClusters << " selected " << m_selectedClusters << " max ROIs per event " << m_maxNROIs);
  
     return StatusCode::SUCCESS;
 }

◆ getCaloSurface()

const Trk::Surface* InDet::CaloClusterROIPhiRZContainerMaker::getCaloSurface	(	const xAOD::CaloCluster &	cluster,
		const CaloDetDescrManager &	caloDDMgr
	)		const

inlineprivate

Definition at line 46 of file CaloClusterROIPhiRZContainerMaker.h.

    {
       // Determine if we want to extrapolate to the barrel or endcap.  If in the
       // crack choose the detector with largest amount of energy in the second
       // sampling layer
       if (xAOD::EgammaHelpers::isBarrel(&cluster)) {
          return m_calosurf->CreateUserSurface(CaloCell_ID::EMB2, 0., cluster.eta(), &caloDDMgr);
       } else {
          return m_calosurf->CreateUserSurface(CaloCell_ID::EME2, 0., cluster.eta(), &caloDDMgr);
       }
    }

◆ getClusterLocalParameters()

Trk::LocalParameters InDet::CaloClusterROIPhiRZContainerMaker::getClusterLocalParameters	(	const xAOD::CaloCluster &	cluster,
		const Trk::Surface &	surf
	)

staticprivate

Definition at line 192 of file CaloClusterROIPhiRZContainerMaker.cxx.

 {
  
   Amg::Vector3D surfRefPoint = surf.globalReferencePoint();
  
   double eta = cluster.eta();
   double theta = 2 * atan(exp(-eta)); //  -log(tan(theta/2));
   double tantheta = tan(theta);
   double phi = cluster.phi();
  
   if (xAOD::EgammaHelpers::isBarrel(&cluster)) {
     // Two corindate in a cyclinder are
     // Trk::locRPhi = 0 (ie phi)
     // Trk::locZ    = 1(ie z)
     double r = surfRefPoint.perp();
     double z = tantheta == 0 ? 0. : r / tantheta;
     Trk::DefinedParameter locRPhi(r * phi, Trk::locRPhi);
     Trk::DefinedParameter locZ(z, Trk::locZ);
     return Trk::LocalParameters(locRPhi, locZ);
   } else {
     // Local paramters of a disk are
     // Trk::locR   = 0
     // Trk::locPhi = 1
     double z = surfRefPoint.z();
     double r = z * tantheta;
     Trk::DefinedParameter locR(r, Trk::locR);
     Trk::DefinedParameter locPhi(phi, Trk::locPhi);
     return Trk::LocalParameters(locR, locPhi);
   }
 }

◆ initialize()

StatusCode InDet::CaloClusterROIPhiRZContainerMaker::initialize ( )

override

Definition at line 35 of file CaloClusterROIPhiRZContainerMaker.cxx.

 {
     ATH_CHECK( m_egammaCaloClusterSelector.retrieve() );
     ATH_CHECK( m_calosurf.retrieve() );
     ATH_CHECK( m_caloMgrKey.initialize() );
  
     if (m_outputClusterContainerName.empty()) {
        ATH_MSG_FATAL( "No OutputROIContainerName given.");
        return StatusCode::FAILURE;
     }
     if (m_outputClusterContainerName.size() > std::numeric_limits<uint8_t>::max()) {
        ATH_MSG_FATAL( "Too many OutputROIContainerNames given.");
        return StatusCode::FAILURE;
     }
     if (m_minPtEm.size() != m_phiWidth.size() || m_minPtEm.size() != m_outputClusterContainerName.size() ) {
        ATH_MSG_FATAL( "Number of entries in minPt, phiWidth must match number of entries in OutputROIContainerName.");
        return StatusCode::FAILURE;
     }
     m_outputIndex.reserve(m_minPtEm.size());
     m_maxPhiWidth=m_phiWidth[0];
     for (unsigned int idx=0; idx<m_minPtEm.size(); ++idx) {
        m_outputIndex.push_back(idx);
        m_maxPhiWidth=std::max(m_maxPhiWidth,m_phiWidth[idx]);
     }
     std::sort(m_outputIndex.begin(),m_outputIndex.end(), [this](unsigned int idx_a, unsigned int idx_b) { return this->m_minPtEm[idx_a] < this->m_minPtEm[idx_b];});
     m_sortedMinPtEm.reserve( m_outputIndex.size());
     for (unsigned int idx : m_outputIndex) {
        m_sortedMinPtEm.push_back( m_minPtEm[idx] );
     }
  
     m_allClusters=0;
     m_selectedClusters=0;
  
     ATH_CHECK(m_outputClusterContainerName.initialize());
     ATH_CHECK(m_inputClusterContainerName.initialize(!m_inputClusterContainerName.key().empty()));
     m_outputSorted.reserve( m_outputIndex.size() );
     m_outputUnsorted.reserve( m_outputIndex.size() );
     for (unsigned int output_i=0; output_i<m_outputIndex.size(); ++output_i) {
        if (m_phiWidth[m_outputIndex[output_i]]>0.) {
           m_outputSorted.push_back(output_i);
        }
        else {
           m_outputUnsorted.push_back(output_i);
        }
        ATH_MSG_DEBUG( "ROIPhiRZ container " << m_outputClusterContainerName[  m_outputIndex[output_i] ]
                      << " : " << m_minPtEm[m_outputIndex[output_i] ] << " MeV " <<  ( m_phiWidth[m_outputIndex[output_i]]>0. ? " order by phi " : " unordered" ) );
     }
     return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::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.

◆ isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, InDet::SiSPGNNTrackMaker, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

 {
   return Gaudi::Algorithm::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::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< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                 {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::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< Gaudi::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< Gaudi::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_allClusters

std::atomic_uint InDet::CaloClusterROIPhiRZContainerMaker::m_allClusters {0}

mutableprivate

Definition at line 105 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> InDet::CaloClusterROIPhiRZContainerMaker::m_caloMgrKey { this,"CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" }

private

Name of the CaloDetDescrManager condition object.

Definition at line 79 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_calosurf

ToolHandle<ICaloSurfaceBuilder> InDet::CaloClusterROIPhiRZContainerMaker::m_calosurf { this, "CaloSurfaceBuilder", "CaloSurfaceBuilder", "Tool to build calorimeter layer surfaces"}

private

Tool to build calorimeter layer surfaces.

Definition at line 83 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_duplicateROI

std::atomic_uint InDet::CaloClusterROIPhiRZContainerMaker::m_duplicateROI {0}

mutableprivate

Definition at line 107 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_egammaCaloClusterSelector

ToolHandle<IegammaCaloClusterSelector> InDet::CaloClusterROIPhiRZContainerMaker::m_egammaCaloClusterSelector {this, "egammaCaloClusterSelector", "egammaCaloClusterSelector","Tool that makes the cluster selection"}

private

Tool to filter the calo clusters.

Definition at line 87 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_EMEnergyOnly

Gaudi::Property< bool > InDet::CaloClusterROIPhiRZContainerMaker::m_EMEnergyOnly {this, "EMEnergyOnly", false, "Only use EM energy as the ROI energy" }

private

Definition at line 90 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_inputClusterContainerName

SG::ReadHandleKey<xAOD::CaloClusterContainer> InDet::CaloClusterROIPhiRZContainerMaker::m_inputClusterContainerName {this, "InputClusterContainerName", "egammaTopoCluster", "Input cluster for egamma objects"}

private

Name of the cluster intput collection.

Definition at line 69 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_maxNROIs

std::atomic_uint InDet::CaloClusterROIPhiRZContainerMaker::m_maxNROIs {0}

mutableprivate

Definition at line 108 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_maxPhiWidth

float InDet::CaloClusterROIPhiRZContainerMaker::m_maxPhiWidth = 0.0F

private

Definition at line 103 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_minPtEm

Gaudi::Property< std::vector<float> > InDet::CaloClusterROIPhiRZContainerMaker::m_minPtEm {this, "minPt", {}, "Minimum pt of cluster ROIs (EMFraction corrected if EMEnerygOnly is set)."}

private

Definition at line 96 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_outputClusterContainerName

SG::WriteHandleKeyArray<ROIPhiRZContainer> InDet::CaloClusterROIPhiRZContainerMaker::m_outputClusterContainerName {this, "OutputROIContainerName", {}, "Output collection of eta ordered ROIs"}

private

Name of the ROI output collection.

Definition at line 73 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_outputIndex

std::vector<unsigned int> InDet::CaloClusterROIPhiRZContainerMaker::m_outputIndex

private

Definition at line 99 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_outputSorted

std::vector<unsigned int> InDet::CaloClusterROIPhiRZContainerMaker::m_outputSorted

private

Definition at line 100 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_outputUnsorted

std::vector<unsigned int> InDet::CaloClusterROIPhiRZContainerMaker::m_outputUnsorted

private

Definition at line 101 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_phiWidth

Gaudi::Property< std::vector<float> > InDet::CaloClusterROIPhiRZContainerMaker::m_phiWidth {this, "phiWidth", {} }

private

Definition at line 93 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_selectedClusters

std::atomic_uint InDet::CaloClusterROIPhiRZContainerMaker::m_selectedClusters {0}

mutableprivate

Definition at line 106 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_sortedMinPtEm

std::vector<float> InDet::CaloClusterROIPhiRZContainerMaker::m_sortedMinPtEm

private

Definition at line 102 of file CaloClusterROIPhiRZContainerMaker.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

◆ CaloClusterROIPhiRZContainerMaker()

◆ ~CaloClusterROIPhiRZContainerMaker()

Member Function Documentation

◆ addROI()

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ getCaloSurface()

◆ getClusterLocalParameters()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_allClusters

◆ m_caloMgrKey

◆ m_calosurf

◆ m_detStore

◆ m_duplicateROI

◆ m_egammaCaloClusterSelector

◆ m_EMEnergyOnly

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputClusterContainerName

◆ m_maxNROIs

◆ m_maxPhiWidth

◆ m_minPtEm

◆ m_outputClusterContainerName

◆ m_outputIndex

◆ m_outputSorted

◆ m_outputUnsorted

◆ m_phiWidth

◆ m_selectedClusters

◆ m_sortedMinPtEm

◆ m_varHandleArraysDeclared

◆ m_vhka