BDTVertexWeightCalculator Class Reference

A tool to select the primary vertex associated to the hard-scatter using a BDT. More...

#include <BDTVertexWeightCalculator.h>

Inheritance diagram for BDTVertexWeightCalculator:

Collaboration diagram for BDTVertexWeightCalculator:

Public Member Functions
	BDTVertexWeightCalculator (const std::string &name)
virtual	~BDTVertexWeightCalculator () override
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual double	estimateSignalCompatibility (const xAOD::Vertex &vertex) const override
	Estimate the compatibility of the vertex with a hard scatter vertex, with respect to pileup vertices.
const xAOD::Vertex *	getVertex (const xAOD::VertexContainer &vertices) const
virtual void	print () const
	Print the state of the tool.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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
std::vector< float >	get_input_values (const xAOD::Vertex &vertex) const
StatusCode	initialize_BDT ()
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::VertexContainer >	m_pointingVertexContainerKey
SG::ReadDecorHandleKey< xAOD::VertexContainer >	m_nphotons_good_key
SG::ReadDecorHandleKey< xAOD::VertexContainer >	m_photons_px_key
SG::ReadDecorHandleKey< xAOD::VertexContainer >	m_photons_py_key
SG::ReadDecorHandleKey< xAOD::VertexContainer >	m_photons_pz_key
Gaudi::Property< std::string >	m_bdt_file
Gaudi::Property< std::string >	m_bdt_name
std::unique_ptr< MVAUtils::BDT >	m_bdt
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

A tool to select the primary vertex associated to the hard-scatter using a BDT.

This tool uses a BDT to select the hard-scatter vertex from a collection of primary vertices. It reads the pointing information from the pointing vertex created by BuildVertexPointingAlg.

Definition at line 33 of file BDTVertexWeightCalculator.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

BDTVertexWeightCalculator()

BDTVertexWeightCalculator::BDTVertexWeightCalculator

(

const std::string &

name

)

Definition at line 21 of file BDTVertexWeightCalculator.cxx.

    : asg::AsgTool(name) { }

~BDTVertexWeightCalculator()

BDTVertexWeightCalculator::~BDTVertexWeightCalculator ( )

overridevirtualdefault

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.

{ return m_detStore; }

estimateSignalCompatibility()

double BDTVertexWeightCalculator::estimateSignalCompatibility ( const xAOD::Vertex & vertex ) const

overridevirtual

Estimate the compatibility of the vertex with a hard scatter vertex, with respect to pileup vertices.

Implements Trk::IVertexWeightCalculator.

Definition at line 114 of file BDTVertexWeightCalculator.cxx.

                                    {
  if (vertex.vertexType() != xAOD::VxType::VertexType::PriVtx and
      vertex.vertexType() != xAOD::VxType::VertexType::PileUp) {
    return 0.;
  }
  const std::vector<float> input_values = get_input_values(vertex);
  if (input_values.empty()) { return 0.; }
  return m_bdt->GetClassification(input_values);
}

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.

