Constituent modifier implementing the Constituent Substraction technique. More...

#include <ConstituentSubtractorTool.h>

Inheritance diagram for ConstituentSubtractorTool:

Collaboration diagram for ConstituentSubtractorTool:

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

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

StatusCode	process (xAOD::IParticleContainer *cont) const override final

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
StatusCode	setEtaPhi (xAOD::IParticle *obj, float eta, float phi) const

StatusCode	setEnergyPt (xAOD::IParticle obj, float e, float pt, const SG::AuxElement::Accessor< float > weightAcc=nullptr) const

StatusCode	setP4 (xAOD::IParticle obj, const xAOD::JetFourMom_t &p4, const SG::AuxElement::Accessor< float > weightAcc=nullptr) 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
unsigned int	m_inputType =xAOD::Type::Other

bool	m_applyToChargedPFO =true

bool	m_applyToNeutralPFO =true

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	process_impl (xAOD::IParticleContainer *cont) const

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

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

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

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

Private Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_eventinfokey {"EventInfo"}
	Handle to EventInfo. This is used to get the evt&run number to set the Ghost area random seeds. More...

Gaudi::Property< float >	m_maxDeltaR = {this, "MaxDeltaR",0.25,""}

Gaudi::Property< float >	m_alpha = {this, "Alpha",0.,""}

Gaudi::Property< float >	m_ghostArea = {this, "GhostArea",0.01,""}

Gaudi::Property< float >	m_maxEta = {this, "MaxEta",5.5,""}

Gaudi::Property< float >	m_maxRapForRhoComputation = {this, "MaxRapForRhoComputation", 2.0, ""}

Gaudi::Property< float >	m_gridSize = {this, "GridSize", 0.5, ""}

Gaudi::Property< bool >	m_commonBgeForRhoAndRhom = {this, "CommonBgeForRhoAndRhom",false, ""}

Gaudi::Property< bool >	m_doRapidityRescaling = {this, "DoRapidityRescaling",false, ""}

Gaudi::Property< bool >	m_doRapidityPhiRescaling = {this, "DoRapidityPhiRescaling",false, ""}

Gaudi::Property< std::string >	m_rescalingFileName = {this, "RescalingFileName","", ""}

Gaudi::Property< std::string >	m_rescalingHistogramName = {this, "RescalingHistogramName","", ""}

Gaudi::Property< bool >	m_ignoreChargedPFOs = {this, "IgnoreChargedPFO",0.,"Option to disregard cPFOs in the weight calculation"}

std::unique_ptr< fastjet::FunctionOfPseudoJet< double > >	m_rescaling =nullptr

std::unique_ptr< TH1D >	m_hist =nullptr

std::unique_ptr< TH2D >	m_hist2D =nullptr

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

Constituent modifier implementing the Constituent Substraction technique.

Author: P-A Delsart, T.J. Khoo, others ??

Definition at line 30 of file ConstituentSubtractorTool.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

◆ ConstituentSubtractorTool()

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

Definition at line 26 of file ConstituentSubtractorTool.cxx.

26 : JetConstituentModifierBase(name) {

27 }

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

◆ 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

◆ 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 ConstituentSubtractorTool::initialize ( )

