PseudoJetAlgorithm retrieves and builds the pseudojet inputs used in jet finding. More...

#include <PseudoJetAlgorithm.h>

Inheritance diagram for PseudoJetAlgorithm:

Collaboration diagram for PseudoJetAlgorithm:

Public Member Functions
	PseudoJetAlgorithm (const std::string &n, ISvcLocator *l)

virtual StatusCode	initialize () override final
	Athena algorithm's Hooks. More...

virtual StatusCode	execute (const EventContext &ctx) const override final

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
virtual ::StatusCode	finalize ()
	finalize this algorithm More...

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
virtual std::unique_ptr< PseudoJetContainer >	createPJContainer (const xAOD::IParticleContainer &cont, const EventContext &ctx) const
	Method to construct the PseudoJetContainer and record in StoreGate. More...

virtual void	print () const
	Dump to properties to the log. More...

std::vector< fastjet::PseudoJet >	createPseudoJets (const xAOD::IParticleContainer &) const

std::vector< fastjet::PseudoJet >	createPseudoJets (const xAOD::IParticleContainer &, const xAOD::VertexContainer *vertices) 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...

Private Attributes
SG::ReadHandleKey< xAOD::IParticleContainer >	m_incoll {this, "InputContainer", "", "The input IParticleContainer name"}
	Input collection name. More...

SG::WriteHandleKey< PseudoJetContainer >	m_outcoll {this, "OutputContainer", "", "The output PseudoJetContainer name"}
	Output collection name. More...

Gaudi::Property< std::string >	m_label {this, "Label", "", "String label identifying the pseudojet type"}
	Label for the collection. More...

Gaudi::Property< bool >	m_skipNegativeEnergy {this, "SkipNegativeEnergy", false, "Whether to skip negative energy inputs"}
	Flag indicating to skip objects with E<0. More...

Gaudi::Property< bool >	m_negEnergyAsGhosts {this, "TreatNegativeEnergyAsGhost", false, "Whether to convert negative energy inputs into ghosts"}
	Flag indicating to treat objects with E<0 as ghosts (useful for HI) More...

Gaudi::Property< bool >	m_useCharged {this, "UseCharged", true, "Whether to use charged PFOs/FEs"}
	Flag to define if charged PFOs / FEs should be considered. More...

Gaudi::Property< bool >	m_useNeutral {this, "UseNeutral", true, "Whether to use neutral PFOs/FEs"}
	Flag to define if neutral PFOs / FEs should be considered. More...

Gaudi::Property< bool >	m_useChargedPV {this, "UseChargedPV", true, "Whether to use charged PFOs/FEs matched to the PV"}
	Flag to define if charged PFOs / FEs should be matched to PV. More...

Gaudi::Property< bool >	m_useChargedPUsideband {this, "UseChargedPUsideband", false, "Whether to use charged PU sideband only"}
	Flag for PFlow sideband definition. More...

Gaudi::Property< bool >	m_byVertex {this, "DoByVertex", false, "True if jets should be reconstructed by vertex"}
	Flag for by-vertex jet reconstruction. More...

SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "Vertex container (for by-vertex reconstruction)"}

bool	m_isGhost {false}
	Internal steering flags Set in initialize() More...

bool	m_emtopo {false}
	Determines whether the PJs should be made ghosts. More...

bool	m_pflow {false}
	True if inputs are EM-scale topo clusters. More...

bool	m_ufo {false}
	True if inputs are PFlow. More...

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

PseudoJetAlgorithm retrieves and builds the pseudojet inputs used in jet finding.

Alg Properties:

InputCollection: Name of the input collection.
OutputCollection: Name of the output collection of pseudojets.
Label: Label for the constituents. See note below.
SkipNegativeEnergy: Flag indicating that inputs with negative energy should be ignored.
GhostScale : If nonzero, the pseudojets are labeled as ghosts and their four-momenta are scaled by this factor.

Note: The label is attached to the CUI (constituent user info) associated with created pseudojet and is used to name jet moments that point to the PJs, and in rare cases (EMTopo, PFlow) to toggle special treatments.

Definition at line 37 of file PseudoJetAlgorithm.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

◆ PseudoJetAlgorithm()

