Tool to fill basic information about truth jets, establishing track-to-jet association indices with the truth ntuple tree. More...

#include <JetTruthNtupleTool.h>

Inheritance diagram for Trk::JetTruthNtupleTool:

Collaboration diagram for Trk::JetTruthNtupleTool:

Public Member Functions
	JetTruthNtupleTool (const std::string &, const std::string &, const IInterface *)
	~JetTruthNtupleTool ()
StatusCode	initialize ()
StatusCode	finalize ()
	finalize
virtual StatusCode	writeJetTruthData (const std::vector< Trk::GenParticleJet > &, const int &)
	fill ntuple data for a given vector of truth jets
virtual unsigned int	getNumberOfTreeRecords () const
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 ()
	Interface ID, declared here, and defined below.

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
std::string	m_ntupleTreeName
	jobOption: Ntuple tree name
std::string	m_ntupleFileName
	jobOption: Ntuple file and dir name
std::vector< double >	m_etaBins
TTree *	m_nt
	Pointer to the NTuple tree.
unsigned int	m_numberOfTreeEntries
int	m_runNumber
int	m_eventNumber
std::vector< unsigned int > *	m_genParticleLinkIndex
std::vector< float > *	m_mc_trackToJetAngle
float	m_mc_jetMultiplicity
float	m_mc_jetSphericity
float	m_mc_jetThrust
float	m_mc_jetEnergy
float	m_mc_jetMomentum
SG::ReadHandleKey< xAOD::EventInfo >	m_evt {this, "EvtInfo", "EventInfo", "EventInfo name"}
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

Tool to fill basic information about truth jets, establishing track-to-jet association indices with the truth ntuple tree.

Author: Sebastian.Fleischmann -at- cern.ch, Wolfgang.Liebig -at- cern.ch

Definition at line 37 of file JetTruthNtupleTool.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

◆ JetTruthNtupleTool()

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

Definition at line 28 of file JetTruthNtupleTool.cxx.

        :
        AthAlgTool(t,n,p),
        m_nt(nullptr),
        m_numberOfTreeEntries(0),
        m_runNumber{},
        m_eventNumber{},
        m_genParticleLinkIndex(nullptr),
        m_mc_trackToJetAngle(nullptr),
        m_mc_jetMultiplicity{},
        m_mc_jetSphericity{},
        m_mc_jetThrust{},
        m_mc_jetEnergy{},
        m_mc_jetMomentum{}
{
    declareInterface<IJetTruthNtupleTool>(this);
 
    // Declare the properties
    declareProperty("NtupleFileName",               m_ntupleFileName = "TRKVAL/Validation","Ntuple file handle");
    declareProperty("NtupleTreeName",               m_ntupleTreeName = "TruthJets",        "Name of the ntuple tree");
}

◆ ~JetTruthNtupleTool()

Trk::JetTruthNtupleTool::~JetTruthNtupleTool ( )

default

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

◆ 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::JetTruthNtupleTool::finalize ( )

finalize

Definition at line 100 of file JetTruthNtupleTool.cxx.

                                           {
 
  ATH_MSG_INFO ( "finalize() in " << name() );
  delete m_genParticleLinkIndex;
  delete m_mc_trackToJetAngle;
 
  return StatusCode::SUCCESS;
}

◆ getNumberOfTreeRecords()

unsigned int Trk::JetTruthNtupleTool::getNumberOfTreeRecords ( ) const

virtual

Implements Trk::IJetTruthNtupleTool.

Definition at line 162 of file JetTruthNtupleTool.cxx.

                                                                 {
    return m_numberOfTreeEntries;
}

◆ initialize()

StatusCode Trk::JetTruthNtupleTool::initialize ( )