{ 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

get_input_values()

std::vector< float > BDTVertexWeightCalculator::get_input_values ( const xAOD::Vertex & vertex ) const

private

Definition at line 71 of file BDTVertexWeightCalculator.cxx.

                                    {
  SG::ReadHandle<xAOD::VertexContainer> pointingVertexContainer{
      m_pointingVertexContainerKey};
  if (pointingVertexContainer->size() != 1) {
    ATH_MSG_ERROR("Pointing vertex container has size "
                  << pointingVertexContainer->size()
                  << " instead of 1");
    return {};
  }
  const xAOD::Vertex* pointingVertex = pointingVertexContainer->front();
 
  const float zcommon = pointingVertex->z();
  const float zcommon_error =
      std::sqrt(pointingVertex->covariancePosition()(2, 2));
 
  auto acc_nph_good = SG::makeHandle<unsigned int>(m_nphotons_good_key);
  const float nph_good = acc_nph_good(*pointingVertex);
  const float vtx_sumpt = xAOD::PVHelpers::getVertexSumPt(&vertex, 1);
  const float vtx_sumpt2 =xAOD::PVHelpers::getVertexSumPt(&vertex, 2);
  const float vtx_z = vertex.z();
 
  const float deltaz_sig_photons = std::abs(vtx_z - zcommon) / zcommon_error;
 
  auto acc_photons_px = SG::makeHandle<float>(m_photons_px_key);
  auto acc_photons_py = SG::makeHandle<float>(m_photons_py_key);
  auto acc_photons_pz = SG::makeHandle<float>(m_photons_pz_key);
  TVector3 photon_sump(acc_photons_px(*pointingVertex),
                       acc_photons_py(*pointingVertex),
                       acc_photons_pz(*pointingVertex));
  TLorentzVector vertex_p4 = xAOD::PVHelpers::getVertexMomentum(&vertex, true);
  const float deltaphi_sig_photons = vertex_p4.Vect().DeltaPhi(photon_sump);
 
  ATH_MSG_DEBUG("Input variables: nph_good: "
                << nph_good << ", vtx_sumpt: " << vtx_sumpt
                << ", vtx_sumpt2: " << vtx_sumpt2
                << ", deltaz_sig_photons: " << deltaz_sig_photons
                << ", deltaphi_sig_photons: " << deltaphi_sig_photons);
 
  return {nph_good, vtx_sumpt, vtx_sumpt2, deltaz_sig_photons,
          deltaphi_sig_photons};
}

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.

getVertex()

const xAOD::Vertex * BDTVertexWeightCalculator::getVertex

(

const xAOD::VertexContainer &

vertices

)

const

Definition at line 125 of file BDTVertexWeightCalculator.cxx.

                                               {
  float best_score = std::numeric_limits<float>::lowest();
  const xAOD::Vertex* vertex = nullptr;
  for (const xAOD::Vertex* v : vertices) {
    if (v == nullptr) {
      ATH_MSG_WARNING("Null vertex in container");
      continue;
    }
    if (v->vertexType() == xAOD::VxType::PriVtx) {
      static const SG::ConstAccessor<float> acc ("score");
      const float score =
        acc.isAvailable(*v) ? acc(*v) : estimateSignalCompatibility(*v);
      if (score > best_score) {
        best_score = score;
        vertex = v;
      }
    }
  }
  if (vertex == nullptr) {
     ATH_MSG_WARNING("No vertex found");
  }
  return vertex;
}

initialize()

StatusCode BDTVertexWeightCalculator::initialize ( void )

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 26 of file BDTVertexWeightCalculator.cxx.

                                                 {
  ATH_MSG_DEBUG("Initializing " << name() << "...");
 
  ATH_CHECK(m_pointingVertexContainerKey.initialize());
  ATH_CHECK(m_nphotons_good_key.initialize());
  ATH_CHECK(m_photons_px_key.initialize());
  ATH_CHECK(m_photons_py_key.initialize());
  ATH_CHECK(m_photons_pz_key.initialize());
 
  ATH_CHECK(initialize_BDT());
 
  return StatusCode::SUCCESS;
}

initialize_BDT()

StatusCode BDTVertexWeightCalculator::initialize_BDT ( )

private

Definition at line 40 of file BDTVertexWeightCalculator.cxx.

                                                     {
  const std::string fullPathToFile = PathResolverFindCalibFile(m_bdt_file);
  if (fullPathToFile.empty()) {
    ATH_MSG_ERROR("Can not find BDT file: '" << m_bdt_file
                                             << "'. Please check if the "
                                                "file exists.");
    return StatusCode::FAILURE;
  }
 
  std::unique_ptr<TFile> rootFile(TFile::Open(fullPathToFile.c_str(), "READ"));
  if (!rootFile) {
    ATH_MSG_ERROR("Can not open BDT file root file: '"
                  << fullPathToFile
                  << "'. Please check if the file "
                     "exists and is not corrupted.");
 
    return StatusCode::FAILURE;
  }
  std::unique_ptr<TTree> tree((TTree*)rootFile->Get(m_bdt_name.value().c_str()));
  if (!tree) {
    ATH_MSG_ERROR("Can not find BDT tree '" << m_bdt_name << "' in file: '"
                                            << fullPathToFile << "'.");
  }
 
  ATH_MSG_INFO("Loading BDT '" << m_bdt_name << "' from file: '"
                               << fullPathToFile << "'.");
  m_bdt = std::make_unique<MVAUtils::BDT>(tree.get());
 
  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.

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

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 AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

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

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

Reimplemented in 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_bdt

std::unique_ptr<MVAUtils::BDT> BDTVertexWeightCalculator::m_bdt

private

Definition at line 66 of file BDTVertexWeightCalculator.h.

m_bdt_file

Gaudi::Property<std::string> BDTVertexWeightCalculator::m_bdt_file

private

Initial value:

{this, "BDTFile", "",
                                          "BDT ROOT filename"}

Definition at line 61 of file BDTVertexWeightCalculator.h.

                                     {this, "BDTFile", "",
                                          "BDT ROOT filename"};

m_bdt_name

Gaudi::Property<std::string> BDTVertexWeightCalculator::m_bdt_name

private

Initial value:

{this, "BDTName", "BDT",
                                          "BDT tree name"}

Definition at line 63 of file BDTVertexWeightCalculator.h.

                                     {this, "BDTName", "BDT",
                                          "BDT tree name"};

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_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_nphotons_good_key

SG::ReadDecorHandleKey<xAOD::VertexContainer> BDTVertexWeightCalculator::m_nphotons_good_key

private

Initial value:

{
      this, "NGoodPhotonsKey", m_pointingVertexContainerKey, "nphotons_good"}

Definition at line 53 of file BDTVertexWeightCalculator.h.

                                                               {
      this, "NGoodPhotonsKey", m_pointingVertexContainerKey, "nphotons_good"};

m_photons_px_key

SG::ReadDecorHandleKey<xAOD::VertexContainer> BDTVertexWeightCalculator::m_photons_px_key

private

Initial value:

{
      this, "PhotonsPxKey", m_pointingVertexContainerKey, "photons_px"}

Definition at line 55 of file BDTVertexWeightCalculator.h.

                                                            {
      this, "PhotonsPxKey", m_pointingVertexContainerKey, "photons_px"};

m_photons_py_key

SG::ReadDecorHandleKey<xAOD::VertexContainer> BDTVertexWeightCalculator::m_photons_py_key

private

Initial value:

{
      this, "PhotonsPyKey", m_pointingVertexContainerKey, "photons_py"}

Definition at line 57 of file BDTVertexWeightCalculator.h.

                                                            {
      this, "PhotonsPyKey", m_pointingVertexContainerKey, "photons_py"};

m_photons_pz_key

SG::ReadDecorHandleKey<xAOD::VertexContainer> BDTVertexWeightCalculator::m_photons_pz_key

private

Initial value:

{
      this, "PhotonsPzKey", m_pointingVertexContainerKey, "photons_pz"}

Definition at line 59 of file BDTVertexWeightCalculator.h.

                                                            {
      this, "PhotonsPzKey", m_pointingVertexContainerKey, "photons_pz"};

m_pointingVertexContainerKey

SG::ReadHandleKey<xAOD::VertexContainer> BDTVertexWeightCalculator::m_pointingVertexContainerKey

private

Initial value:

{
      this, "PointingVertexContainerKey", "PhotonPointingVertices",
      "The container with the vertex build with (photon) pointing"}

Definition at line 50 of file BDTVertexWeightCalculator.h.

                                                                   {
      this, "PointingVertexContainerKey", "PhotonPointingVertices",
      "The container with the vertex build with (photon) pointing"};

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:

• BDTVertexWeightCalculator.h
• BDTVertexWeightCalculator.cxx