#include <JetRestrictedSumPtVertexWeightCalculator.h>

Inheritance diagram for Trk::JetRestrictedSumPtVertexWeightCalculator:

Collaboration diagram for Trk::JetRestrictedSumPtVertexWeightCalculator:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
	JetRestrictedSumPtVertexWeightCalculator (const std::string &t, const std::string &n, const IInterface *p)
	constructor
virtual	~JetRestrictedSumPtVertexWeightCalculator ()=default
	destructor
virtual double	estimateSignalCompatibility (const xAOD::Vertex &vertex) const override final
	WeightCalculator.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< bool >	m_doSumPt2Selection { this, "DoSumPt2Selection", true }
	Flag to Set SumPt^2 not SumPt as selection criteria.
Gaudi::Property< float >	m_cone_dR { this, "JetConeDeltaR", 0.4 }
Gaudi::Property< float >	m_jet_ptmin { this, "JetMinPt", 20e3 }
ToolHandle< xAOD::ITrackParticlesInConeTool >	m_tracksInCone { this, "TracksInConeTool", "xAOD::TrackParticlesInConeTool/TrackParticlesInConeTool" }
SG::ReadHandleKey< xAOD::JetContainer >	m_jetContKey { this, "JetContainer", "AntiKt4EMTopoJets", "Name of the jet container" }
Gaudi::Property< std::string >	m_plainSumPtKey { this, "PlainSumPtDecor", "", "Optional decoration name holding the unrestricted vertex sumpt" }
std::unique_ptr< SG::AuxElement::Decorator< float > >	m_decPlainSumPt
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Author: Teng Jian Khoo, July 2024

Definition at line 31 of file JetRestrictedSumPtVertexWeightCalculator.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

◆ JetRestrictedSumPtVertexWeightCalculator()

Trk::JetRestrictedSumPtVertexWeightCalculator::JetRestrictedSumPtVertexWeightCalculator	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

constructor

Definition at line 45 of file JetRestrictedSumPtVertexWeightCalculator.cxx.

  : AthAlgTool(t, n, p)
{
  declareInterface<IVertexWeightCalculator>(this);
}

◆ ~JetRestrictedSumPtVertexWeightCalculator()

virtual Trk::JetRestrictedSumPtVertexWeightCalculator::~JetRestrictedSumPtVertexWeightCalculator ( )

virtualdefault

destructor

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ estimateSignalCompatibility()

double Trk::JetRestrictedSumPtVertexWeightCalculator::estimateSignalCompatibility ( const xAOD::Vertex & vertex ) const

finaloverridevirtual

WeightCalculator.

Implements Trk::IVertexWeightCalculator.

Definition at line 55 of file JetRestrictedSumPtVertexWeightCalculator.cxx.

{
  //::First get the jet containers
  SG::ReadHandle<xAOD::JetContainer> jetContHandle(m_jetContKey);
  if (!jetContHandle.isValid()){  
    ATH_MSG_ERROR ("HardScatterSelectionTool configured to use jet collection "<<m_jetContKey.key()<<", but collection is not found!"); 
  }
  const xAOD::JetContainer* jetCont{jetContHandle.cptr()};
 
  // Retrieve tracks within jet cone (cached lookup)
  // Add to a set for comparison later
  std::set<const xAOD::TrackParticle*> tracks_in_jets;
  for(const xAOD::Jet* jet : *jetCont) {
    std::vector<const xAOD::TrackParticle*> tracks_in_this_jet;
    m_tracksInCone->particlesInCone( jet->eta(), jet->phi(), m_cone_dR, tracks_in_this_jet );
    tracks_in_jets.insert(tracks_in_this_jet.begin(),tracks_in_this_jet.end());
  }
  ATH_MSG_VERBOSE("Collected " << tracks_in_jets.size() << " tracks in " << jetCont->size() << " jets");
 
  size_t n_selected_tracks{0};
  double total_pt{0.}, jet_only_pt{0.};
  ATH_MSG_DEBUG("Estimating vertex sorting score from "
                << vertex.nTrackParticles() << " tracks at vertex.");
  for (const auto& elTrackParticle : vertex.trackParticleLinks()) {
 
    if (not elTrackParticle.isValid()) {
      ATH_MSG_WARNING(
        "No valid link to tracks in xAOD::Vertex object. Skipping track for "
        "signal compatibility (may be serious).");
      continue;
    }
 
    const Trk::Perigee& perigee =
      (*elTrackParticle.cptr())->perigeeParameters();
    float increment = 0.;
    if (m_doSumPt2Selection) {
      increment = std::pow(1. / perigee.parameters()[Trk::qOverP] *
                             sin(perigee.parameters()[Trk::theta]) / 1000.,
                           2);
    } else {
      increment = std::fabs(1. / perigee.parameters()[Trk::qOverP]) *
                  sin(perigee.parameters()[Trk::theta]) / 1000.;
    }
    total_pt += increment;
 
    if(tracks_in_jets.contains(*elTrackParticle)) {
      ATH_MSG_VERBOSE("Accepted track with index " << (*elTrackParticle)->index() << " in jet vicinity.");
      ++n_selected_tracks;
      jet_only_pt += increment;
    }
 
  }
  ATH_MSG_DEBUG("Counted " << n_selected_tracks << "/" << vertex.nTrackParticles()
    << " towards vertex sumpt " << std::setprecision(3) << jet_only_pt << " (unrestricted sum: " << total_pt << ")");
 
  if(m_decPlainSumPt!=nullptr) {
    (*m_decPlainSumPt)(vertex) = total_pt;
  }
 
  if(jetCont->empty()){
    ATH_MSG_DEBUG("No jets found in this event, fall back to unrestricted sum");
    jet_only_pt = total_pt;
  }
  return jet_only_pt;
}

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ finalize()

