JetModifier that actual does the background subtraction. This tool is the most important one applied to HI jets! More...

#include <HIJetConstituentSubtractionTool.h>

Inheritance diagram for HIJetConstituentSubtractionTool:

Collaboration diagram for HIJetConstituentSubtractionTool:

Public Member Functions
	HIJetConstituentSubtractionTool (const std::string &t)

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

virtual StatusCode	modify (xAOD::JetContainer &jets) const override
	Implementing abstract methods from base. More...

virtual int	modifyJet (xAOD::Jet &) const override
	Implementing abstract methods from base, not used. 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
SG::ReadHandleKey< xAOD::HIEventShapeContainer >	EventShapeKey ()
	Protected set/get functions provide access to private data members in derived classes. More...

const std::string &	momentName () const

bool	momentOnly () const

void	setEventShapeKey (const SG::ReadHandleKey< xAOD::HIEventShapeContainer > &key)

void	setMomentName (const std::string &key)

void	setMomentOnly (bool x)

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

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	ASG_TOOL_CLASS0 (HIJetConstituentSubtractionTool)

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

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

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

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

Private Attributes
SG::ReadHandleKey< xAOD::HIEventShapeContainer >	m_eventShapeKey { this, "EventShapeKey", "", "The input HI Event Shape"}
	Name of HIEventShapeContainer. More...

Gaudi::Property< std::string >	m_momentName { this, "MomentName", HIJetRec::subtractedJetState(), "Subtracted Jet Kineamtics are stored using this string like a signal/state moment" }
	Subtracted jet kinematics are stored using this string like a signal state/moment Jet::setJetP4 ( std::string, JetFourMom_t) not a key - but we bring it. More...

Gaudi::Property< bool >	m_momentOnly
	if this flag is set, the primary jet kinematics are also set to reflect this subtraction eventually do this w/ a signal state More...

ToolHandle< IHISubtractorTool >	m_subtractorTool { this, "Subtractor", "HIJetClusterSubtractorTool", "" }
	handle to IHISubtractorTool that determines the subtracted kinematics for each constituent More...

ToolHandle< IHIUEModulatorTool >	m_modulatorTool { this, "Modulator" , "HIUEModulatorTool ", "" }

ToolHandle< IHIEventShapeMapTool >	m_eventShapeMapTool { this, "EventShapeMapTool", "HIEventShapeMapTool", "Handle to Event Shape Map Tool"}

Gaudi::Property< bool >	m_originCorrection { this, "ApplyOriginCorrection", false, "Apply Origin Correction boolean switch"}

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

JetModifier that actual does the background subtraction. This tool is the most important one applied to HI jets!

Author: Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch

Date: Jan, 2015

Given an HIEventShapeContainer and subtractor tool it gets the subtracted kinematics for each constituent in a jet. The details of how the subtraction actually happens, e.g. navigating back to cells, is encapsulated in the subtractor tool.

Forseen that this may serve as a base class, thus private members have protected set/get functions. Initialization of these members is unambiguous as it is done by the base class.

Definition at line 43 of file HIJetConstituentSubtractionTool.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

◆ HIJetConstituentSubtractionTool()

HIJetConstituentSubtractionTool::HIJetConstituentSubtractionTool ( const std::string & t )

Definition at line 17 of file HIJetConstituentSubtractionTool.cxx.

   :  JetModifierBase(n)
 {
 }

Member Function Documentation

◆ ASG_TOOL_CLASS0()

HIJetConstituentSubtractionTool::ASG_TOOL_CLASS0 ( HIJetConstituentSubtractionTool )

private

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

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

◆ EventShapeKey()

SG::ReadHandleKey< xAOD::HIEventShapeContainer > HIJetConstituentSubtractionTool::EventShapeKey ( )

inlineprotected

Protected set/get functions provide access to private data members in derived classes.

Definition at line 90 of file HIJetConstituentSubtractionTool.h.

90 { return m_eventShapeKey; };

◆ 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

