ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
HIJetCellSubtractorTool Class Reference

Concrete implementation of HIJetSubtractorToolBase. Class used by HIClusterSubtraction and HIJetConstituentSubtractionTool to provide kinematics of a cluster after subtraction given an event shape. This version of the tool navigates back to the cells. More...

#include <HIJetCellSubtractorTool.h>

Inheritance diagram for HIJetCellSubtractorTool:
Collaboration diagram for HIJetCellSubtractorTool:

Public Member Functions

virtual void subtract (xAOD::IParticle::FourMom_t &subtr_mom, const xAOD::IParticle *cl_in, const xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const ToolHandle< IHIUEModulatorTool > &modulator, const xAOD::HIEventShape *eshape) const override
 Implements method defined in base Navigates back to cells to do subtraction First argument is reference to four vector that is updated to reflect the subtracted kinematics of the IParticle passed in the second arg Method expects cl_in to be a cluster. More...
 
virtual void subtractWithMoments (xAOD::CaloCluster *cl, const xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const ToolHandle< IHIUEModulatorTool > &modulator, const xAOD::HIEventShape *eshape) const override
 
virtual void updateUsingCluster (xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const xAOD::CaloCluster *cl) const override
 Method to update the shape based on a given cluster two sets of indices are passed by reference and updated by the method sets are queried to see if the cluster has already been used, e.g. More...
 
float minEnergyForMoments () const
 
float minEnergySigForMoments () const
 
bool usesCells () const
 
const xAOD::HIEventShapeContainergetShape () const
 
const HIEventShapeIndexgetIndex () const
 
const IHIUEModulatorToolgetModulator () const
 
void setShape (const xAOD::HIEventShapeContainer *s)
 
void setIndex (const HIEventShapeIndex *ind)
 
void setModulator (const IHIUEModulatorTool *mod)
 
virtual StatusCode configureEvent (const xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const IHIUEModulatorTool *modulator)
 
virtual StatusCode initialize ()
 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
 

Protected Member Functions

void setMinEnergyForMoment (float min_E)
 
void setUpdateClusters (bool up)
 
bool UpdateClusters () const
 
void setSubtractedEtaPhi (float E, float &eta, float &phi, float eta0, float phi0, float sig) const
 
void setUseCells (bool v)
 
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< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

 HIJetCellSubtractorTool (const std::string &myname)
 
void UpdateShape (xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const CaloCell *theCell, float geoWeight, float eta0, float phi0, bool isNeg) 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

Gaudi::Property< float > m_EminMoment { this, "MinimumEnergyForMoments", 50., "> E, cluster given tower coordinates" }
 
Gaudi::Property< float > m_EsigMoment { this, "MinimumSignificanceForMoments", 0.1, "if E after subtr / E total < this cut, cluster given tower coordinates" }
 
Gaudi::Property< bool > m_updateClusters { this, "UpdateClusters", false, "If true set cluster kinematics to reflect subtraction" }
 
Gaudi::Property< bool > m_useCells { this, "UseCells", true, "Boolean switch for cells usage" }
 
const xAOD::HIEventShapeContainerm_shape
 
const HIEventShapeIndexm_index
 
const IHIUEModulatorToolm_modulator
 
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

Concrete implementation of HIJetSubtractorToolBase. Class used by HIClusterSubtraction and HIJetConstituentSubtractionTool to provide kinematics of a cluster after subtraction given an event shape. This version of the tool navigates back to the cells.

Author
Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch
Date
Jan, 2015

Definition at line 28 of file HIJetCellSubtractorTool.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

◆ HIJetCellSubtractorTool()

HIJetCellSubtractorTool::HIJetCellSubtractorTool ( const std::string &  myname)
private

Definition at line 17 of file HIJetCellSubtractorTool.cxx.

17  : HIJetSubtractorToolBase(myname)
18 {
19 
20 }

Member Function Documentation

◆ configureEvent()

StatusCode HIJetSubtractorToolBase::configureEvent ( const xAOD::HIEventShapeContainer shape,
const HIEventShapeIndex index,
const IHIUEModulatorTool modulator 
)
virtualinherited

Definition at line 40 of file HIJetSubtractorToolBase.cxx.

41 {
42  setShape(shape);
43  setIndex(index);
44  setModulator(modulator);
45  return StatusCode::SUCCESS;
46 
47 }

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

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

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

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

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

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

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