virtual

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 30 of file ConstituentSubtractorTool.cxx.

                                                  {
  
   if(m_inputType==xAOD::Type::ParticleFlow || m_inputType==xAOD::Type::FlowElement) {
     if(m_ignoreChargedPFOs && m_applyToChargedPFO) {
       ATH_MSG_ERROR("Incompatible configuration: setting both IgnoreChargedPFO and ApplyToChargedPFO to true"
             <<  "will set all cPFOs to zero");
       return StatusCode::FAILURE;
     }
     if(!m_applyToNeutralPFO) {
       ATH_MSG_ERROR("Incompatible configuration: ApplyToNeutralPFO=False -- what kind of pileup do you wish to suppress?");
       return StatusCode::FAILURE;
     }
   }
   ATH_CHECK( m_eventinfokey.initialize() );
   
  
   if(m_doRapidityRescaling && m_doRapidityPhiRescaling) {
     ATH_MSG_ERROR("Incompatible configuration: You set both, DoRapidityRescaling and DoRapidityPhiRescaling, to true. Use maximally only one of them.");
     return StatusCode::FAILURE;
   }
  
   if((m_doRapidityRescaling || m_doRapidityPhiRescaling) && (m_rescalingFileName=="" || m_rescalingHistogramName=="")) {
     ATH_MSG_ERROR("Incompatible configuration: You have chosen a background rescaling, but you have not specified the path to the file with rescaling histograms or the name of the histogram. Specify properties FileRescaling and HistogramRescaling.");
     return StatusCode::FAILURE;
   }
  
   if(m_doRapidityRescaling || m_doRapidityPhiRescaling){
     std::string fullPathToFile=PathResolverFindCalibFile(m_rescalingFileName); // returns "" if file not found
     if (fullPathToFile.empty()){
       ATH_MSG_ERROR("Incompatible configuration: The provided file for rescaling was not found using PathResolver.");
       return StatusCode::FAILURE;
     }
     std::unique_ptr<TFile> file(TFile::Open(fullPathToFile.data(), "READ"));
     if (file->IsZombie()){
       ATH_MSG_ERROR("Incompatible configuration: The file for rescaling has been tried to open, but it was found it is zombie.");
       return StatusCode::FAILURE;
     }
     std::unique_ptr<TObject> object(file->Get(m_rescalingHistogramName.value().data()));
     if (!object){
       ATH_MSG_ERROR("Incompatible configuration: The provided histogram name was not found in the root file.");
       return StatusCode::FAILURE;
     }
  
     if (m_doRapidityRescaling){
       if (object->InheritsFrom(TH1D::Class())){
         m_hist.reset(static_cast<TH1D*>(object->Clone("hist_cloned")));
         m_hist->SetDirectory(nullptr);
         m_rescaling.reset(static_cast<fastjet::FunctionOfPseudoJet<double>*>(new contrib::BackgroundRescalingYFromRoot<TH1D>(m_hist.get())));
       }
       else{
         ATH_MSG_ERROR("Incompatible configuration: You want to do rapidity rescaling, but the provided histogram name is not a TH1D.");
         return StatusCode::FAILURE;
       }
     }
     if (m_doRapidityPhiRescaling){
       if (object->InheritsFrom(TH2D::Class())){
         m_hist2D.reset(static_cast<TH2D*>(object->Clone("hist_cloned")));
         m_hist2D->SetDirectory(nullptr);
         m_rescaling.reset(static_cast<fastjet::FunctionOfPseudoJet<double>*>(new contrib::BackgroundRescalingYPhiFromRoot<TH2D>(m_hist2D.get())));
       }
       else{
         ATH_MSG_ERROR("Incompatible configuration: You want to do rapidity-phi rescaling, but the provided histogram name is not a TH2D.");
         return StatusCode::FAILURE;
       }
     }
   }
  
   
   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.

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

◆ process()

StatusCode JetConstituentModifierBase::process ( xAOD::IParticleContainer * cont ) const

finaloverridevirtualinherited

Implements IJetConstituentModifier.

Definition at line 23 of file JetConstituentModifierBase.cxx.

 {
   // Test that we are operating on the type of object that
   // we will be writing out.
   // By implication, any supporting containers should not
   // be the ones passed to this method...
   if(!cont->empty() && cont->front()->type() != m_inputType) {
     ATH_MSG_ERROR("Object type mismatch! This tool expects " << m_inputType
                << ", but received " << cont->front()->type());
     return StatusCode::FAILURE;
   }
  
   ATH_CHECK(process_impl(cont));
  
   return StatusCode::SUCCESS;
 }

◆ process_impl()

StatusCode ConstituentSubtractorTool::process_impl ( xAOD::IParticleContainer * cont ) const

privatevirtual

Reimplemented from JetConstituentModifierBase.

Definition at line 104 of file ConstituentSubtractorTool.cxx.

                                                                                      {
  
   contrib::ConstituentSubtractor subtractor;
  
   // free parameter for the maximal allowed distance sqrt((y_i-y_k)^2+(phi_i-phi_k)^2) between particle i and ghost k
   subtractor.set_max_standardDeltaR(m_maxDeltaR);
  
   // free parameter for the distance measure (the exponent of particle pt). The larger the parameter alpha, the more are favoured the lower pt particles in the subtraction process
   subtractor.set_alpha(m_alpha);
  
   // free parameter for the density of ghosts. The smaller, the better - but also the computation is slower.
   subtractor.set_ghost_area(m_ghostArea);
  
   // This is added to fix ATR-23552. It has no effect on the performance. Once the bug is fixed in fastjet-contrib, it can be removed.
   subtractor.set_use_nearby_hard(-1,-1);
  
   // prepare PseudoJet input
   std::vector<PseudoJet> inputs_to_correct, inputs_to_not_correct;
   inputs_to_correct.reserve(cont->size());
   inputs_to_not_correct.reserve(cont->size());
   size_t i =0; // Corresponds to the index in the input container
   // We don't use part->index() because it might be a view container
   // combining more than one owning container
  
   // Minimal and maximum rapidities needed for the workaround for the bug in fastjet-contrib ConstituentSubtractor, see ATLASG-1417
   double minRap=1000;
   double maxRap=-1000;
  
   for(xAOD::IParticle * part: *cont){
     // Only use positive E
     bool accept = part->e() > -1*FLT_MIN;
     // For PFlow we would only want to apply the correction to neutral PFOs,
     // because charged hadron subtraction handles the charged PFOs.
     // However, we might still want to use the cPFOs for the min pt calculation
     if(m_ignoreChargedPFOs){
       if(m_inputType==xAOD::Type::ParticleFlow){
         xAOD::PFO* pfo = static_cast<xAOD::PFO*>(part);
         accept &= fabs(pfo->charge())<FLT_MIN;
       }
       else if(m_inputType==xAOD::Type::FlowElement){
         xAOD::FlowElement* fe = static_cast<xAOD::FlowElement*>(part);
         accept &= !(fe->isCharged());
       }
     }
     if(m_inputType==xAOD::Type::TrackCaloCluster) {
       xAOD::TrackCaloCluster* tcc = static_cast<xAOD::TrackCaloCluster*>(part);
       accept &= (tcc->taste()!= 0)*(tcc->pt()>-1.*FLT_MIN);
     }
     // Reject object if outside maximum eta range
     accept &= fabs(part->eta()) <= m_maxEta;
  
     PseudoJet pj( part->p4() );
     pj.set_user_index( i );
     if(accept) {
       ATH_MSG_VERBOSE("Using " << part->type() << " with pt " << part->pt());
       inputs_to_correct.push_back(pj);
       // Minimal and maximum rapidities needed for the workaround for the bug in fastjet-contrib ConstituentSubtractor, see ATLASG-1417
       if (pj.rap()<minRap) minRap = pj.rap();
       if (pj.rap()>maxRap) maxRap = pj.rap();
     } else {
       ATH_MSG_VERBOSE("Will not correct " << part->type() << " with pt " << part->pt());
       inputs_to_not_correct.push_back(pj);
     }
  
     ++i;
   }
   
   // create what we need for the background estimation
   //----------------------------------------------------------
   // maximal rapidity is used (not pseudo-rapidity). Since the inputs are massless, it does not matter
   GridMedianBackgroundEstimator bge_rho(m_maxRapForRhoComputation, m_gridSize);
   bge_rho.set_rescaling_class(m_rescaling.get());
   bge_rho.set_particles(inputs_to_correct);
   subtractor.set_background_estimator(&bge_rho);
  
   // for massless input particles it does not make any difference (rho_m is always zero)
   
   ATH_MSG_DEBUG("Subtracting event density from constituents");
   std::vector<PseudoJet> corrected_event=subtractor.subtract_event(inputs_to_correct,m_maxEta);
  
   // Define a vector holding the corrected four-momenta for all output constituents
   // This is defaulted to zero, because fastjet will only return non-zero pseudojets
   std::vector<xAOD::JetFourMom_t> corrected_p4s(cont->size(),xAOD::JetFourMom_t(0.,0.,0.,0.));
   // Set the corrected four-vectors
   for(PseudoJet & pj : corrected_event) {
     ATH_MSG_VERBOSE("Setting four-mom for constituent " << pj.user_index() << ", pt = " << pj.pt());
     corrected_p4s[pj.user_index()].SetCoordinates(pj.pt(),pj.eta(),pj.phi(),pj.m());
   }
   for(PseudoJet & pj : inputs_to_not_correct) {
     ATH_MSG_VERBOSE("Setting four-mom for constituent " << pj.user_index() << ", pt = " << pj.pt());
     corrected_p4s[pj.user_index()].SetCoordinates(pj.pt(),pj.eta(),pj.phi(),pj.m());
   }
   for(PseudoJet & pj : inputs_to_not_correct) {
     ATH_MSG_VERBOSE("Setting four-mom for constituent " << pj.user_index() << ", pt = " << pj.pt());
     corrected_p4s[pj.user_index()].SetCoordinates(pj.pt(),pj.eta(),pj.phi(),pj.m());
   }
  
   // Set every constituent's four-vector in the output container
   i = 0; // Again, we need to track the input container index, not the owning container index
   const static SG::AuxElement::Accessor<float> weightAcc("CSWeight"); // Handle for PU weighting here
   for(xAOD::IParticle * part: *cont){
     ATH_MSG_VERBOSE("Now on constituent " << i);
     ATH_MSG_VERBOSE("Initial pt: " << part->pt() << ", subtracted pt: " << corrected_p4s[i].Pt());
     ATH_MSG_VERBOSE("Initial eta: " << part->eta() << ", subtracted pt: " << corrected_p4s[i].Eta());
     ATH_MSG_VERBOSE("Initial phi: " << part->phi() << ", subtracted pt: " << corrected_p4s[i].Phi());
     ATH_CHECK( setP4(part,corrected_p4s[i], &weightAcc) );
     ++i;
   }
  
  
  
   return StatusCode::SUCCESS;
 }

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

◆ setEnergyPt()

StatusCode JetConstituentModifierBase::setEnergyPt	(	xAOD::IParticle *	obj,
		float	e,
		float	pt,
		const SG::AuxElement::Accessor< float > *	weightAcc = `nullptr`
	)		const

protectedinherited

Definition at line 61 of file JetConstituentModifierBase.cxx.

 {
   switch(m_inputType) {
   case xAOD::Type::CaloCluster:
     {
       xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
       // Clusters get pt via the energy
       // This currently leaves the mass unaltered.
       if(weightAcc) (*weightAcc)(*clus) = clus->calE() > 0. ? e / clus->calE() : 0.;
       clus->setCalE(e);
     }
     break;
   case xAOD::Type::ParticleFlow:
     {
       xAOD::PFO* pfo = static_cast<xAOD::PFO*>(obj);
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? pt / pfo->pt() : 0.;
         // KTJ: Temporary fix
         // Defeats the purpose, but we need to use this to reset the 4-vec cache
         pfo->setP4(pt, pfo->eta(), pfo->phi());
       }
     }
     break;
   case xAOD::Type::FlowElement:
     {
       xAOD::FlowElement* pfo = static_cast<xAOD::FlowElement*>(obj);
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? pt / pfo->pt() : 0.;
         pfo->setP4(pt, pfo->eta(), pfo->phi(), 0.);
       }
     }
     break;
   case xAOD::Type::TrackCaloCluster:
     {
       xAOD::TrackCaloCluster* tcc = static_cast<xAOD::TrackCaloCluster*>(obj);
       if( tcc->taste() != 0) {
         if(weightAcc) (*weightAcc)(*tcc) = tcc->pt() > 0. ? pt / tcc->pt() : 0.;
         tcc->setParameters(pt, tcc->eta(), tcc->phi(), tcc->m(), xAOD::TrackCaloCluster::Taste(tcc->taste()), tcc->trackParticleLink(), tcc->caloClusterLinks());
       }
     }
     break;
   default:
     // Should not get here, because type-checking should happen in process()
     ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ setEtaPhi()

StatusCode JetConstituentModifierBase::setEtaPhi	(	xAOD::IParticle *	obj,
		float	eta,
		float	phi
	)		const

protectedinherited

Definition at line 41 of file JetConstituentModifierBase.cxx.

 {
   switch(m_inputType) {
     // The main (only?) application is origin-correcting LC topoclusters
     // By convention we leave the raw p4 unmodified
   case xAOD::Type::CaloCluster:
     {
       xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
       clus->setCalEta(eta);
       clus->setCalPhi(phi);
     }
     break;
   default:
     // Should not get here, because type-checking should happen in process()
     ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ setP4()

StatusCode JetConstituentModifierBase::setP4	(	xAOD::IParticle *	obj,
		const xAOD::JetFourMom_t &	p4,
		const SG::AuxElement::Accessor< float > *	weightAcc = `nullptr`
	)		const

protectedinherited

Definition at line 113 of file JetConstituentModifierBase.cxx.

                                                                                                  {
   switch(m_inputType) {
   case xAOD::Type::CaloCluster:
     {
       xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
       // This currently leaves the mass unaltered
       if(weightAcc) (*weightAcc)(*clus) = clus->calE() > 0. ? p4.e() / clus->calE() : 0.;
       clus->setCalE(p4.e());
       clus->setCalEta(p4.eta());
       clus->setCalPhi(p4.phi());
     }
     break;
   case xAOD::Type::ParticleFlow:
     {
       xAOD::PFO* pfo = static_cast<xAOD::PFO*>(obj);
       // The PFO setter defaults to m=0
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? p4.pt() / pfo->pt() : 0.;
         pfo->setP4(p4.pt(),p4.eta(),p4.phi(),p4.mass());
       }
     }
     break;
   case xAOD::Type::FlowElement:
     {
       xAOD::FlowElement* pfo = static_cast<xAOD::FlowElement*>(obj);
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? p4.pt() / pfo->pt() : 0.;
         pfo->setP4(p4.pt(),p4.eta(),p4.phi(),p4.mass());
       }
     }
     break;
   case xAOD::Type::TrackCaloCluster:
     {
       xAOD::TrackCaloCluster* tcc = static_cast<xAOD::TrackCaloCluster*>(obj);
       if( tcc->taste() != 0) {
               if(weightAcc) (*weightAcc)(*tcc) = tcc->pt() > 0. ? p4.pt() / tcc->pt() : 0.;
         tcc->setParameters(p4.pt(), p4.eta(), p4.phi(), p4.mass(), xAOD::TrackCaloCluster::Taste(tcc->taste()), tcc->trackParticleLink(), tcc->caloClusterLinks());
       }
       break;
     }
  
   default:
     // Should not get here, because type-checking should happen in process()
     ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

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

Gaudi::Property<float> ConstituentSubtractorTool::m_alpha = {this, "Alpha",0.,""}

private

Definition at line 47 of file ConstituentSubtractorTool.h.

◆ m_applyToChargedPFO

bool JetConstituentModifierBase::m_applyToChargedPFO =true

protectedinherited

Definition at line 62 of file JetConstituentModifierBase.h.

◆ m_applyToNeutralPFO

bool JetConstituentModifierBase::m_applyToNeutralPFO =true

protectedinherited

Definition at line 63 of file JetConstituentModifierBase.h.

◆ m_commonBgeForRhoAndRhom

Gaudi::Property<bool> ConstituentSubtractorTool::m_commonBgeForRhoAndRhom = {this, "CommonBgeForRhoAndRhom",false, ""}

private

Definition at line 53 of file ConstituentSubtractorTool.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_doRapidityPhiRescaling

Gaudi::Property<bool> ConstituentSubtractorTool::m_doRapidityPhiRescaling = {this, "DoRapidityPhiRescaling",false, ""}

private

Definition at line 55 of file ConstituentSubtractorTool.h.

◆ m_doRapidityRescaling

Gaudi::Property<bool> ConstituentSubtractorTool::m_doRapidityRescaling = {this, "DoRapidityRescaling",false, ""}

private

Definition at line 54 of file ConstituentSubtractorTool.h.

◆ m_eventinfokey

SG::ReadHandleKey<xAOD::EventInfo> ConstituentSubtractorTool::m_eventinfokey {"EventInfo"}

private

Handle to EventInfo. This is used to get the evt&run number to set the Ghost area random seeds.

Definition at line 44 of file ConstituentSubtractorTool.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_ghostArea

Gaudi::Property<float> ConstituentSubtractorTool::m_ghostArea = {this, "GhostArea",0.01,""}

private

Definition at line 48 of file ConstituentSubtractorTool.h.

◆ m_gridSize

Gaudi::Property<float> ConstituentSubtractorTool::m_gridSize = {this, "GridSize", 0.5, ""}

private

Definition at line 52 of file ConstituentSubtractorTool.h.

◆ m_hist

std::unique_ptr<TH1D> ConstituentSubtractorTool::m_hist =nullptr

private

Definition at line 62 of file ConstituentSubtractorTool.h.

◆ m_hist2D

std::unique_ptr<TH2D> ConstituentSubtractorTool::m_hist2D =nullptr

private

Definition at line 63 of file ConstituentSubtractorTool.h.

◆ m_ignoreChargedPFOs

Gaudi::Property<bool> ConstituentSubtractorTool::m_ignoreChargedPFOs = {this, "IgnoreChargedPFO",0.,"Option to disregard cPFOs in the weight calculation"}

private

Definition at line 59 of file ConstituentSubtractorTool.h.

◆ m_inputType

unsigned int JetConstituentModifierBase::m_inputType =xAOD::Type::Other

protectedinherited

Definition at line 60 of file JetConstituentModifierBase.h.

◆ m_maxDeltaR

Gaudi::Property<float> ConstituentSubtractorTool::m_maxDeltaR = {this, "MaxDeltaR",0.25,""}

private

Definition at line 46 of file ConstituentSubtractorTool.h.

◆ m_maxEta

Gaudi::Property<float> ConstituentSubtractorTool::m_maxEta = {this, "MaxEta",5.5,""}

private

Definition at line 49 of file ConstituentSubtractorTool.h.

◆ m_maxRapForRhoComputation

Gaudi::Property<float> ConstituentSubtractorTool::m_maxRapForRhoComputation = {this, "MaxRapForRhoComputation", 2.0, ""}

private

Definition at line 51 of file ConstituentSubtractorTool.h.

◆ m_rescaling

std::unique_ptr<fastjet::FunctionOfPseudoJet<double> > ConstituentSubtractorTool::m_rescaling =nullptr

private

Definition at line 61 of file ConstituentSubtractorTool.h.

◆ m_rescalingFileName

Gaudi::Property<std::string> ConstituentSubtractorTool::m_rescalingFileName = {this, "RescalingFileName","", ""}

private

Definition at line 56 of file ConstituentSubtractorTool.h.

◆ m_rescalingHistogramName

Gaudi::Property<std::string> ConstituentSubtractorTool::m_rescalingHistogramName = {this, "RescalingHistogramName","", ""}

private

Definition at line 57 of file ConstituentSubtractorTool.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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ConstituentSubtractorTool()

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]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ process()

◆ process_impl()

◆ renounce()

◆ renounceArray()

◆ setEnergyPt()

◆ setEtaPhi()

◆ setP4()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_alpha

◆ m_applyToChargedPFO

◆ m_applyToNeutralPFO

◆ m_commonBgeForRhoAndRhom

◆ m_detStore

◆ m_doRapidityPhiRescaling

◆ m_doRapidityRescaling

◆ m_eventinfokey

◆ m_evtStore

◆ m_ghostArea

◆ m_gridSize

◆ m_hist

◆ m_hist2D

◆ m_ignoreChargedPFOs

◆ m_inputType

◆ m_maxDeltaR

◆ m_maxEta

◆ m_maxRapForRhoComputation

◆ m_rescaling

◆ m_rescalingFileName

◆ m_rescalingHistogramName

◆ m_varHandleArraysDeclared

◆ m_vhka