#include <JetCaloQualityToolFE.h>

Inheritance diagram for JetCaloQualityToolFE:

Collaboration diagram for JetCaloQualityToolFE:

Public Member Functions
	JetCaloQualityToolFE (const std::string &name)

virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it. More...

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual void	print () const
	Print the state of the tool. More...

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	sysInitialize () override
	Perform system initialization for an algorithm. 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

virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier. More...

Protected Member Functions
void	fillQualityVariables (const xAOD::Jet &jet) const

std::vector< const xAOD::CaloCluster * >	extractConstituents (const xAOD::Jet &jet) const

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

Protected Attributes
Gaudi::Property< std::vector< std::string > >	m_calculationNames

Gaudi::Property< std::vector< double > >	m_timingTimeCuts

Gaudi::Property< std::vector< int > >	m_thresholdCuts

Gaudi::Property< std::string >	m_jetContainerName

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_writeDecorKeys

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_writeDecorKeys_OOT

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_writeDecorKeys_Nfrac

bool	m_doLArQ = false

bool	m_doHECQ = false

bool	m_doNegE = false

bool	m_doAvgLAr = false

bool	m_doCentroid = false

bool	m_doBchCorrCell = false

bool	m_doTime = false

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
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

Definition at line 21 of file JetCaloQualityToolFE.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

◆ JetCaloQualityToolFE()

JetCaloQualityToolFE::JetCaloQualityToolFE ( const std::string & name )

Definition at line 17 of file JetCaloQualityToolFE.cxx.

   : asg::AsgTool(name)
 {
 } 

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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());
   }

◆ decorate()

StatusCode JetCaloQualityToolFE::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 93 of file JetCaloQualityToolFE.cxx.

 {
  
   ATH_MSG_VERBOSE("Begin decorating jets.");
  
   for(const xAOD::Jet* jet : jets) {
     fillQualityVariables(*jet);
   }
  
   return StatusCode::SUCCESS;
 }

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

95 { return m_detStore; }

◆ evtStore() [1/2]

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.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

◆ extractConstituents()

std::vector< const xAOD::CaloCluster * > JetCaloQualityToolFE::extractConstituents ( const xAOD::Jet & jet ) const

protected

Definition at line 105 of file JetCaloQualityToolFE.cxx.

                                                                                                    {
  
   std::vector<const xAOD::CaloCluster*> clusters;
  
   // Get the input type:
   xAOD::Type::ObjectType ctype = jet.rawConstituent(0)->type();
  
   if ( ctype  == xAOD::Type::CaloCluster ) {
     ATH_MSG_VERBOSE("  Constituents are calo clusters.");
     for ( size_t i = 0; i < jet.numConstituents(); i++ ) { 
       const xAOD::CaloCluster* constit = static_cast<const xAOD::CaloCluster*>(jet.rawConstituent(i)); 
       clusters.push_back(constit);
     }
   }
   else if( ctype  == xAOD::Type::FlowElement ){
  
     ATH_MSG_VERBOSE("  Constituents are FlowElements.");
  
     //Need to distinguish between ParticleFlow and UFOs
     const xAOD::FlowElement* constit0 = static_cast<const xAOD::FlowElement*>(jet.rawConstituent(0));
  
     // If jet constituents are ParticleFlow objects (stored as FlowElements)
     if(constit0->signalType() & xAOD::FlowElement::PFlow){
       ATH_MSG_VERBOSE("  Constituents are ParticleFlow objects stored as FlowElements.");
       for ( size_t i = 0; i < jet.numConstituents(); i++ ) {
     const xAOD::FlowElement* constit = static_cast<const xAOD::FlowElement*>(jet.rawConstituent(i));
     // Use only neutral PFOs
     if(constit->isCharged())
       continue;
  
     if(constit->nOtherObjects() >= 1){
       const xAOD::CaloCluster* cluster = dynamic_cast<const xAOD::CaloCluster*>(constit->otherObject(0));
       if(cluster != nullptr){
         clusters.push_back(cluster);
       }
     }
       }
     }   
     else{ // jet constituents are UFOs (stored as FlowElements)
       ATH_MSG_VERBOSE("  Constituents are UFOs stored as FlowElements.");
  
       for ( size_t i = 0; i < jet.numConstituents(); i++ ) {
     const xAOD::FlowElement* constit = static_cast<const xAOD::FlowElement*>(jet.rawConstituent(i));
  
     //Reject charged UFOs (but keep combined UFOs)
     if(constit->signalType()==xAOD::FlowElement::SignalType::Charged)
       continue;
  
     // For UFOs, otherObjects are links to the underlying ParticleFlow objects
     for (size_t n = 0; n < constit->otherObjects().size(); ++n) {
       if(! constit->otherObject(n)) continue;
       int index_pfo = constit->otherObject(n)->index();
       if(index_pfo<0) continue;
  
       const auto* fe = (constit->otherObject(n));
       const xAOD::CaloCluster* cluster = nullptr;
       
       if(fe->type() == xAOD::Type::FlowElement){
         const xAOD::FlowElement* pfo = dynamic_cast<const xAOD::FlowElement*>(fe);
         if(!pfo->otherObjects().empty() && pfo->otherObject(0) && pfo->otherObject(0)->type() == xAOD::Type::CaloCluster){
           cluster = dynamic_cast<const xAOD::CaloCluster*> (pfo->otherObject(0));
         }
       }
       if(!cluster){continue;}
  
       if(std::find(clusters.begin(), clusters.end(), cluster) == clusters.end()){
         clusters.push_back(cluster);
       }
     }
       }
     }
   }
  
   return clusters;
  
 }