200  {
201  return PBASE::declareProperty(t);
202  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

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

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

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

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

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

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

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

◆ 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

◆ getIndex()

const HIEventShapeIndex* HIJetSubtractorToolBase::getIndex ( ) const
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 36 of file HIJetSubtractorToolBase.h.

36 {return m_index;};

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

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

◆ getModulator()

const IHIUEModulatorTool* HIJetSubtractorToolBase::getModulator ( ) const
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 37 of file HIJetSubtractorToolBase.h.

37 {return m_modulator;};

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

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

◆ getProperty()

template<class T >
const T* asg::AsgTool::getProperty ( const std::string &  name) const
inherited

Get one of the tool's properties.

◆ getShape()

const xAOD::HIEventShapeContainer* HIJetSubtractorToolBase::getShape ( ) const
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 35 of file HIJetSubtractorToolBase.h.

35 {return m_shape;};

◆ initialize()

virtual StatusCode asg::AsgTool::initialize ( )
inlinevirtualinherited

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 in SimpleMuonTriggerScaleFactors, Trig::TrigMuonMatching, CP::MuonTriggerScaleFactors, Trig::TrigTauMatchingTool, IHIEventShapeMapTool, ST::SUSYObjDef_xAOD, InDetSecVtxTruthMatchTool, JetGrooming::RecSoftDrop, met::METMaker, AsgForwardElectronIsEMSelector, JetGrooming::JetTrimming, ORUtils::BaseOverlapTool, PMGTools::PMGSherpa22VJetsWeightTool, AsgElectronEfficiencyCorrectionTool, CP::ElectronChargeEfficiencyCorrectionTool, AsgForwardElectronLikelihoodTool, CorrectPFOTool, CP::IsolationCorrectionTool, TauAnalysisTools::TauTruthMatchingTool, EGammaAmbiguityTool, InDetVertexTruthMatchTool, AthOnnx::OnnxRuntimeSessionToolCPU, AthOnnx::OnnxRuntimeSessionToolCUDA, PuppiWeightTool, JetIsolationTool, JetBalancePFlowJvtTool, CP::FFJetSmearingTool, JetForwardPFlowJvtTool, MCTruthClassifier, InDet::InDetHardScatterSelectionTool, dRMatchingTool, xAOD::BPhysBlindingTool, CP::EgammaCalibrationAndSmearingTool, JetVertexTaggerTool, tauRecTools::TrackRNN, LVL1::L1CaloOfflineTriggerTowerTools, TauAnalysisTools::TauSelectionTool, JetRecTool, met::METAssociationTool, CP::TrackVertexAssociationTool, met::METRebuilder, met::METAssociator, xAOD::TrackIsolationTool, InDet::InDetTrackSelectionTool, egammaMVACalibTool, TrigConf::xAODConfigTool, JetCleaningTool, met::METCaloRegionsTool, ZDC::ZdcLEDAnalysisTool, CP::MuonCalibTool, LVL1::L1CaloCells2TriggerTowers, JetVertexFractionTool, LVL1BS::PpmByteStreamReadV1V2Tool, JetClusterer, JetForwardJvtToolBDT, CP::AsgFlagSelectionTool, TauTrackFinder, TauAnalysisTools::DiTauSelectionTool, JetClustererByVertex, JetBadChanCorrTool, xAOD::BPhysTrackVertexMapTool, JetModifiedMassDrop, xAOD::CaloIsolationTool, EnhancedBiasWeighter, BookkeeperTool, ZDC::RpdSubtractCentroidTool, InDet::InDetUsedInFitTrackDecoratorTool, CP::AsgPtEtaSelectionTool, TauAnalysisTools::BuildTruthTaus, top::EventSaverFlatNtuple, tauRecTools::TauTrackRNNClassifier, InDet::InDetSecVtxTrackSelectionTool, JetForwardJvtTool, JetPileupTag::JetVertexNNTagger, CP::EgammaIsGoodOQSelectionTool, CP::IsolationCloseByCorrectionTool, CP::MuonCalibIntScaleSmearTool, DiTauRecTools::DiTauIDVarCalculator, JetFinder, AsgElectronIsEMSelector, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, DiTauRecTools::DiTauDiscriminantTool, met::METBuilderTool, CP::AsgMaskSelectionTool, ElectronPhotonVariableCorrectionBase, ECUtils::EventCleaningTool, TauAnalysisTools::TauTruthTrackMatchingTool, met::METSoftTermsTool, LVL1::L1CaloLArTowerEnergy, HiggsTruthCategoryTool, IDTPM::TrackRoiSelectionTool, TauAnalysisTools::CommonDiTauEfficiencyTool, HIJetConstituentSubtractionTool, JetTrackSumMomentsTool, JetGrooming::SoftDrop, HFORSelectionTool, JetQGTaggerVariableTool, JetTrackMomentsTool, met::METTruthTool, CP::BaseLinearFakeBkgTool, PMGTools::PMGSherpaVjetsSysTool, ClusterMatching::CaloClusterMatchingTool, AsgPhotonEfficiencyCorrectionTool, InDet::JetTrackFilterTool, asg::DataHandleTestTool, xAODMaker::FileMetaDataTool, CP::BaseFakeBkgTool, InDet::InclusiveTrackFilterTool, InDet::InDetTrackTruthFilterTool, HIJetClusterSubtractorTool, CP::MVATrackVertexAssociationTool, IDTPM::RoiSelectionTool, ElectronPhotonVariableCorrectionTool, JetCalibrationTool, JetCaloQualityTool, JetOriginCorrectionTool, InDet::InDetTrackBiasingTool, HIJetClusterIndexAssociationTool, TauWPDecorator, TrigGlobalEfficiencyCorrectionTool, ZdcRecChannelToolV2, IDTPM::TrackObjectSelectionTool, CP::LhoodMM_tools, FlavorTagDiscriminants::GNNTool, FlavorTagDiscriminants::MultifoldGNNTool, CP::MuonSelectionTool, TauAnalysisTools::CommonDiTauSmearingTool, JSSTaggerBase, ZDC::ZdcAnalysisTool, IDTPM::TrackQualitySelectionTool, AsgElectronLikelihoodTool, CP::JetQGTagger, CP::JetJvtEfficiency, LVL1::L1CaloFcal23Cells2RxMappingTool, ORUtils::OverlapRemovalTool, Analysis::JetQuarkLabel, Ringer::AsgRingerSelectorTool, InDet::InDetTrackSmearingTool, JetCopier, JetGrooming::JetGroomer, met::METPhotonAssociator, JetECPSFractionTool, JetPtAssociationTool, met::METElectronAssociator, met::METTauAssociator, PMGTools::PMGDecayProductsSelectionTool, WeightToolBase, HIJetDRAssociationTool, JetClusterMomentsTool, met::METJetAssocTool, TauVertexFinder, IDTPM::JsonPlotsDefReadTool, TauAnalysisTools::DiTauSmearingTool, JetDRTrackAssocTool, JetReclusterer, TauDecayModeNNClassifier, BDTVertexWeightCalculator, asg::UnitTestTool1, IDTPM::DeltaRMatchingToolBase< T, R >, AsgElectronSelectorTool, JetReclusteringTool, met::METMuonAssociator, TauPi0CreateROI, TauShotFinder, IDTPM::DeltaRMatchingToolBase< xAOD::TrackParticle, xAOD::TruthParticle >, IDTPM::DeltaRMatchingToolBase< xAOD::TruthParticle, xAOD::TrackParticle >, IDTPM::DeltaRMatchingToolBase< xAOD::TrackParticle >, ZdcRecChannelToolLucrod, PMGTools::PMGTruthWeightTool, JetVoronoiMomentsTool, Trig::MatchFromCompositeTool, asg::UnitTestTool3, IDTPM::TruthTrackMatchingTool, CP::ApplyFakeFactor, AsgElectronChargeIDSelectorTool, HIJetMaxOverMeanTool, PanTau::Tool_FeatureExtractor, TauElectronVetoVariables, CP::IsolationSelectionTool, WeightsAgregator, EL::UnitTestTool, FlavorTagDiscriminants::TrackClassifier, JetLArHVTool, ZDC::ZdcTrigValidTool, IDTPM::TrackTruthMatchingTool, HI::HIPileupTool, InDet::InDetTrackTruthOriginTool, JetHelper::VarTool, FlavorTagDiscriminants::DL2Tool, BTaggingSelectionTool, EnergyCorrelatorGeneralizedRatiosTool, EnergyCorrelatorGeneralizedTool, EnergyCorrelatorRatiosTool, EnergyCorrelatorTool, TauEleOverlapChecker, TauJetRNNEvaluator, asg::UnitTestTool2, JetTruthLabelingTool, ZDC::ZdcRecTool, HIJetConstituentModifierTool, TauCalibrateLC, TauGNNEvaluator, TauPi0ScoreCalculator, TauRecToolBase, Trig::TrigEgammaEmulationPrecisionElectronHypoTool, asg::UnitTestTool1A, PDFWeight, HIEventShapeJetIteration, HIJetSignificanceTool, CP::JetQGTaggerBDT, JetWidthTool, TauVertexVariables, Trig::TrigEgammaEmulationPrecisionPhotonHypoTool, Trig::TrigEgammaMatchingTool, Trig::R3IParticleRetrievalTool, IDTPM::TruthTrackQualitySelectionTool, JetPileupLabelingTool, JetFromPseudojet, JetTruthParticleSelectorTool, Trig::TrigEgammaEmulationBaseHypoTool, CP::ApplyE2YFakeRate, ParticleScaleFactorTool, InDet::InDetTrackSystematicsTool, JetCaloQualityToolFE, Trig::MatchingTool, Trig::R3MatchingTool, IDTPM::OfflineTrackQualitySelectionTool, JetParticleAssociation, Trig::TrigEgammaEmulationChain, Trig::TrigEgammaEmulationFastCaloHypoTool, AthOnnx::OnnxRuntimeInferenceTool, xAODtoHepMCTool, HIEventShapeMapTool, HI::HIVertexSelectionTool, JetHelper::HistoInput2D, TauVertexedClusterDecorator, Trig::IParticleRetrievalTool, CP::AsymptMatrixTool, HI::HIEventSelectionTool, FlavorTagDiscriminants::HbbTagTool, JetConstituentFrac, JetGroomMRatio, JetHelper::HistoInput1D, JetHelper::TextInputMCJES, ExtendTrackToLayerTool, Trig::TypedScoringTool, TrackTruthSelectionTool, HIUEModulatorTool, JSSWTopTaggerANN, CP::JvtEfficiencyToolBase, JetEMScaleMomTool, MvaTESVariableDecorator, TauAODLeptonRemovalTool, TauCombinedTES, ParticleJetDeltaRLabelTool, HIEventShapeSummaryTool, FlavorTagDiscriminants::BTagAugmenterTool, FlavorTagDiscriminants::VRJetOverlapDecoratorTool, JetCaloEnergies, ParticleJetGhostLabelTool, FlavorTagDiscriminants::BTagMuonAugmenterTool, MBTSTimeFilterTool, JSSWTopTaggerDNN, SmoothedTopTagger, MvaTESEvaluator, CP::IsolationLowPtPLVTool, Trig::DRScoringTool, Trig::EgammaDRScoringTool, SmoothedWZTagger, CP::FJvtEfficiencyTool, CP::JvtSelectionToolBase, CP::NNJvtSelectionTool, AthAsgExUnittestTool, CP::JvtSelectionTool, BTaggingSelectionJsonTool, CP::FJvtSelectionTool, CP::JvtEfficiencyTool, CP::NNJvtEfficiencyTool, BookkeeperDumperTool, TrigFastCalibWithRings, top::ScaleFactorRetriever, BTaggingEfficiencyTool, BTaggingTruthTaggingTool, MissingCellListTool, JetVoronoiDiagramHelpers::Diagram, FastJetInterfaceTool, met::METSystematicsTool, Trig::TrigEgammaEmulationToolMT, JetAttributeRatioSelector, top::GhostTrackSystematicsMaker, top::TopObjectSelection, BTaggingEigenVectorRecompositionTool, LVL1::TrigT1CaloLWHistogramToolV1, LVL1::TrigT1CaloLWHistogramTool, Trig::TrigDecisionTool, CP::PhotonPointingTool, met::METRecoTool, CP::PhotonVertexSelectionTool, top::KLFitterTool, ZdcByteStreamReadV1V2Tool, CP::PileupReweightingTool, top::JetObjectCollectionMaker, LVL1::L1CaloxAODOfflineTriggerTowerTools, RCJet, LVL1::TrigT1CaloMonErrorToolV1, met::METTrackFilterTool, LVL1::TrigT1CaloMonErrorTool, SoftKillerWeightTool, EventDensityTool, met::METSignificance, ParticleLevelRCJetObjectLoader, JetUncertaintiesTool, top::TopToolStore, CP::JetTileCorrectionTool, xAODMaker::TriggerMenuMetaDataTool, D3PD::D3PDMCTruthClassifier, top::ElectronInJetSubtractionCollectionMaker, top::MuonObjectCollectionMaker, JetConstituentModSequence, top::EgammaObjectCollectionMaker, HistoGroupBase, AsgPhotonIsEMSelector, JetAttributeSelector, top::ObjectCollectionMaker, TrackVertexAssociationTool, met::METRefinerTool, TauAnalysisTools::CommonSmearingTool, top::GlobalLeptonTriggerCalculator, top::ScaleFactorCalculator, top::TrackSystematicsMaker, top::ElectronScaleFactorCalculator, top::JetScaleFactorCalculator, top::MuonScaleFactorCalculator, PanTau::Tool_DetailsArranger, LVL1::L1CaloMonitoringCaloTool, top::EventSaverxAOD, LVL1::L1CaloTTIdTools, top::SoftMuonObjectCollectionMaker, top::TauObjectCollectionMaker, JetInputElRemovalTool, TauAnalysisTools::CommonEfficiencyTool, top::BTagScaleFactorCalculator, top::MissingETObjectCollectionMaker, PanTau::PanTauProcessor, xAODMaker::TruthMetaDataTool, top::PDFScaleFactorCalculator, top::PhotonScaleFactorCalculator, top::PseudoTopReco, EventShapeCopier, met::METJetTool, GoodRunsListSelectionTool, top::EventSaverxAODNext, top::FwdElectronScaleFactorCalculator, FSR::FsrPhotonTool, Trig::StaticBunchCrossingTool, ZMassConstraint::ConstraintFit, TauAnalysisTools::TauEfficiencyCorrectionsTool, PanTau::Tool_DecayModeDeterminator, PanTau::Tool_ModeDiscriminator, CP::ElectronLRTOverlapRemovalTool, HIClusterSubtraction, JetAttributeHisto, JetPseudojetCopier, met::METEgammaAssociator, Trig::xAODBunchCrossingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauTruthMatchingTool, TauAnalysisTools::TauSmearingTool, top::JetMETCPTools, met::METTruthAssociator, PanTau::Tool_InformationStore, HistoDefinitionTool, PanTau::Tool_InputConverter, JetBottomUpSoftDrop, JetRecursiveSoftDrop, PMGTools::PMGCrossSectionTool, JetSoftDrop, TrigEgammaMatchingToolMT, DiTauMassTools::MissingMassToolV2, top::TauScaleFactorCalculator, top::TriggerCPTools, JetConstituentsRetriever, VoronoiWeightTool, top::GhostTrackCPTools, JetCaloCellQualityTool, JetContainerHistoFiller, ChargedHadronSubtractionTool, JetTrackSelectionTool, met::METRegionsTool, met::METSoftAssociator, PanTau::Tool_TauConstituentGetter, top::EventCleaningSelection, ConstituentSubtractorTool, top::EgammaCPTools, top::OtherCPTools, top::TopEventMaker, JetHistoBase, JetSelectorAttributeRunII, JetSplitter, CaloClusterConstituentsOrigin, JetTrackSelectionTool2, SimpleJetTrackSelectionTool, CP::MuonLRTOverlapRemovalTool, top::FlavorTaggingCPTools, top::TauCPTools, HistosForJetSelection, JetPruner, JetToolRunner, JetUsedInFitTrackDecoratorTool, top::TrackCPTools, JetTrimmer, NSubjettinessRatiosTool, CP::MuonEfficiencyScaleFactors, top::PileupScaleFactorCalculator, top::MuonCPTools, JetConstitFourMomTool, NSubjettinessTool, ZdcDataAccessV2, JetPseudojetRetriever, LVL1BS::TrigT1CaloDataAccessV2, PanTau::Tool_TauConstituentSelector, CopyTruthParticles, top::IsolationCPTools, top::OverlapRemovalCPTools, ClusterAtEMScaleTool, CP::IsolationHelper, top::BoostedTaggingCPTools, AsgDeadHVCellRemovalTool, ConstitTimeCutTool, Analysis::JetConeLabeling, JetSelectorAttribute, HIJetUEMonitoring, HIEfficiencyResponseHistos, JetSubStructureMomentToolsBase, AsgHelloTool, CopyTruthJetParticles, LeadingJetsRelations, EfficiencyResponseHistos, and JetEventSelector.

Definition at line 133 of file AsgTool.h.

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

◆ minEnergyForMoments()

float HIJetSubtractorToolBase::minEnergyForMoments ( ) const
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 30 of file HIJetSubtractorToolBase.h.

30 {return m_EminMoment;};

◆ minEnergySigForMoments()

float HIJetSubtractorToolBase::minEnergySigForMoments ( ) const
inlineinherited

Definition at line 31 of file HIJetSubtractorToolBase.h.

31 {return m_EsigMoment;};

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

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

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

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

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ 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

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

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

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

364  {
365  handlesArray.renounce();
366  }

◆ setIndex()

void HIJetSubtractorToolBase::setIndex ( const HIEventShapeIndex ind)
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 39 of file HIJetSubtractorToolBase.h.

39 {m_index=ind;};

◆ setMinEnergyForMoment()

void HIJetSubtractorToolBase::setMinEnergyForMoment ( float  min_E)
inlineprotectedinherited

Definition at line 57 of file HIJetSubtractorToolBase.h.

57 { m_EminMoment=min_E; };

◆ setModulator()

void HIJetSubtractorToolBase::setModulator ( const IHIUEModulatorTool mod)
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 40 of file HIJetSubtractorToolBase.h.

40 {m_modulator=mod;};

◆ setShape()

void HIJetSubtractorToolBase::setShape ( const xAOD::HIEventShapeContainer s)
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 38 of file HIJetSubtractorToolBase.h.

38 {m_shape=s;};

◆ setSubtractedEtaPhi()

void HIJetSubtractorToolBase::setSubtractedEtaPhi ( float  E,
float &  eta,
float &  phi,
float  eta0,
float  phi0,
float  sig 
) const
protectedinherited

Definition at line 24 of file HIJetSubtractorToolBase.cxx.

25 {
28  {
29  eta=eta0;
30  phi=phi0;
31  }
32  else if( E < minEnergyForMoments() || ( (sig > 0) && sig < minEnergySigForMoments() ) )
33  {
34  eta=eta0;
35  phi=phi0;
36  }
37 
38 }

◆ setUpdateClusters()

void HIJetSubtractorToolBase::setUpdateClusters ( bool  up)
inlineprotectedinherited

Definition at line 58 of file HIJetSubtractorToolBase.h.

58 { m_updateClusters=up; };

◆ setUseCells()

void HIJetSubtractorToolBase::setUseCells ( bool  v)
inlineprotectedinherited

Definition at line 64 of file HIJetSubtractorToolBase.h.

64 {m_useCells=v;};

◆ subtract()

void HIJetCellSubtractorTool::subtract ( xAOD::IParticle::FourMom_t subtr_mom,
const xAOD::IParticle cl_in,
const xAOD::HIEventShapeContainer shape,
const HIEventShapeIndex index,
const ToolHandle< IHIUEModulatorTool > &  modulator,
const xAOD::HIEventShape eshape 
) const
overridevirtual

Implements method defined in base Navigates back to cells to do subtraction First argument is reference to four vector that is updated to reflect the subtracted kinematics of the IParticle passed in the second arg Method expects cl_in to be a cluster.

Implements IHISubtractorTool.

Definition at line 22 of file HIJetCellSubtractorTool.cxx.

23 {
24  //if( cl_in->type() == xAOD::Type::CaloCluster )
25  //use static cast, derived type of IParticle checked explicitly upstream
26  const xAOD::CaloCluster* cl=static_cast<const xAOD::CaloCluster*>(cl_in);
27  float E_cl=0;
28  float eta_cl=0;
29  float phi_cl=0;
30 
31  const float eta0=cl->eta0();
32  const float phi0=cl->phi0();
33 
34  float mod=modulator->getModulation(phi0, eshape);
35  //unsigned int eta_phi_index=HICaloCellHelper::FindEtaPhiBin(cl->eta0(),cl->phi0());
36  xAOD::CaloCluster::const_cell_iterator cellIterEnd = cl->cell_end();
37 
38  for(xAOD::CaloCluster::const_cell_iterator cellIter=cl->cell_begin(); cellIter != cellIterEnd; cellIter++ )
39  {
40  CxxUtils::prefetchNext(cellIter, cellIterEnd);
41 
42  unsigned int sample = (CaloSampling::CaloSample) (*cellIter)->caloDDE()->getSampling();
43  float eta=(*cellIter)->eta();
44  float phi=(*cellIter)->phi();
45 
46  float nCells=index->getShape(eta0,sample,shape)->nCells();
47  float rho=0;
48  if(nCells!=0.) rho=index->getShape(eta0,sample,shape)->rho()/nCells;
49  rho*=mod;
50  float geoWeight=cellIter.weight();
51  float cell_E_w=(*cellIter)->energy()*geoWeight;
52  cell_E_w-=rho*HICaloCellHelper::getAreaEtaPhi(*cellIter)*geoWeight*std::cosh(eta0);
53 
54 
55  E_cl+=cell_E_w;
56  eta_cl+=cell_E_w*eta;
57  phi_cl+=cell_E_w*phi;
58 
59  }
60 
61  if(E_cl!=0.)
62  {
63  eta_cl/=E_cl;
64  phi_cl/=E_cl;
65  }
66  //rare case E_cl==0 is also handled by setSubtractedEtaPhi
67  float E_unsubtr=cl->e(HIJetRec::unsubtractedClusterState());
68  float sig=(E_unsubtr!=0. ? E_cl/E_unsubtr : 0.);
69  setSubtractedEtaPhi(E_cl,eta_cl,phi_cl,eta0,phi0,sig);
70  float ET_cl=(std::abs(eta_cl)>99. ? 0. : E_cl/std::cosh(eta_cl));
71  subtr_mom.SetPxPyPzE(ET_cl*std::cos(phi_cl),ET_cl*std::sin(phi_cl),ET_cl*std::sinh(eta_cl),E_cl);
72 }

◆ subtractWithMoments()

void HIJetCellSubtractorTool::subtractWithMoments ( xAOD::CaloCluster cl,
const xAOD::HIEventShapeContainer shape,
const HIEventShapeIndex index,
const ToolHandle< IHIUEModulatorTool > &  modulator,
const xAOD::HIEventShape eshape 
) const
overridevirtual

Implements IHISubtractorTool.

Definition at line 119 of file HIJetCellSubtractorTool.cxx.

120 {
121  //if( cl_in->type() == xAOD::Type::CaloCluster )
122  //use static cast, derived type of IParticle checked explicitly upstream
123 
124  float E_cl=0;
125  float eta_cl=0;
126  float phi_cl=0;
127 
128  const float eta0=cl->eta0();
129  const float phi0=cl->phi0();
130 
131  float mod=modulator->getModulation(phi0, eshape);
132 
133  //declaring quantities to be summed during cell loop
134  //using same variable names as original implementation in HIEventShapeFillerTool
135  float etot2=0; //sum of the weights, in this case weights are |E|
136  float er2=0; //sum of weight x moment, in this case moments are magnitudes of cell coordinate three vectors
137 
138  std::vector<float> E_sample(CaloSampling::Unknown,0);
139  uint32_t samplingPattern=0;
140 
141  const auto *cellLink = cl->getCellLinks();
142  if( cellLink == NULL){
143  ATH_MSG_ERROR("HIJetCellSubtraction: cellLink null - returning");
144  return;
145  }
146  //unsigned int eta_phi_index=HICaloCellHelper::FindEtaPhiBin(cl->eta0(),cl->phi0());
147  xAOD::CaloCluster::cell_iterator cellIterEnd = cl->cell_end();
148  for(xAOD::CaloCluster::cell_iterator cellIter=cl->cell_begin(); cellIter != cellIterEnd; cellIter++ )
149  {
150  CxxUtils::prefetchNext(cellIter, cellIterEnd);
151 
152  unsigned int sample = (CaloSampling::CaloSample) (*cellIter)->caloDDE()->getSampling();
153  samplingPattern |= (0x1U<<sample);
154  float eta=(*cellIter)->eta();
155  float phi=(*cellIter)->phi();
156 
157  float nCells=index->getShape(eta0,sample,shape)->nCells();
158  float rho=0;
159  if(nCells!=0.) rho=index->getShape(eta0,sample,shape)->rho()/nCells;
160 
161  rho*=mod;
162  float geoWeight=cellIter.weight();
163  float cell_E_w=(*cellIter)->energy()*geoWeight;
164  cell_E_w-=rho*HICaloCellHelper::getAreaEtaPhi(*cellIter)*geoWeight*std::cosh(eta0);
165 
166  E_cl+=cell_E_w;
167  eta_cl+=cell_E_w*eta;
168  phi_cl+=cell_E_w*phi;
169 
170  E_sample[sample]+=cell_E_w;
171 
172  float abs_weight=std::abs(cell_E_w);
173  float cell_x=(*cellIter)->x();
174  float cell_y=(*cellIter)->y();
175  float cell_z=(*cellIter)->z();
176  etot2+=abs_weight;
177  er2+=std::sqrt(cell_x*cell_x+cell_y*cell_y+cell_z*cell_z)*abs_weight;
178  }
179  if(E_cl!=0.)
180  {
181  eta_cl/=E_cl;
182  phi_cl/=E_cl;
183  }
184  //rare case E_cl==0 is also handled by setSubtractedEtaPhi
185  float E_unsubtr=cl->e(HIJetRec::unsubtractedClusterState());
186  float sig=(E_unsubtr!=0. ? E_cl/E_unsubtr : 0.);
187  setSubtractedEtaPhi(E_cl,eta_cl,phi_cl,eta0,phi0,sig);
188  float ET_cl=(std::abs(eta_cl)>99. ? 0. : E_cl/std::cosh(eta_cl));
189  xAOD::IParticle::FourMom_t subtr_mom;
190  subtr_mom.SetPxPyPzE(ET_cl*std::cos(phi_cl),ET_cl*std::sin(phi_cl),ET_cl*std::sinh(eta_cl),E_cl);
192 
193  cl->setSamplingPattern(samplingPattern);
194  for(unsigned int isample=0; isample < E_sample.size(); isample++)
195  {
196  if( samplingPattern & (0x1U << isample) )
197  {
198  float current_energy=E_sample.at(isample);
200  cl->setEnergy(s,current_energy);
201  }
202  }
203 
204  float cm=0.;
205  if(etot2!=0.) cm=er2/etot2;
206 
207  //attach the moment to the cluster
208  static const SG::Accessor<float> HIMagAcc("HIMag");
209  if(HIMagAcc.isAvailable(*cl)) HIMagAcc(*cl)=cm;
210  else cl->insertMoment(xAOD::CaloCluster::CENTER_MAG,cm);
211 }

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

◆ UpdateClusters()

bool HIJetSubtractorToolBase::UpdateClusters ( ) const
inlineprotectedinherited

Definition at line 60 of file HIJetSubtractorToolBase.h.

60 { return m_updateClusters; };

◆ UpdateShape()

void HIJetCellSubtractorTool::UpdateShape ( xAOD::HIEventShapeContainer shape,
const HIEventShapeIndex index,
const CaloCell theCell,
float  geoWeight,
float  eta0,
float  phi0,
bool  isNeg 
) const
private

Definition at line 87 of file HIJetCellSubtractorTool.cxx.

88 {
89  float sgn=(isNeg) ? -1 : 1;
90 
91  int layer = theCell->caloDDE()->getSampling();
92  float cell_et = theCell->et();
93 
94  unsigned int iSlice=index->getIndex(eta0,layer);
95 
96 
97  xAOD::HIEventShape* slice=shape->at(iSlice);
98  //update members
99  slice->setNCells(slice->nCells()+sgn);
100  slice->setEt(slice->et()+sgn*cell_et*geoWeight);
101  float area=HICaloCellHelper::getAreaEtaPhi(theCell);
102  float rho=0;
103  if(area!=0.) rho=cell_et/area;
104  slice->setArea(slice->area() + sgn*area*geoWeight);
105  slice->setRho(slice->rho() + sgn*rho);
106 
107  for(unsigned int ih=0; ih<shape->at(iSlice)->etCos().size(); ih++)
108  {
109  float ih_f=ih+1;
110  float tmp_cos = shape->at(iSlice)->etCos().at(ih);
111  shape->at(iSlice)->etCos()[ih] = tmp_cos + cell_et*cos(ih_f*phi0)*geoWeight;
112 
113  float tmp_sin = shape->at(iSlice)->etSin().at(ih);
114  shape->at(iSlice)->etSin()[ih] = tmp_sin + cell_et*sin(ih_f*phi0)*geoWeight;
115  }
116 
117 }

◆ updateUsingCluster()

void HIJetCellSubtractorTool::updateUsingCluster ( xAOD::HIEventShapeContainer shape,
const HIEventShapeIndex index,
const xAOD::CaloCluster cl 
) const
overridevirtual

Method to update the shape based on a given cluster two sets of indices are passed by reference and updated by the method sets are queried to see if the cluster has already been used, e.g.

by another jet seed checking/updating sets prevents double counting eta-bin set used to determine eta-averaged flow

Implements IHISubtractorTool.

Definition at line 74 of file HIJetCellSubtractorTool.cxx.

75 {
76  float eta0=cl->eta0();
77  float phi0=cl->phi0();
78 
79  xAOD::CaloCluster::const_cell_iterator cellIterEnd = cl->cell_end();
80  for(xAOD::CaloCluster::const_cell_iterator cellIter=cl->cell_begin(); cellIter != cellIterEnd; cellIter++ )
81  {
82  CxxUtils::prefetchNext(cellIter, cellIterEnd);
83  UpdateShape(shape,index,*cellIter,cellIter.weight(),eta0,phi0,true);
84  }
85 }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

◆ usesCells()

bool HIJetSubtractorToolBase::usesCells ( ) const
inlinevirtualinherited

Implements IHISubtractorTool.

Definition at line 32 of file HIJetSubtractorToolBase.h.

32 {return m_useCells;};

Member Data Documentation

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

Gaudi::Property< float > HIJetSubtractorToolBase::m_EminMoment { this, "MinimumEnergyForMoments", 50., "> E, cluster given tower coordinates" }
privateinherited

Definition at line 46 of file HIJetSubtractorToolBase.h.

◆ m_EsigMoment

Gaudi::Property< float > HIJetSubtractorToolBase::m_EsigMoment { this, "MinimumSignificanceForMoments", 0.1, "if E after subtr / E total < this cut, cluster given tower coordinates" }
privateinherited

Definition at line 47 of file HIJetSubtractorToolBase.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_index

const HIEventShapeIndex* HIJetSubtractorToolBase::m_index
privateinherited

Definition at line 52 of file HIJetSubtractorToolBase.h.

◆ m_modulator

const IHIUEModulatorTool* HIJetSubtractorToolBase::m_modulator
privateinherited

Definition at line 53 of file HIJetSubtractorToolBase.h.

◆ m_shape

const xAOD::HIEventShapeContainer* HIJetSubtractorToolBase::m_shape
privateinherited

Definition at line 51 of file HIJetSubtractorToolBase.h.

◆ m_updateClusters

Gaudi::Property< bool > HIJetSubtractorToolBase::m_updateClusters { this, "UpdateClusters", false, "If true set cluster kinematics to reflect subtraction" }
privateinherited

Definition at line 48 of file HIJetSubtractorToolBase.h.

◆ m_useCells

Gaudi::Property< bool > HIJetSubtractorToolBase::m_useCells { this, "UseCells", true, "Boolean switch for cells usage" }
privateinherited

Definition at line 49 of file HIJetSubtractorToolBase.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
HIJetSubtractorToolBase::minEnergyForMoments
float minEnergyForMoments() const
Definition: HIJetSubtractorToolBase.h:30
xAOD::CaloCluster_v1::CENTER_MAG
@ CENTER_MAG
Cluster Centroid ( )
Definition: CaloCluster_v1.h:135
GetLCDefs::Unknown
@ Unknown
Definition: GetLCDefs.h:21
HICaloCellHelper::getAreaEtaPhi
float getAreaEtaPhi(const CaloCell *theCell)
Definition: HICaloCellHelper.cxx:15
HIJetSubtractorToolBase::m_modulator
const IHIUEModulatorTool * m_modulator
Definition: HIJetSubtractorToolBase.h:53
python.SystemOfUnits.s
int s
Definition: SystemOfUnits.py:131
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:64
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
SG::Accessor< float >
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:79
index
Definition: index.py:1
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
HIJetSubtractorToolBase::HIJetSubtractorToolBase
HIJetSubtractorToolBase(const std::string &myname)
Definition: HIJetSubtractorToolBase.cxx:9
InDetAccessor::phi0
@ phi0
Definition: InDetAccessor.h:33
HIJetRec::inTowerBoundary
bool inTowerBoundary(float eta0, float phi0, float eta, float phi)
Definition: HIJetRecDefs.h:29
HIJetSubtractorToolBase::m_EsigMoment
Gaudi::Property< float > m_EsigMoment
Definition: HIJetSubtractorToolBase.h:47
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
HIJetSubtractorToolBase::m_useCells
Gaudi::Property< bool > m_useCells
Definition: HIJetSubtractorToolBase.h:49
xAOD::etCos
etCos
Definition: HIEventShape_v2.cxx:27
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
drawFromPickle.cos
cos
Definition: drawFromPickle.py:36
HIJetSubtractorToolBase::setIndex
void setIndex(const HIEventShapeIndex *ind)
Definition: HIJetSubtractorToolBase.h:39
Phi_mpi_pi
__HOSTDEV__ double Phi_mpi_pi(double)
Definition: GeoRegion.cxx:7
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
xAOD::IParticle::FourMom_t
TLorentzVector FourMom_t
Definition of the 4-momentum type.
Definition: Event/xAOD/xAODBase/xAODBase/IParticle.h:68
HIJetSubtractorToolBase::m_EminMoment
Gaudi::Property< float > m_EminMoment
Definition: HIJetSubtractorToolBase.h:46
cm
const double cm
Definition: Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/FCAL_ChannelMap.cxx:25
python.setupRTTAlg.size
int size
Definition: setupRTTAlg.py:39
xAOD::HIEventShape_v2
Interface class for the HI reconstruction EDM.
Definition: HIEventShape_v2.h:31
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
HIJetSubtractorToolBase::m_shape
const xAOD::HIEventShapeContainer * m_shape
Definition: HIJetSubtractorToolBase.h:51
xAOD::CaloCluster_v1
Description of a calorimeter cluster.
Definition: CaloCluster_v1.h:59
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
HIJetRec::subtractedClusterState
constexpr xAOD::CaloCluster::State subtractedClusterState()
Definition: HIJetRecDefs.h:26
maskDeadModules.mod
mod
Definition: maskDeadModules.py:36
FullCPAlgorithmsTest_eljob.sample
sample
Definition: FullCPAlgorithmsTest_eljob.py:100
perfmonmt-refit.slice
slice
Definition: perfmonmt-refit.py:52
xAOD::nCells
setRawEt setRawPhi nCells
Definition: TrigCaloCluster_v1.cxx:33
CaloSampling::CaloSample
CaloSample
Definition: Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h:22
CaloCell::caloDDE
const CaloDetDescrElement * caloDDE() const
get pointer to CaloDetDescrElement (data member)
Definition: CaloCell.h:305
HIJetSubtractorToolBase::setModulator
void setModulator(const IHIUEModulatorTool *mod)
Definition: HIJetSubtractorToolBase.h:40
TRT::Hit::layer
@ layer
Definition: HitInfo.h:79
HIJetCellSubtractorTool::UpdateShape
void UpdateShape(xAOD::HIEventShapeContainer *shape, const HIEventShapeIndex *index, const CaloCell *theCell, float geoWeight, float eta0, float phi0, bool isNeg) const
Definition: HIJetCellSubtractorTool.cxx:87
CalibCoolCompareRT.up
up
Definition: CalibCoolCompareRT.py:109
python.BuildSignatureFlags.sig
sig
Definition: BuildSignatureFlags.py:215
CaloCell::et
virtual double et() const override final
get et
Definition: CaloCell.h:407
python.xAODType.dummy
dummy
Definition: xAODType.py:4
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
HIJetSubtractorToolBase::m_updateClusters
Gaudi::Property< bool > m_updateClusters
Definition: HIJetSubtractorToolBase.h:48
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
CxxUtils::prefetchNext
void prefetchNext(Iter iter, Iter endIter)
Prefetch next object in sequence.
Definition: prefetch.h:130
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
VP1PartSpect::E
@ E
Definition: VP1PartSpectFlags.h:21
HIJetSubtractorToolBase::minEnergySigForMoments
float minEnergySigForMoments() const
Definition: HIJetSubtractorToolBase.h:31
python.PyAthena.v
v
Definition: PyAthena.py:157
a
TList * a
Definition: liststreamerinfos.cxx:10
h
CaloDetDescrElement::getSampling
CaloCell_ID::CaloSample getSampling() const
cell sampling
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:395
HIJetRec::unsubtractedClusterState
constexpr xAOD::CaloCluster::State unsubtractedClusterState()
Definition: HIJetRecDefs.h:25
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
HIJetSubtractorToolBase::setSubtractedEtaPhi
void setSubtractedEtaPhi(float E, float &eta, float &phi, float eta0, float phi0, float sig) const
Definition: HIJetSubtractorToolBase.cxx:24
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
DataVector::at
const T * at(size_type n) const
Access an element, as an rvalue.
drawFromPickle.sin
sin
Definition: drawFromPickle.py:36
area
double area(double R)
Definition: ConvertStaveServices.cxx:42
SG::DataProxy
Definition: DataProxy.h:44
dq_make_web_display.cl
cl
print [x.__class__ for x in toList(dqregion.getSubRegions()) ]
Definition: dq_make_web_display.py:26
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
HIJetRec::setClusterP4
void setClusterP4(const xAOD::CaloCluster::FourMom_t &p, xAOD::CaloCluster *cl, xAOD::CaloCluster::State s)
Definition: HIJetRecDefs.h:36
HIJetSubtractorToolBase::setShape
void setShape(const xAOD::HIEventShapeContainer *s)
Definition: HIJetSubtractorToolBase.h:38
checkFileSG.ind
list ind
Definition: checkFileSG.py:118
fitman.rho
rho
Definition: fitman.py:532
fitman.k
k
Definition: fitman.py:528
HIJetSubtractorToolBase::m_index
const HIEventShapeIndex * m_index
Definition: HIJetSubtractorToolBase.h:52