StatusCode Trk::JetRestrictedSumPtVertexWeightCalculator::finalize ( )

overridevirtual

Definition at line 39 of file JetRestrictedSumPtVertexWeightCalculator.cxx.

{
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::JetRestrictedSumPtVertexWeightCalculator::initialize ( )

overridevirtual

Definition at line 20 of file JetRestrictedSumPtVertexWeightCalculator.cxx.

{
  // We definitely need a jet collection for the track selection
  if(m_jetContKey.empty()) {
    ATH_MSG_ERROR("No jet collection provided for selecting tracks!");
    return StatusCode::FAILURE;
  } else {
    ATH_CHECK(m_jetContKey.initialize());
  }
  ATH_CHECK(m_tracksInCone.retrieve());
 
  if(!m_plainSumPtKey.empty()) {
    m_decPlainSumPt = std::make_unique<SG::AuxElement::Decorator<float> >(m_plainSumPtKey);
  }
  
  return StatusCode::SUCCESS;
} // end of initialize method

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

◆ interfaceID()

const InterfaceID & Trk::IVertexWeightCalculator::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 47 of file IVertexWeightCalculator.h.

  {
    return IID_IVertexWeightCalculator;
  };

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

◆ renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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

Gaudi::Property<float> Trk::JetRestrictedSumPtVertexWeightCalculator::m_cone_dR { this, "JetConeDeltaR", 0.4 }

private

Definition at line 64 of file JetRestrictedSumPtVertexWeightCalculator.h.

64{ this, "JetConeDeltaR", 0.4 };

◆ m_decPlainSumPt

std::unique_ptr<SG::AuxElement::Decorator<float> > Trk::JetRestrictedSumPtVertexWeightCalculator::m_decPlainSumPt

private

Definition at line 69 of file JetRestrictedSumPtVertexWeightCalculator.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_doSumPt2Selection

Gaudi::Property<bool> Trk::JetRestrictedSumPtVertexWeightCalculator::m_doSumPt2Selection { this, "DoSumPt2Selection", true }

private

Flag to Set SumPt^2 not SumPt as selection criteria.

Definition at line 63 of file JetRestrictedSumPtVertexWeightCalculator.h.

63{ this, "DoSumPt2Selection", true };

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

Gaudi::Property<float> Trk::JetRestrictedSumPtVertexWeightCalculator::m_jet_ptmin { this, "JetMinPt", 20e3 }

private

Definition at line 65 of file JetRestrictedSumPtVertexWeightCalculator.h.

65{ this, "JetMinPt", 20e3 };

CheckAppliedSFs.e3

e3

Definition CheckAppliedSFs.py:264

◆ m_jetContKey

SG::ReadHandleKey<xAOD::JetContainer> Trk::JetRestrictedSumPtVertexWeightCalculator::m_jetContKey { this, "JetContainer", "AntiKt4EMTopoJets", "Name of the jet container" }

private

Definition at line 67 of file JetRestrictedSumPtVertexWeightCalculator.h.

67{ this, "JetContainer", "AntiKt4EMTopoJets", "Name of the jet container" };

◆ m_plainSumPtKey

Gaudi::Property<std::string> Trk::JetRestrictedSumPtVertexWeightCalculator::m_plainSumPtKey { this, "PlainSumPtDecor", "", "Optional decoration name holding the unrestricted vertex sumpt" }

private

Definition at line 68 of file JetRestrictedSumPtVertexWeightCalculator.h.

68{ this, "PlainSumPtDecor", "", "Optional decoration name holding the unrestricted vertex sumpt" };

◆ m_tracksInCone

ToolHandle<xAOD::ITrackParticlesInConeTool> Trk::JetRestrictedSumPtVertexWeightCalculator::m_tracksInCone { this, "TracksInConeTool", "xAOD::TrackParticlesInConeTool/TrackParticlesInConeTool" }

private

Definition at line 66 of file JetRestrictedSumPtVertexWeightCalculator.h.

66{ this, "TracksInConeTool", "xAOD::TrackParticlesInConeTool/TrackParticlesInConeTool" };

◆ 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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetRestrictedSumPtVertexWeightCalculator()

◆ ~JetRestrictedSumPtVertexWeightCalculator()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ estimateSignalCompatibility()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cone_dR

◆ m_decPlainSumPt

◆ m_detStore

◆ m_doSumPt2Selection

◆ m_evtStore

◆ m_jet_ptmin

◆ m_jetContKey

◆ m_plainSumPtKey

◆ m_tracksInCone

◆ m_varHandleArraysDeclared

◆ m_vhka