Definition at line 57 of file JetTruthNtupleTool.cxx.

                                             {
 
  ATH_CHECK( m_evt.initialize() );
 
    // ---------------------------
    // retrieve pointer to THistSvc
    SmartIF<ITHistSvc> tHistSvc{service("THistSvc")};
    ATH_CHECK( tHistSvc.isValid() );
 
    // ---------------------------
    // create tree and register it to THistSvc
    m_nt = new TTree(TString(m_ntupleTreeName), "Track Validation JetTruth");
    // NB: we must not delete the tree, this is done by THistSvc
    std::string fullNtupleName =  "/"+m_ntupleFileName+"/"+m_ntupleTreeName;
    ATH_CHECK( tHistSvc->regTree(fullNtupleName, m_nt) );
 
    //-----------------
    // add items
    // event info:
    m_nt->Branch("RunNumber",           &m_runNumber                );            // Run number
    m_nt->Branch("EventNumber",         &m_eventNumber              );          // Event number
 
    m_nt->Branch( "truth_jetMultiplicity",    &m_mc_jetMultiplicity );
    m_nt->Branch( "truth_jetSphericity",      &m_mc_jetSphericity   );
    m_nt->Branch( "truth_jetThrust",          &m_mc_jetThrust       );
    m_nt->Branch( "truth_jetEnergy",          &m_mc_jetEnergy       );
    m_nt->Branch( "truth_jetMomentum",        &m_mc_jetMomentum     );
 
    m_genParticleLinkIndex    = new std::vector<unsigned int>();
    m_nt->Branch( "GenParticleLinkIndex",     &m_genParticleLinkIndex);// link to particles
    m_mc_trackToJetAngle      = new std::vector<float>();
    m_nt->Branch( "truth_trackToJetAngle",    &m_mc_trackToJetAngle); // truth_trackToJetAngle
 
    ATH_MSG_VERBOSE ( "added items to ntuple" );
 
    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::IJetTruthNtupleTool::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 47 of file IJetTruthNtupleTool.h.

                                                              {
    return IID_IJetTruthNtupleTool;
}

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

◆ writeJetTruthData()

StatusCode Trk::JetTruthNtupleTool::writeJetTruthData	(	const std::vector< Trk::GenParticleJet > &	jets,
		const int &	nTruthRecordsAtCurrentEvent )

virtual

fill ntuple data for a given vector of truth jets

write track data to ntuple

Implements Trk::IJetTruthNtupleTool.

Definition at line 112 of file JetTruthNtupleTool.cxx.

                  {
  ATH_MSG_VERBOSE ( "in writeJetTruthData(...)" );
 
  // ---------------------------------------
  // fill event data
  SG::ReadHandle<xAOD::EventInfo> evt(m_evt);
  if (!evt.isValid()) {
    ATH_MSG_WARNING ( "Could not retrieve event info" );
    return StatusCode::FAILURE;
  }
  m_runNumber=evt->runNumber();
  m_eventNumber=evt->eventNumber();
 
  for (std::vector<Trk::GenParticleJet>::const_iterator itJet = jets.begin();
       itJet < jets.end(); ++itJet ) {
    
    m_mc_jetMultiplicity = itJet->getNumParticles();
    m_mc_jetMomentum     = itJet->getMomentum().mag();
    m_mc_jetEnergy       = itJet->getEnergy();
    m_mc_jetSphericity   = itJet->getSphericity();
    m_mc_jetThrust       = itJet->getThrust();
 
    auto particles = itJet->getParticles();
    m_mc_trackToJetAngle->reserve(particles.size());
    m_genParticleLinkIndex->reserve(particles.size());
    std::vector<int> indices         = itJet->getIndicesInEvent();
    std::vector<int>::iterator itIdx = indices.begin();
    m_genParticleLinkIndex->clear();
    m_mc_trackToJetAngle->clear();
    for (auto itPrt = particles.begin();
         itPrt < particles.end(); ++itPrt, ++itIdx) {
      
      HepGeom::Vector3D<double> tempMomentum((*itPrt)->momentum().px(),
                               (*itPrt)->momentum().py(),
                               (*itPrt)->momentum().pz());
      // attention: push_back calls need a clear() to avoid growth with each entry
      m_mc_trackToJetAngle->push_back((float)tempMomentum.angle(itJet->getMomentum()));
      m_genParticleLinkIndex->push_back(nTruthRecordsAtCurrentEvent+1+(unsigned int)(*itIdx));
    }
    m_nt->Fill();
    m_numberOfTreeEntries++;
  }
  return StatusCode::SUCCESS;
}

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_etaBins

std::vector<double> Trk::JetTruthNtupleTool::m_etaBins

private

Definition at line 59 of file JetTruthNtupleTool.h.

◆ m_eventNumber

int Trk::JetTruthNtupleTool::m_eventNumber

private

Definition at line 67 of file JetTruthNtupleTool.h.

◆ m_evt

SG::ReadHandleKey<xAOD::EventInfo> Trk::JetTruthNtupleTool::m_evt {this, "EvtInfo", "EventInfo", "EventInfo name"}

private

Definition at line 78 of file JetTruthNtupleTool.h.

78{this, "EvtInfo", "EventInfo", "EventInfo name"};

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

std::vector<unsigned int>* Trk::JetTruthNtupleTool::m_genParticleLinkIndex

private

Definition at line 70 of file JetTruthNtupleTool.h.

◆ m_mc_jetEnergy

float Trk::JetTruthNtupleTool::m_mc_jetEnergy

private

Definition at line 75 of file JetTruthNtupleTool.h.

◆ m_mc_jetMomentum

float Trk::JetTruthNtupleTool::m_mc_jetMomentum

private

Definition at line 76 of file JetTruthNtupleTool.h.

◆ m_mc_jetMultiplicity

float Trk::JetTruthNtupleTool::m_mc_jetMultiplicity

private

Definition at line 72 of file JetTruthNtupleTool.h.

◆ m_mc_jetSphericity

float Trk::JetTruthNtupleTool::m_mc_jetSphericity

private

Definition at line 73 of file JetTruthNtupleTool.h.

◆ m_mc_jetThrust

float Trk::JetTruthNtupleTool::m_mc_jetThrust

private

Definition at line 74 of file JetTruthNtupleTool.h.

◆ m_mc_trackToJetAngle

std::vector<float>* Trk::JetTruthNtupleTool::m_mc_trackToJetAngle

private

Definition at line 71 of file JetTruthNtupleTool.h.

◆ m_nt

TTree* Trk::JetTruthNtupleTool::m_nt

private

Pointer to the NTuple tree.

Definition at line 61 of file JetTruthNtupleTool.h.

◆ m_ntupleFileName

std::string Trk::JetTruthNtupleTool::m_ntupleFileName

private

jobOption: Ntuple file and dir name

Definition at line 58 of file JetTruthNtupleTool.h.

◆ m_ntupleTreeName

std::string Trk::JetTruthNtupleTool::m_ntupleTreeName

private

jobOption: Ntuple tree name

Definition at line 57 of file JetTruthNtupleTool.h.

◆ m_numberOfTreeEntries

unsigned int Trk::JetTruthNtupleTool::m_numberOfTreeEntries

private

Definition at line 63 of file JetTruthNtupleTool.h.

◆ m_runNumber

int Trk::JetTruthNtupleTool::m_runNumber

private

Definition at line 66 of file JetTruthNtupleTool.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetTruthNtupleTool()

◆ ~JetTruthNtupleTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getNumberOfTreeRecords()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ writeJetTruthData()

Member Data Documentation

◆ m_detStore

◆ m_etaBins

◆ m_eventNumber

◆ m_evt

◆ m_evtStore

◆ m_genParticleLinkIndex

◆ m_mc_jetEnergy

◆ m_mc_jetMomentum

◆ m_mc_jetMultiplicity

◆ m_mc_jetSphericity

◆ m_mc_jetThrust

◆ m_mc_trackToJetAngle

◆ m_nt

◆ m_ntupleFileName

◆ m_ntupleTreeName

◆ m_numberOfTreeEntries

◆ m_runNumber

◆ m_varHandleArraysDeclared

◆ m_vhka