◆ 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 HIJetConstituentSubtractionTool::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 23 of file HIJetConstituentSubtractionTool.cxx.

 {
    ATH_MSG_VERBOSE("HIJetConstituentSubtractionTool initialize");
    ATH_CHECK( m_eventShapeKey.initialize( !m_eventShapeKey.key().empty()) );
    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()

StatusCode HIJetConstituentSubtractionTool::modify ( xAOD::JetContainer & jets ) const

overridevirtual

Implementing abstract methods from base.

Reimplemented from JetModifierBase.

Definition at line 33 of file HIJetConstituentSubtractionTool.cxx.

 {
   float E_min=m_subtractorTool->minEnergyForMoments();
   //const jet::cellset_t & badcells = badCellMap.cells() ;
  
   //retrieve UE
   //Introduction of a read handle for the HIShapeContainer
   SG::ReadHandle<xAOD::HIEventShapeContainer>  readHandleEvtShape ( m_eventShapeKey );
  
   const xAOD::HIEventShapeContainer* shape=nullptr;
   const HIEventShapeIndex* es_index=nullptr;
   if(m_eventShapeKey.key().compare("") != 0)
   {
     if (!readHandleEvtShape.isValid())
     {
       ATH_MSG_ERROR("Could not retrieve input HIEventShape " << m_eventShapeKey.key() );
       return StatusCode::FAILURE;
     }
     shape = readHandleEvtShape.get();
     es_index=m_eventShapeMapTool->getIndexFromShape(shape); 
     if(es_index==nullptr)
     {
       ATH_MSG_ERROR("No HIEventShapeIndex w/ name " << m_eventShapeKey.key());
       return StatusCode::FAILURE;
     }
   }
  
   const xAOD::HIEventShape* eshape = nullptr;
   if(m_modulatorTool->getShape(eshape).isFailure())
   {
     ATH_MSG_ERROR("Could not retrieve output shape w/ modulator tool");
     return StatusCode::FAILURE;
   }
  
   for ( xAOD::JetContainer::iterator ijet=jets.begin(); ijet!=jets.end(); ++ijet)
   {
  
     xAOD::IParticle::FourMom_t p4_cl;
     xAOD::IParticle::FourMom_t p4_subtr;
     xAOD::IParticle::FourMom_t p4_unsubtr;
     const xAOD::JetConstituentVector constituents = (*ijet)->getConstituents();
     for (const auto* constituent : constituents)
     {
       m_subtractorTool->subtract(p4_cl,constituent->rawConstituent(),shape,es_index,m_modulatorTool, eshape); //modifies p4_cl to be constituent 4-vector AFTER subtraction
       p4_subtr+=p4_cl;
  
       if( msgLvl(MSG::DEBUG) )
       {
         const xAOD::CaloCluster* cl=static_cast<const xAOD::CaloCluster*>(constituent->rawConstituent());
         //here we can still keep cl->p4 because it's taking the unsubtracted state - moreover is debug
         p4_unsubtr+=cl->p4(HIJetRec::unsubtractedClusterState());
       }
     }
  
     ATH_MSG_DEBUG("Subtracting"
           << std::setw(12) << "Before:"
           << std::setw(10) << std::setprecision(3) << p4_unsubtr.Pt()*1e-3
           << std::setw(10) << std::setprecision(3) << p4_unsubtr.Eta()
           << std::setw(10) << std::setprecision(3) << p4_unsubtr.Phi()
           << std::setw(10) << std::setprecision(3) << p4_unsubtr.E()*1e-3
           << std::setw(10) << std::setprecision(3) << p4_unsubtr.M()*1e-3
           << std::setw(12) << "After:"
           << std::setw(10) << std::setprecision(3) << p4_subtr.Pt()*1e-3
           << std::setw(10) << std::setprecision(3) << p4_subtr.Eta()
           << std::setw(10) << std::setprecision(3) << p4_subtr.Phi()
           << std::setw(10) << std::setprecision(3) << p4_subtr.E()*1e-3
           << std::setw(10) << std::setprecision(3) << p4_subtr.M()*1e-3);
  
     xAOD::JetFourMom_t jet4vec;
     //if entire jet has negative E, do no subtraction but set to ghost scale
     //prevents cases with large cancellations with small E but pT non-trivial
     if(p4_subtr.E()/std::cosh(p4_subtr.Eta()) < E_min)
     {
       p4_subtr=p4_unsubtr;
       p4_subtr*=1e-7;//ghost scale
     }
     jet4vec.SetCoordinates(p4_subtr.Pt(),p4_subtr.Eta(),p4_subtr.Phi(),p4_subtr.M());
  
     (*ijet)->setJetP4(momentName(),jet4vec);
  
     if(!momentOnly())
     {
       //hack for now to allow use of pp calib tool skipping pileup subtraction
       //can be skipped in future if custom HI calibration configuration file exists
       (*ijet)->setJetP4("JetPileupScaleMomentum", jet4vec );
       (*ijet)->setJetP4(xAOD::JetEMScaleMomentum, jet4vec);
  
       (*ijet)->setConstituentsSignalState(HIJetRec::subtractedConstitState());
     }
   }
  
     return StatusCode::SUCCESS;
 }

◆ modifyJet()

virtual int HIJetConstituentSubtractionTool::modifyJet ( xAOD::Jet & ) const

inlineoverridevirtual

Implementing abstract methods from base, not used.

Reimplemented from JetModifierBase.

Definition at line 58 of file HIJetConstituentSubtractionTool.h.

58 {return 1;};

◆ momentName()

const std::string& HIJetConstituentSubtractionTool::momentName ( ) const

inlineprotected

Definition at line 93 of file HIJetConstituentSubtractionTool.h.

93 { return m_momentName; };

◆ momentOnly()

bool HIJetConstituentSubtractionTool::momentOnly ( ) const

inlineprotected

Definition at line 94 of file HIJetConstituentSubtractionTool.h.

94 { return m_momentOnly; };

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

◆ setEventShapeKey()

void HIJetConstituentSubtractionTool::setEventShapeKey ( const SG::ReadHandleKey< xAOD::HIEventShapeContainer > & key )

inlineprotected

Definition at line 96 of file HIJetConstituentSubtractionTool.h.

96 { m_eventShapeKey=key; };

◆ setMomentName()

void HIJetConstituentSubtractionTool::setMomentName ( const std::string & key )

inlineprotected

Definition at line 97 of file HIJetConstituentSubtractionTool.h.

97 { m_momentName=key; };

◆ setMomentOnly()

void HIJetConstituentSubtractionTool::setMomentOnly ( bool x )

inlineprotected

Definition at line 98 of file HIJetConstituentSubtractionTool.h.

98 { m_momentOnly=x; };

◆ 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_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_eventShapeKey

SG::ReadHandleKey< xAOD::HIEventShapeContainer > HIJetConstituentSubtractionTool::m_eventShapeKey { this, "EventShapeKey", "", "The input HI Event Shape"}

private

Name of HIEventShapeContainer.

Definition at line 64 of file HIJetConstituentSubtractionTool.h.

◆ m_eventShapeMapTool

ToolHandle<IHIEventShapeMapTool> HIJetConstituentSubtractionTool::m_eventShapeMapTool { this, "EventShapeMapTool", "HIEventShapeMapTool", "Handle to Event Shape Map Tool"}

private

Definition at line 83 of file HIJetConstituentSubtractionTool.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_modulatorTool

ToolHandle<IHIUEModulatorTool> HIJetConstituentSubtractionTool::m_modulatorTool { this, "Modulator" , "HIUEModulatorTool ", "" }

private

Definition at line 82 of file HIJetConstituentSubtractionTool.h.

◆ m_momentName

Gaudi::Property< std::string > HIJetConstituentSubtractionTool::m_momentName { this, "MomentName", HIJetRec::subtractedJetState(), "Subtracted Jet Kineamtics are stored using this string like a signal/state moment" }

private

Subtracted jet kinematics are stored using this string like a signal state/moment Jet::setJetP4 ( std::string, JetFourMom_t) not a key - but we bring it.

Definition at line 72 of file HIJetConstituentSubtractionTool.h.

◆ m_momentOnly

Gaudi::Property< bool > HIJetConstituentSubtractionTool::m_momentOnly

private

Initial value:

{ this, "SetMomentOnly", true,

"If this flag is set, the primary jet kinematics are also set to reflect this subtraction eventually do this w/ a signal state" }

if this flag is set, the primary jet kinematics are also set to reflect this subtraction eventually do this w/ a signal state

Definition at line 77 of file HIJetConstituentSubtractionTool.h.

◆ m_originCorrection

Gaudi::Property< bool > HIJetConstituentSubtractionTool::m_originCorrection { this, "ApplyOriginCorrection", false, "Apply Origin Correction boolean switch"}

private

Definition at line 85 of file HIJetConstituentSubtractionTool.h.

◆ m_subtractorTool

ToolHandle<IHISubtractorTool> HIJetConstituentSubtractionTool::m_subtractorTool { this, "Subtractor", "HIJetClusterSubtractorTool", "" }

private

handle to IHISubtractorTool that determines the subtracted kinematics for each constituent

Definition at line 81 of file HIJetConstituentSubtractionTool.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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ HIJetConstituentSubtractionTool()

Member Function Documentation

◆ ASG_TOOL_CLASS0()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ EventShapeKey()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ modifyJet()

◆ momentName()

◆ momentOnly()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setEventShapeKey()

◆ setMomentName()

◆ setMomentOnly()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_eventShapeKey

◆ m_eventShapeMapTool

◆ m_evtStore

◆ m_modulatorTool

◆ m_momentName

◆ m_momentOnly

◆ m_originCorrection

◆ m_subtractorTool

◆ m_varHandleArraysDeclared

◆ m_vhka