PseudoJetAlgorithm::PseudoJetAlgorithm	(	const std::string &	n,
		ISvcLocator *	l
	)

inline

Definition at line 42 of file PseudoJetAlgorithm.h.

42 : EL::AnaReentrantAlgorithm(n,l) {}

Member Function Documentation

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

◆ createPJContainer()

std::unique_ptr< PseudoJetContainer > PseudoJetAlgorithm::createPJContainer	(	const xAOD::IParticleContainer &	cont,
		const EventContext &	ctx
	)		const

privatevirtual

Method to construct the PseudoJetContainer and record in StoreGate.

Definition at line 75 of file PseudoJetAlgorithm.cxx.

                                                                                                                                          {
   // create PseudoJets
   std::vector<fastjet::PseudoJet> vpj;
  
   #ifndef GENERATIONBASE
   if (m_byVertex){
     auto pvs = SG::makeHandle(m_vertexContainer_key, ctx);
     vpj = createPseudoJets(cont, pvs.cptr());
   }
   else{
     vpj = createPseudoJets(cont);
   }
   #else
   [[maybe_unused]] const EventContext& unused_ctx = ctx;
   vpj = createPseudoJets(cont);
   #endif
  
   // create an extractor to attach to the PJContainer -- this will be used by clients
   auto extractor = std::make_unique<IParticleExtractor>(&cont, m_label, m_isGhost);
   ATH_MSG_DEBUG("Created extractor: "  << extractor->toString(0));
   
   // ghostify the pseudojets if necessary
   if(m_isGhost){
     for(fastjet::PseudoJet& pj : vpj) {pj *= ghostscale;}
   }
   
   // Put the PseudoJetContainer together
   auto pjcont = std::make_unique<PseudoJetContainer>(std::move(extractor), vpj);
   ATH_MSG_DEBUG("New PseudoJetContainer size " << pjcont->size());
  
   return pjcont;
 }

◆ createPseudoJets() [1/2]

std::vector< fastjet::PseudoJet > PseudoJetAlgorithm::createPseudoJets ( const xAOD::IParticleContainer & ips ) const

private

Definition at line 110 of file PseudoJetAlgorithm.cxx.

                                                                            {
 #ifndef GENERATIONBASE
   if (m_pflow || m_ufo) {return PseudoJetGetter::PFlowsToPJs(ips,m_skipNegativeEnergy.value(),m_useCharged.value(),m_useNeutral.value(),m_useChargedPV.value(),m_useChargedPUsideband.value(),m_ufo);}
   if (m_emtopo) {return PseudoJetGetter::EMToposToPJs(ips,m_skipNegativeEnergy.value());}
 #endif
   return PseudoJetGetter::IParticlesToPJs(ips,m_skipNegativeEnergy.value());
 }

◆ createPseudoJets() [2/2]

std::vector< fastjet::PseudoJet > PseudoJetAlgorithm::createPseudoJets	(	const xAOD::IParticleContainer &	ips,
		const xAOD::VertexContainer *	vertices
	)		const

private

Definition at line 120 of file PseudoJetAlgorithm.cxx.

                                                                                                            {
   return PseudoJetGetter::ByVertexPFlowsToPJs(ips, pvs, m_skipNegativeEnergy.value(),m_useCharged.value(),m_useNeutral.value(),m_ufo);
 }

◆ 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 PseudoJetAlgorithm::execute ( const EventContext & ctx ) const

finaloverridevirtual