◆ 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

◆ fillQualityVariables()

void JetCaloQualityToolFE::fillQualityVariables ( const xAOD::Jet & jet ) const

protected

Definition at line 182 of file JetCaloQualityToolFE.cxx.

                                                                        {
  
   // First, extract the constituents directly (in case of cluster-based jet) or underlying clusters
   std::vector<const xAOD::CaloCluster*> clusters = extractConstituents(jet);
  
   // Calculate moments   
   float sum_E = 0.0;
   float sum_E_square = 0.0;
  
   float sum_badLarQ = 0.0;
   float sum_badHECQ = 0.0;
   float sum_e_HEC = 0.0;
   float sum_e_neg = 0.0;
   float sum_avg_lar_q = 0.0;
   float sum_timing = 0.0;
   float centroid_x = 0.0, centroid_y = 0.0, centroid_z = 0.0;
   float sum_e_bad_cells = 0.0;
  
   std::vector<float> sum_OOT;
   sum_OOT.resize(m_timingTimeCuts.size());
  
   std::vector<int> counter_Nfrac;
   counter_Nfrac.resize(m_thresholdCuts.size());
  
   std::vector<float> cluster_energies;
  
   for ( size_t i = 0; i < clusters.size(); i++){
  
     const xAOD::CaloCluster* constit = static_cast<const xAOD::CaloCluster*>(clusters[i]);
  
     float cluster_E = constit->e(xAOD::CaloCluster::UNCALIBRATED);
  
     sum_E += cluster_E;
     sum_E_square += cluster_E*cluster_E;
  
     cluster_energies.push_back(cluster_E);
  
     //LArQuality || HECQuality
     double bad_frac=0.0;
     if(m_doLArQ || m_doHECQ){
       constit->retrieveMoment(xAOD::CaloCluster::BADLARQ_FRAC, bad_frac);
       
       if(m_doLArQ){
      sum_badLarQ += bad_frac*cluster_E;
       }
  
       if(m_doHECQ){
     float e_HEC = constit->eSample( CaloSampling::HEC0) + constit->eSample( CaloSampling::HEC1) + constit->eSample( CaloSampling::HEC2) + constit->eSample( CaloSampling::HEC3);
     sum_e_HEC += e_HEC;
     sum_badHECQ += bad_frac*e_HEC;
       }
     }
  
     //NegativeE
     if(m_doNegE){
       double e_pos=0.0;
       constit->retrieveMoment(xAOD::CaloCluster::ENG_POS, e_pos);
       sum_e_neg += cluster_E - e_pos;
     }
  
     //JetCalcAverageLArQualityF
     if(m_doAvgLAr){
       double avg_lar_q=0.0;
       constit->retrieveMoment(xAOD::CaloCluster::AVG_LAR_Q, avg_lar_q);
       sum_avg_lar_q += avg_lar_q*cluster_E*cluster_E;
     }
  
     //Centroid
     if(m_doCentroid){
       double x = 0.0, y = 0.0, z = 0.0;
       constit->retrieveMoment(xAOD::CaloCluster::CENTER_X, x);
       constit->retrieveMoment(xAOD::CaloCluster::CENTER_Y, y);
       constit->retrieveMoment(xAOD::CaloCluster::CENTER_Z, z);
  
       centroid_x += x*cluster_E;
       centroid_y += y*cluster_E;
       centroid_z += z*cluster_E;
     }
  
     //BchCorrCell
     if(m_doBchCorrCell){
       double cells_bad_E = 0.0;
       constit->retrieveMoment(xAOD::CaloCluster::ENG_BAD_CELLS, cells_bad_E);
       sum_e_bad_cells += cells_bad_E;
     }
  
     //Timing / OOT
     if(m_doTime || m_timingTimeCuts.size() > 0){
       double timing = constit->time();
       
       if(m_doTime){
     sum_timing += timing*cluster_E*cluster_E;
       }
  
       //OOT
       for(size_t j = 0; j < m_timingTimeCuts.size(); j++){
     if(std::abs(timing) > m_timingTimeCuts[j]){
       sum_OOT[j] += cluster_E;
     }
       }
     }
   } // end loop over all all constituents
  
  
   if(m_thresholdCuts.size() > 0){
  
     std::sort(cluster_energies.rbegin(),cluster_energies.rend());
  
     for(size_t iFracCut = 0; iFracCut < m_thresholdCuts.size(); iFracCut++){
  
       int counter = 0;
       float tmp_sum = 0;
  
       for(unsigned int iClus = 0; iClus < cluster_energies.size(); iClus++){
     tmp_sum += cluster_energies[iClus];
     counter++;
     if(tmp_sum > m_thresholdCuts[iFracCut]*sum_E/100.) break;
       }
       counter_Nfrac[iFracCut] = counter;
     }
   }
   
   //Add the decorations
   for(size_t i = 0; i < m_calculationNames.size(); i++){
     std::string calcN = m_calculationNames[i];
  
     SG::WriteDecorHandle<xAOD::JetContainer, float> decHandle(m_writeDecorKeys.at(i));
  
     if(calcN == "LArQuality"){
       decHandle(jet) = sum_E != 0. ? sum_badLarQ/sum_E : 0.;
     }
     else if(calcN == "HECQuality"){
       decHandle(jet) = sum_e_HEC != 0. ? sum_badHECQ/sum_e_HEC : 0.;
     }
     else if(calcN == "NegativeE"){
       decHandle(jet) = sum_e_neg;
     }
     else if(calcN == "AverageLArQF"){
       decHandle(jet) = sum_E_square != 0. ? sum_avg_lar_q/sum_E_square : 0.;
     }
     else if(calcN == "Timing"){
       decHandle(jet) = sum_E_square != 0. ? sum_timing/sum_E_square : 0.;
     }
     else if(calcN == "Centroid"){
       decHandle(jet) = sum_E_square != 0. ? sqrt(centroid_x*centroid_x+centroid_y*centroid_y+centroid_z*centroid_z)/sum_E_square : 0.;
     }
     else if(calcN == "BchCorrCell"){
       decHandle(jet) = jet.jetP4(xAOD::JetEMScaleMomentum).E() != 0. ? sum_e_bad_cells/jet.jetP4(xAOD::JetEMScaleMomentum).E() : 0.   ;
     }
   }
  
   for( size_t iCut = 0; iCut < m_timingTimeCuts.size(); iCut++){
     SG::WriteDecorHandle<xAOD::JetContainer, float> decHandle_timing(m_writeDecorKeys_OOT.at(iCut));
     decHandle_timing(jet) = sum_E != 0. ? sum_OOT[iCut]/sum_E : 0. ;
   }
  
   for( size_t iFracCut = 0; iFracCut < m_thresholdCuts.size(); iFracCut++){
     //Variable was previously stored as float rather than int
     //Keep float to not break e.g. jet calibration with derivations storing variable as float
     SG::WriteDecorHandle<xAOD::JetContainer, float> decHandle_frac(m_writeDecorKeys_Nfrac.at(iFracCut));
     decHandle_frac(jet) = counter_Nfrac[iFracCut];
   }
 }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode JetCaloQualityToolFE::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 22 of file JetCaloQualityToolFE.cxx.

                                             {
   ATH_MSG_DEBUG( "Inside initialize() method" );
  
   if(!m_writeDecorKeys.empty()){
     ATH_MSG_ERROR("OutputDecorKeys should not be configured manually!");
     return StatusCode::FAILURE;
   }
   if(m_jetContainerName.empty()){
     ATH_MSG_ERROR("JetCaloQualityToolFE needs to have its input jet container name configured!");
     return StatusCode::FAILURE;
   }
  
   // Set the DecorHandleKeys with the correct strings
   for( const std::string & calcN : m_calculationNames){
  
     if(calcN == "LArQuality"){
       m_doLArQ = true;
     }
     else if(calcN == "HECQuality"){
       m_doHECQ = true;
     }
     else if(calcN == "NegativeE"){
       m_doNegE = true;
     }
     else if(calcN == "AverageLArQF"){
       m_doAvgLAr = true;
     }
     else if(calcN == "Timing"){
       m_doTime = true;
     }
     else if(calcN == "Centroid"){
       m_doCentroid = true;
     }
     else if(calcN == "BchCorrCell"){
       m_doBchCorrCell = true;
     }
  
     if(calcN == "Centroid"){
       m_writeDecorKeys.emplace_back(m_jetContainerName + "." + calcN+"R");
     }
     else{
       m_writeDecorKeys.emplace_back(m_jetContainerName + "." + calcN);
     }
   }
  
   // Define OOT calculators.
   for( const double timeCut : m_timingTimeCuts){
     // build the moment name from the base-name and the value of the timing cut
     std::stringstream s;
     s << std::setprecision(0) << std::fixed << "OotFracClusters" << timeCut;
     m_writeDecorKeys_OOT.emplace_back(m_jetContainerName + "." + s.str());
   }
  
   // Define tresholds for NXConstituents:
   for( const int fracCut: m_thresholdCuts){
     std::ostringstream sout;
     sout << "N" << fracCut << "Constituents";
     m_writeDecorKeys_Nfrac.emplace_back(m_jetContainerName + "." + sout.str());
   }
  
   ATH_CHECK(m_writeDecorKeys.initialize());
   if(!m_writeDecorKeys_OOT.empty()){
     ATH_CHECK(m_writeDecorKeys_OOT.initialize());
   }
   if(!m_writeDecorKeys_Nfrac.empty()){
     ATH_CHECK(m_writeDecorKeys_Nfrac.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.

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

Gaudi::Property<std::vector<std::string> > JetCaloQualityToolFE::m_calculationNames

protected

Initial value:

{this, "Calculations", {},

"Name of calo quantities to compute and add as decorations"}

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

bool JetCaloQualityToolFE::m_doAvgLAr = false

protected

Definition at line 59 of file JetCaloQualityToolFE.h.

◆ m_doBchCorrCell

bool JetCaloQualityToolFE::m_doBchCorrCell = false

protected

Definition at line 61 of file JetCaloQualityToolFE.h.

◆ m_doCentroid

bool JetCaloQualityToolFE::m_doCentroid = false

protected

Definition at line 60 of file JetCaloQualityToolFE.h.

◆ m_doHECQ

bool JetCaloQualityToolFE::m_doHECQ = false

protected

Definition at line 57 of file JetCaloQualityToolFE.h.

◆ m_doLArQ

bool JetCaloQualityToolFE::m_doLArQ = false

protected

Definition at line 56 of file JetCaloQualityToolFE.h.

◆ m_doNegE

bool JetCaloQualityToolFE::m_doNegE = false

protected

Definition at line 58 of file JetCaloQualityToolFE.h.

◆ m_doTime

bool JetCaloQualityToolFE::m_doTime = false

protected

Definition at line 62 of file JetCaloQualityToolFE.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_jetContainerName

Gaudi::Property<std::string> JetCaloQualityToolFE::m_jetContainerName

protected

Initial value:

{this, "JetContainer", "",

"SG key of input jet container"}

Definition at line 40 of file JetCaloQualityToolFE.h.

◆ m_thresholdCuts

Gaudi::Property<std::vector<int> > JetCaloQualityToolFE::m_thresholdCuts

protected

Initial value:

{this, "ThresholdCuts", {},

"Thresholds cuts (NxConstituents)"}

Definition at line 38 of file JetCaloQualityToolFE.h.

◆ m_timingTimeCuts

Gaudi::Property<std::vector<double> > JetCaloQualityToolFE::m_timingTimeCuts

protected

Initial value:

{this, "TimingCuts", {},

"Time cuts for out-of-time calo quantities"}

Definition at line 36 of file JetCaloQualityToolFE.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.

◆ m_writeDecorKeys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetCaloQualityToolFE::m_writeDecorKeys

protected

Initial value:

{this, "OutputDecorKeys", {},

"SG keys for output decorations (not to be configured manually!)"}

Definition at line 43 of file JetCaloQualityToolFE.h.

◆ m_writeDecorKeys_Nfrac

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetCaloQualityToolFE::m_writeDecorKeys_Nfrac

protected

Initial value:

{this, "OutputNfracConstitDecorKeys", {},

"SG keys for output NfracConstituents decorations (not to be configured manually!)"}

Definition at line 49 of file JetCaloQualityToolFE.h.

◆ m_writeDecorKeys_OOT

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetCaloQualityToolFE::m_writeDecorKeys_OOT

protected

Initial value:

{this, "OutputOOTDecorKeys", {},

"SG keys for output OOT decorations (not to be configured manually!)"}

Definition at line 46 of file JetCaloQualityToolFE.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetCaloQualityToolFE()

Member Function Documentation

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

◆ decorate()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extractConstituents()

◆ extraDeps_update_handler()

◆ fillQualityVariables()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_calculationNames

◆ m_detStore

◆ m_doAvgLAr

◆ m_doBchCorrCell

◆ m_doCentroid

◆ m_doHECQ

◆ m_doLArQ

◆ m_doNegE

◆ m_doTime

◆ m_evtStore

◆ m_jetContainerName

◆ m_thresholdCuts

◆ m_timingTimeCuts

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeDecorKeys

◆ m_writeDecorKeys_Nfrac

◆ m_writeDecorKeys_OOT