Definition at line 50 of file PseudoJetAlgorithm.cxx.

                                                                     {
   ATH_MSG_VERBOSE("Executing " << name() << "...");
  
   // build and record the container
   auto incoll = SG::makeHandle(m_incoll, ctx);
   if( !incoll.isValid() ) {
     // Return SUCCESS to avoid crashing T0 jobs
     ATH_MSG_WARNING("Failed to retrieve " << m_incoll.key() << " for PseudoJet creation!" );
     return StatusCode::SUCCESS;
   }
   ATH_MSG_DEBUG("Retrieved xAOD container " << m_incoll.key() << " of size " << incoll->size()
         <<  ", isGhost=" << m_isGhost);
  
   ATH_MSG_DEBUG("Creating PseudoJetContainer...");
   std::unique_ptr<PseudoJetContainer> pjcont( createPJContainer(*incoll, ctx) );
  
   auto outcoll = SG::makeHandle(m_outcoll, ctx);
   ATH_MSG_DEBUG("Created new PseudoJetContainer \"" << m_outcoll.key() << "\" with size " << pjcont->size());
  
   ATH_CHECK( outcoll.record(std::move(pjcont)) );
  
   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 EL::AnaReentrantAlgorithm::finalize ( )

protectedinherited

finalize this algorithm

This gets called after event processing has finished. The last event may no longer be in memory, and the code should not try to access it.

Definition at line 102 of file AnaReentrantAlgorithm.cxx.

   {
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode PseudoJetAlgorithm::initialize ( )

finaloverridevirtual

Athena algorithm's Hooks.

Definition at line 18 of file PseudoJetAlgorithm.cxx.

                                           {
   ATH_MSG_INFO("Initializing " << name() << "...");
  
   // This is horrible, but still necessary for the time being
   // PJG needs to know if this is the basic EMTopo cluster collection
   // in order to change the cluster signal state.
   if ( m_label == "EMTopo") m_emtopo = true;
   // PFlow containers need to have PV matching applied
   if ( std::string(m_label).find("PFlow") != std::string::npos) m_pflow = true;
   if ( std::string(m_label).find("UFO") != std::string::npos) m_ufo = true;
  
   // "Ghost" in output collection name? If so is a ghost collection.
   m_isGhost = (m_outcoll.key()).find("Ghost") != std::string::npos;
  
   print();
  
   if(m_incoll.key().empty() || m_outcoll.key().empty()) {
     ATH_MSG_ERROR("Either input or output collection is empty!");
     return StatusCode::FAILURE;
   }
  
   ATH_CHECK( m_incoll.initialize() );
   ATH_CHECK( m_outcoll.initialize() );
  
   ATH_CHECK( m_vertexContainer_key.initialize(m_byVertex) );
  
   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.

◆ print()

void PseudoJetAlgorithm::print ( ) const

privatevirtual

Dump to properties to the log.

Definition at line 127 of file PseudoJetAlgorithm.cxx.

                                      {
   std::string sskip = m_skipNegativeEnergy ? "true" : "false";
   // May want to change to DEBUG
   ATH_MSG_INFO("Properties for PseudoJetGetter " << name());
   ATH_MSG_INFO("             Label: " << m_label);
   ATH_MSG_INFO("   Input container: " << m_incoll.key());
   ATH_MSG_INFO("  Output container: " << m_outcoll.key());
   ATH_MSG_INFO("   Skip negative E: " << sskip);
   ATH_MSG_INFO("         Is EMTopo: " << m_emtopo);
   ATH_MSG_INFO("          Is PFlow: " << m_pflow);
   ATH_MSG_INFO("            Is UFO: " << m_ufo);
   ATH_MSG_INFO("          Is ghost: " << m_isGhost);
   ATH_MSG_INFO(" Treat negative E as ghost: " << m_negEnergyAsGhosts.value());
   ATH_MSG_INFO(" Running by-vertex reco: " << m_byVertex.value());
   ATH_MSG_INFO(" Vertex input container: " << m_vertexContainer_key.key());
  
   if(m_pflow){
     ATH_MSG_INFO("   Use charged FEs: " << m_useCharged.value());
     ATH_MSG_INFO("   Use neutral FEs: " << m_useNeutral.value());
     ATH_MSG_INFO("Use charged PV FEs: " << m_useChargedPV.value());
     ATH_MSG_INFO("   PU sideband def: " << m_useChargedPUsideband.value());
   }
   if(m_ufo){
     ATH_MSG_INFO("   Use charged UFOs: " << m_useCharged.value());
     ATH_MSG_INFO("   Use neutral UFOs: " << m_useNeutral.value());
   }
 }

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

Gaudi::Property<bool> PseudoJetAlgorithm::m_byVertex {this, "DoByVertex", false, "True if jets should be reconstructed by vertex"}

private

Flag for by-vertex jet reconstruction.

Definition at line 94 of file PseudoJetAlgorithm.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_emtopo

bool PseudoJetAlgorithm::m_emtopo {false}

private

Determines whether the PJs should be made ghosts.

Definition at line 101 of file PseudoJetAlgorithm.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_incoll

SG::ReadHandleKey<xAOD::IParticleContainer> PseudoJetAlgorithm::m_incoll {this, "InputContainer", "", "The input IParticleContainer name"}

private

Input collection name.

Definition at line 67 of file PseudoJetAlgorithm.h.

◆ m_isGhost

bool PseudoJetAlgorithm::m_isGhost {false}

private

Internal steering flags Set in initialize()

Definition at line 100 of file PseudoJetAlgorithm.h.

◆ m_label

Gaudi::Property<std::string> PseudoJetAlgorithm::m_label {this, "Label", "", "String label identifying the pseudojet type"}

private

Label for the collection.

Definition at line 73 of file PseudoJetAlgorithm.h.

◆ m_negEnergyAsGhosts

Gaudi::Property<bool> PseudoJetAlgorithm::m_negEnergyAsGhosts {this, "TreatNegativeEnergyAsGhost", false, "Whether to convert negative energy inputs into ghosts"}

private

Flag indicating to treat objects with E<0 as ghosts (useful for HI)

Definition at line 79 of file PseudoJetAlgorithm.h.

◆ m_outcoll

SG::WriteHandleKey<PseudoJetContainer> PseudoJetAlgorithm::m_outcoll {this, "OutputContainer", "", "The output PseudoJetContainer name"}

private

Output collection name.

Definition at line 70 of file PseudoJetAlgorithm.h.

◆ m_pflow

bool PseudoJetAlgorithm::m_pflow {false}

private

True if inputs are EM-scale topo clusters.

Definition at line 102 of file PseudoJetAlgorithm.h.

◆ m_skipNegativeEnergy

Gaudi::Property<bool> PseudoJetAlgorithm::m_skipNegativeEnergy {this, "SkipNegativeEnergy", false, "Whether to skip negative energy inputs"}

private

Flag indicating to skip objects with E<0.

Definition at line 76 of file PseudoJetAlgorithm.h.

◆ m_ufo

bool PseudoJetAlgorithm::m_ufo {false}

private

True if inputs are PFlow.

Definition at line 103 of file PseudoJetAlgorithm.h.

◆ m_useCharged

Gaudi::Property<bool> PseudoJetAlgorithm::m_useCharged {this, "UseCharged", true, "Whether to use charged PFOs/FEs"}

private

Flag to define if charged PFOs / FEs should be considered.

Definition at line 82 of file PseudoJetAlgorithm.h.

◆ m_useChargedPUsideband

Gaudi::Property<bool> PseudoJetAlgorithm::m_useChargedPUsideband {this, "UseChargedPUsideband", false, "Whether to use charged PU sideband only"}

private

Flag for PFlow sideband definition.

Definition at line 91 of file PseudoJetAlgorithm.h.

◆ m_useChargedPV

Gaudi::Property<bool> PseudoJetAlgorithm::m_useChargedPV {this, "UseChargedPV", true, "Whether to use charged PFOs/FEs matched to the PV"}

private

Flag to define if charged PFOs / FEs should be matched to PV.

Definition at line 88 of file PseudoJetAlgorithm.h.

◆ m_useNeutral

Gaudi::Property<bool> PseudoJetAlgorithm::m_useNeutral {this, "UseNeutral", true, "Whether to use neutral PFOs/FEs"}

private

Flag to define if neutral PFOs / FEs should be considered.

Definition at line 85 of file PseudoJetAlgorithm.h.

◆ m_varHandleArraysDeclared

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

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> PseudoJetAlgorithm::m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "Vertex container (for by-vertex reconstruction)"}

private

Definition at line 96 of file PseudoJetAlgorithm.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

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PseudoJetAlgorithm()

Member Function Documentation

◆ cardinality()

◆ createPJContainer()

◆ createPseudoJets() [1/2]

◆ createPseudoJets() [2/2]

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

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_byVertex

◆ m_detStore

◆ m_emtopo

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_incoll

◆ m_isGhost

◆ m_label

◆ m_negEnergyAsGhosts

◆ m_outcoll

◆ m_pflow

◆ m_skipNegativeEnergy

◆ m_ufo

◆ m_useCharged

◆ m_useChargedPUsideband

◆ m_useChargedPV

◆ m_useNeutral

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka