Trk::TruthNtupleTool Class Reference

Tool to fill basic information about the truth record. More...

#include <TruthNtupleTool.h>

Inheritance diagram for Trk::TruthNtupleTool:

Collaboration diagram for Trk::TruthNtupleTool:

Public Member Functions
	TruthNtupleTool (const std::string &, const std::string &, const IInterface *)
	~TruthNtupleTool ()
StatusCode	initialize ()
StatusCode	finalize ()
	finalize More...
virtual StatusCode	writeTruthData (const std::vector< Trk::ValidationTrackTruthData > &truthData)
	write track data to ntuple More...
virtual unsigned int	getNumberOfTreeRecords () const
virtual StatusCode	initBranches (const std::vector< const Trk::ITrackTruthClassifier * > &classifiers, bool, const std::vector< std::string > &trackCollectionNames)
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Interface ID, declared here, and defined below. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
std::string	m_ntupleTreeName
	jobOption: Ntuple tree name More...
std::string	m_ntupleFileName
	jobOption: Ntuple file and dir name More...
std::vector< double >	m_etaBins
bool	m_fillJets
	jO: jet filling, set from external call More...
ServiceHandle< ITHistSvc >	m_histSvc
TTree *	m_nt
	Pointer to the NTuple tree. More...
unsigned int	m_numberOfTreeEntries
int	m_runNumber
	run number to which this MC truth particle belongs More...
int	m_eventNumber
	event number to which this MC truth particle belongs More...
std::vector< std::vector< unsigned int > * >	m_TrackLinkIndex
std::vector< std::vector< float > * >	m_mc_prob
std::vector< unsigned int >	m_classifications
float	m_mc_d0
	d0 of MC truth particle's perigee parameters More...
float	m_mc_z0
	z of MC truth particle's perigee parameters More...
float	m_mc_phi0
	phi of MC truth particle's perigee parameters More...
float	m_mc_theta
	theta of MC truth particle's perigee parameters More...
float	m_mc_qOverP
	q/p of MC truth particle's perigee parameters More...
float	m_mc_qOverPt
	q/pT of MC truth particle's perigee parameters More...
float	m_mc_eta
	eta of MC truth particle's perigee parameters More...
int	m_mc_particleID
	PDG ID of MC truth particle. More...
int	m_mc_uniqueID
	MC truth particle's uniqueID. More...
float	m_mc_energy
	MC truth particle's energy at production vertex. More...
int	m_mc_jetLinkIndex
	link to jet this particle belongs to (if jet tree is ON) More...
float	m_mc_prodR
	Rxy of particle's production vertex. More...
float	m_mc_prodz
	z coordinate of particle's production vertex More...
std::vector< std::vector< TH1D * > >	m_recoTrackCounts
std::vector< std::vector< TH1D * > >	m_truthTrackCounts
std::vector< const Trk::ITrackTruthClassifier * >	m_trackTruthClassifiers
	the truth classifiers More...
SG::ReadHandleKey< xAOD::EventInfo >	m_evt {this, "EvtInfo", "EventInfo", "EventInfo name"}
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

Tool to fill basic information about the truth record.

It is called directly by the ntuple writer but provides information also
for particles which have failed to be reconstructed. Furthermore it manages
indices to link to ntuple entries of the associated reconstructed particles.

Author

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

Definition at line 46 of file TruthNtupleTool.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

TruthNtupleTool()

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

Definition at line 33 of file TruthNtupleTool.cxx.

        :
        AthAlgTool(t,n,p),
        m_fillJets(false),
        m_histSvc("THistSvc", n),
        m_nt(nullptr),
        m_numberOfTreeEntries(0),
        m_runNumber{},
        m_eventNumber{},        
        m_TrackLinkIndex{},
        m_mc_prob{},
        m_classifications{},
         m_mc_d0{},           
         m_mc_z0{},           
         m_mc_phi0{},         
         m_mc_theta{},        
         m_mc_qOverP{},       
         m_mc_qOverPt{},      
         m_mc_eta{},          
 
         m_mc_particleID{},   
         m_mc_uniqueID{},
         m_mc_energy{},       
         m_mc_jetLinkIndex{}, 
         m_mc_prodR{}, 
         m_mc_prodz{}
{
    declareInterface<ITruthNtupleTool>(this);
 
    m_etaBins.push_back(0.0);
    m_etaBins.push_back(0.8);
    m_etaBins.push_back(1.6);
    m_etaBins.push_back(2.5);
    // Declare the properties
    declareProperty("NtupleFileName",               m_ntupleFileName = "TRKVAL/Validation",    "Ntuple file handle");
    declareProperty("NtupleTreeName",               m_ntupleTreeName = "Truth",        "Name of the ntuple tree");
}

~TruthNtupleTool()

Trk::TruthNtupleTool::~TruthNtupleTool ( )

default

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.

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

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

{ 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

finalize()

StatusCode Trk::TruthNtupleTool::finalize

(

)

finalize

Definition at line 189 of file TruthNtupleTool.cxx.

                                        {
 
  ATH_MSG_INFO ("start finalize() in " << name());
 
    ATH_MSG_INFO ( "Efficiencies:" );
 
    //Double_t* efficiencyValues;
    for (unsigned int classifierIndex = 0; classifierIndex < m_trackTruthClassifiers.size(); ++classifierIndex ) {
        for (unsigned int clIndex = 0; clIndex < m_trackTruthClassifiers[classifierIndex]->numberOfClassifiers(); clIndex++) {
            // output:
 
          msg() << std::resetiosflags(std::ios::right) << std::setiosflags(std::ios::left) << std::setw(15) << m_trackTruthClassifiers[classifierIndex]->classificationAsString(clIndex);
          msg() << std::resetiosflags(std::ios::left)  << std::setiosflags(std::ios::right);
          for (int etaBin = 0; etaBin < m_recoTrackCounts[classifierIndex][clIndex]->GetNbinsX(); etaBin++) {
            double truth = m_truthTrackCounts[classifierIndex][clIndex]->GetBinContent(etaBin+1);
            double reco = m_recoTrackCounts[classifierIndex][clIndex]->GetBinContent(etaBin+1);
            msg() << std::resetiosflags(std::ios::fixed | std::ios::showpoint) << std::setprecision(8) << std::setw(8) << reco << "/" << std::setw(8) << truth;
            msg() << std::setiosflags(std::ios::fixed | std::ios::showpoint | std::ios::right ) << std::setw(7)
                  << " (" << std::setprecision(4) << (truth>0. ? reco/truth : 0.) << ")";
            }
            // calc efficiency:
            TGraphAsymmErrors* effPlot = new TGraphAsymmErrors(m_recoTrackCounts[classifierIndex][clIndex], m_truthTrackCounts[classifierIndex][clIndex], "");
            // add graph to ROOT file
            std::string graphName = "trackEff_" + m_trackTruthClassifiers[classifierIndex]->classificationAsString(clIndex);
            effPlot->SetNameTitle(graphName.c_str(), graphName.c_str());
            StatusCode sc = m_histSvc->regGraph("/"+m_ntupleFileName+"/"+graphName,    effPlot);
            if(sc.isFailure()){
              ATH_MSG_ERROR ("ROOT Graph registration failed");
              return sc;
            }
            msg() << "\n";
            delete m_recoTrackCounts[classifierIndex][clIndex];
            m_recoTrackCounts[classifierIndex][clIndex] = nullptr;
            delete m_truthTrackCounts[classifierIndex][clIndex];
            m_truthTrackCounts[classifierIndex][clIndex] = nullptr;
        }
    }
    msg() << endmsg;
 
    // delete track links and probs
    for (unsigned int trackColIndex = 0; trackColIndex < m_TrackLinkIndex.size(); ++trackColIndex ) {
      delete m_TrackLinkIndex[trackColIndex];
      delete m_mc_prob[trackColIndex];
    }
    return StatusCode::SUCCESS;
}

getNumberOfTreeRecords()

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

virtual

Implements Trk::ITruthNtupleTool.

Definition at line 325 of file TruthNtupleTool.cxx.

                                                              {
    return m_numberOfTreeEntries;
}

initBranches()

StatusCode Trk::TruthNtupleTool::initBranches ( const std::vector< const Trk::ITrackTruthClassifier * > &  classifiers, bool  fillJets, const std::vector< std::string > &  trackCollectionNames  )

virtual

Implements Trk::ITruthNtupleTool.

Definition at line 125 of file TruthNtupleTool.cxx.

                                                                                                                                                                           {
    m_trackTruthClassifiers = classifiers;
    m_classifications.resize(classifiers.size(), 0);
    m_recoTrackCounts.resize(classifiers.size());
    m_truthTrackCounts.resize(classifiers.size());
    m_fillJets = fillJets;
 
    if (m_fillJets) 
      m_nt->Branch("JetLinkIndex", &m_mc_jetLinkIndex );// link to MC jets
 
    double etaBins[100];
    for (unsigned int bin = 0; bin < m_etaBins.size(); ++bin ) {
        etaBins[bin] = m_etaBins[bin];
    }
    for (unsigned int classifierIndex = 0; classifierIndex < classifiers.size(); ++classifierIndex ) {
        if (!(classifiers[classifierIndex])) {
          ATH_MSG_ERROR ("Got NULL pointer to truth classifier tool!");
          return StatusCode::FAILURE;
        }
        std::string classifierName = classifiers[classifierIndex]->nameOfClassifier();
        // add branch for classifier
        ATH_MSG_INFO ("using classifier " << classifierName);
        std::string branchName = "Class_" + classifierName;
        std::string branchDescription = "Class_" + classifierName + "/I";
        m_nt->Branch(branchName.c_str(), &(m_classifications[classifierIndex]), branchDescription.c_str());
        // init statistic counters
        for (unsigned int clIndex = 0; clIndex < classifiers[classifierIndex]->numberOfClassifiers(); clIndex++) {
            m_truthTrackCounts[classifierIndex].push_back( new TH1D(
                ("true"+classifiers[classifierIndex]->classificationAsString(clIndex)).c_str(),
                ("true"+classifiers[classifierIndex]->classificationAsString(clIndex)).c_str(),
                m_etaBins.size()-1,
                etaBins
            ) );
            // TODO: do statistics for each input track collection
            m_recoTrackCounts[classifierIndex].push_back( new TH1D(
                ("reco"+classifiers[classifierIndex]->classificationAsString(clIndex)).c_str(),
                ("reco"+classifiers[classifierIndex]->classificationAsString(clIndex)).c_str(),
                m_etaBins.size()-1,
                etaBins
            ) );
        }
    }
 
    // add branches with links to the reconstructed tracks:
    if (!m_TrackLinkIndex.empty()) {
      ATH_MSG_ERROR ("Track links seem to be already initialized! Do NOT call initBranches() twice!");
      return StatusCode::FAILURE;
    }
    m_TrackLinkIndex.resize(trackCollectionNames.size(), nullptr);
    m_mc_prob.resize(trackCollectionNames.size(), nullptr);
    for (unsigned int trackColIndex = 0; trackColIndex < trackCollectionNames.size(); ++trackColIndex ) {
        m_TrackLinkIndex[trackColIndex] = new std::vector<unsigned int>();
        std::string branchName = "TrackLinkIndex_" + trackCollectionNames[trackColIndex];
        m_nt->Branch(branchName.c_str(),  &(m_TrackLinkIndex[trackColIndex]));       // link to tracks
        m_mc_prob[trackColIndex]        = new std::vector<float>();
        branchName = "truth_prob_" + trackCollectionNames[trackColIndex];
        m_nt->Branch(branchName.c_str(), &(m_mc_prob[trackColIndex]));              // matching probability
    }
    return StatusCode::SUCCESS;
}

initialize()

StatusCode Trk::TruthNtupleTool::initialize

(

)

Definition at line 81 of file TruthNtupleTool.cxx.

                                          {
 
  ATH_CHECK( m_evt.initialize() );
 
    if (m_etaBins.size()<2) {
      ATH_MSG_ERROR ("Vector of eta bins too small");
      return StatusCode::FAILURE;
    }
 
    // ---------------------------
    // retrieve pointer to THistSvc
    ATH_CHECK( m_histSvc.retrieve() );
 
    // ---------------------------
    // create tree and register it to THistSvc
    m_nt = new TTree(TString(m_ntupleTreeName), "Track Validation Truth");
    // NB: we must not delete the tree, this is done by THistSvc
    std::string fullNtupleName =  "/"+m_ntupleFileName+"/"+m_ntupleTreeName;
    ATH_CHECK( m_histSvc->regTree(fullNtupleName, m_nt) );
 
    //-----------------
    // add items
    // event info:
    m_nt->Branch( "RunNumber",          &m_runNumber       );
    m_nt->Branch( "EventNumber",        &m_eventNumber     );
    m_nt->Branch( "truth_d0",           &m_mc_d0           );
    m_nt->Branch( "truth_z0",           &m_mc_z0           );
    m_nt->Branch( "truth_phi0",         &m_mc_phi0         );
    m_nt->Branch( "truth_theta",        &m_mc_theta        );
    m_nt->Branch( "truth_qOverP",       &m_mc_qOverP       );
    m_nt->Branch( "truth_qOverPt",      &m_mc_qOverPt      );
    m_nt->Branch( "truth_eta",          &m_mc_eta          );
    m_nt->Branch( "truth_particleID",   &m_mc_particleID   );
    m_nt->Branch( "truth_barcode",      &m_mc_uniqueID     ); // TODO Update variable name to be consistent
    m_nt->Branch( "truth_energy",       &m_mc_energy       );
    m_nt->Branch( "truth_prod_R",       &m_mc_prodR        );
    m_nt->Branch( "truth_prod_z",       &m_mc_prodz        );
 
    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::ITruthNtupleTool::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 71 of file ITruthNtupleTool.h.

                                                           {
    return IID_ITruthNtupleTool;
}

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

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

writeTruthData()

StatusCode Trk::TruthNtupleTool::writeTruthData ( const std::vector< Trk::ValidationTrackTruthData > &  truthData )

virtual

write track data to ntuple

Implements Trk::ITruthNtupleTool.

Definition at line 239 of file TruthNtupleTool.cxx.

                                                                          {
 
    ATH_MSG_DEBUG ("in writeTruthData(...) with ValTrackTruthData size = "<<truthData.size());
    // ---------------------------------------
    // 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();
 
    HepMC::ConstGenParticlePtr   genParticle{nullptr};
    const Trk::TrackParameters* truePerigee = nullptr;
    for (unsigned int index = 0; index < truthData.size(); index++) {
        genParticle = truthData[index].genParticle;
        truePerigee = truthData[index].truthPerigee;
        if (genParticle==nullptr || truePerigee==nullptr) {
          if (genParticle==nullptr) ATH_MSG_WARNING ("NULL pointer to gen particle at index "<<index<<
                                                  ", problem with truth selection logic?");
          else ATH_MSG_DEBUG ("NULL pointer perigee from TruthToTrack. Index is "<<index);
          m_mc_uniqueID = HepMC::UNDEFINED_ID;
            for (unsigned int trackColIndex = 0; trackColIndex < m_mc_prob.size(); ++trackColIndex ) {
                (m_mc_prob[trackColIndex])->clear();
                (m_TrackLinkIndex[trackColIndex])->clear();
            }
            //m_classifications->clear(); do not clear! vector needs to be the same
            m_mc_particleID = 0;
            m_mc_energy     = 0.;
 
            m_mc_d0      = 0.;
            m_mc_z0      = 0.;
            m_mc_phi0    = 0.;
            m_mc_theta   = 0.;
            m_mc_qOverP  = 0.;
            m_mc_qOverPt = 0.;
            m_mc_eta     = 0.;
            m_mc_prodR   = 0.;
            m_mc_prodz   = 0.;
        } else {
            m_mc_uniqueID = HepMC::uniqueID(genParticle);
            m_mc_particleID = genParticle->pdg_id();
            m_mc_energy     = genParticle->momentum().e();
 
            m_mc_d0      = truePerigee->parameters()[Trk::d0];
            m_mc_z0      = truePerigee->parameters()[Trk::z0];
            m_mc_phi0    = truePerigee->parameters()[Trk::phi0];
            m_mc_theta   = truePerigee->parameters()[Trk::theta];
            m_mc_qOverP  = truePerigee->parameters()[Trk::qOverP];
            m_mc_qOverPt = (std::sin( m_mc_theta ) != 0.) ? m_mc_qOverP / std::sin( m_mc_theta ) : 0.;
            m_mc_eta     = truePerigee->eta();
            m_mc_prodR   = fabs(genParticle->production_vertex()->position().perp());
            m_mc_prodz   = fabs(genParticle->production_vertex()->position().z());
 
            for (unsigned int trackColIndex = 0; trackColIndex < truthData[index].truthToTrackIndices.size(); ++trackColIndex ) {
                (*(m_TrackLinkIndex[trackColIndex])) = truthData[index].truthToTrackIndices[trackColIndex];
                (*(m_mc_prob[trackColIndex]))        = truthData[index].truthToTrackMatchingProbabilities[trackColIndex];
            }
            // get classification
            m_classifications = truthData[index].classifications;
 
            if (m_fillJets)
              m_mc_jetLinkIndex = truthData[index].truthToJetIndex;
 
            // do statistics:
            for (unsigned int classIndex = 0; classIndex < m_classifications.size(); ++classIndex ) {
                m_truthTrackCounts[classIndex][m_classifications[classIndex]]->Fill(std::fabs(m_mc_eta));
                if (!truthData[index].truthToTrackIndices[0].empty()) {
                    // TODO: do statistics for each input track collection
                    m_recoTrackCounts[classIndex][m_classifications[classIndex]]->Fill(std::fabs(m_mc_eta));
                }
               
            }
 
        }
        m_nt->Fill();
        m_numberOfTreeEntries++;
    }
    ATH_MSG_DEBUG ("filled " << m_numberOfTreeEntries << " entries, returning...");
    return StatusCode::SUCCESS;
}

Member Data Documentation

m_classifications

std::vector<unsigned int> Trk::TruthNtupleTool::m_classifications

private

Definition at line 84 of file TruthNtupleTool.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_etaBins

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

private

Definition at line 70 of file TruthNtupleTool.h.

m_eventNumber

int Trk::TruthNtupleTool::m_eventNumber

private

event number to which this MC truth particle belongs

Definition at line 80 of file TruthNtupleTool.h.

m_evt

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

private

Definition at line 107 of file TruthNtupleTool.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_fillJets

bool Trk::TruthNtupleTool::m_fillJets

private

jO: jet filling, set from external call

Definition at line 71 of file TruthNtupleTool.h.

m_histSvc

ServiceHandle<ITHistSvc> Trk::TruthNtupleTool::m_histSvc

private

Definition at line 73 of file TruthNtupleTool.h.

m_mc_d0

float Trk::TruthNtupleTool::m_mc_d0

private

d0 of MC truth particle's perigee parameters

Definition at line 86 of file TruthNtupleTool.h.

m_mc_energy

float Trk::TruthNtupleTool::m_mc_energy

private

MC truth particle's energy at production vertex.

Definition at line 96 of file TruthNtupleTool.h.

m_mc_eta

float Trk::TruthNtupleTool::m_mc_eta

private

eta of MC truth particle's perigee parameters

Definition at line 92 of file TruthNtupleTool.h.

m_mc_jetLinkIndex

int Trk::TruthNtupleTool::m_mc_jetLinkIndex

private

link to jet this particle belongs to (if jet tree is ON)

Definition at line 97 of file TruthNtupleTool.h.

m_mc_particleID

int Trk::TruthNtupleTool::m_mc_particleID

private

PDG ID of MC truth particle.

Definition at line 94 of file TruthNtupleTool.h.

m_mc_phi0

float Trk::TruthNtupleTool::m_mc_phi0

private

phi of MC truth particle's perigee parameters

Definition at line 88 of file TruthNtupleTool.h.

m_mc_prob

std::vector< std::vector<float>* > Trk::TruthNtupleTool::m_mc_prob

private

Definition at line 83 of file TruthNtupleTool.h.

m_mc_prodR

float Trk::TruthNtupleTool::m_mc_prodR

private

Rxy of particle's production vertex.

Definition at line 98 of file TruthNtupleTool.h.

m_mc_prodz

float Trk::TruthNtupleTool::m_mc_prodz

private

z coordinate of particle's production vertex

Definition at line 99 of file TruthNtupleTool.h.

m_mc_qOverP

float Trk::TruthNtupleTool::m_mc_qOverP

private

q/p of MC truth particle's perigee parameters

Definition at line 90 of file TruthNtupleTool.h.

m_mc_qOverPt

float Trk::TruthNtupleTool::m_mc_qOverPt

private

q/pT of MC truth particle's perigee parameters

Definition at line 91 of file TruthNtupleTool.h.

m_mc_theta

float Trk::TruthNtupleTool::m_mc_theta

private

theta of MC truth particle's perigee parameters

Definition at line 89 of file TruthNtupleTool.h.

m_mc_uniqueID

int Trk::TruthNtupleTool::m_mc_uniqueID

private

MC truth particle's uniqueID.

Definition at line 95 of file TruthNtupleTool.h.

m_mc_z0

float Trk::TruthNtupleTool::m_mc_z0

private

z of MC truth particle's perigee parameters

Definition at line 87 of file TruthNtupleTool.h.

m_nt

TTree* Trk::TruthNtupleTool::m_nt

private

Pointer to the NTuple tree.

Definition at line 74 of file TruthNtupleTool.h.

m_ntupleFileName

std::string Trk::TruthNtupleTool::m_ntupleFileName

private

jobOption: Ntuple file and dir name

Definition at line 69 of file TruthNtupleTool.h.

m_ntupleTreeName

std::string Trk::TruthNtupleTool::m_ntupleTreeName

private

jobOption: Ntuple tree name

Definition at line 68 of file TruthNtupleTool.h.

m_numberOfTreeEntries

unsigned int Trk::TruthNtupleTool::m_numberOfTreeEntries

private

Definition at line 76 of file TruthNtupleTool.h.

m_recoTrackCounts

std::vector< std::vector<TH1D*> > Trk::TruthNtupleTool::m_recoTrackCounts

private

Definition at line 102 of file TruthNtupleTool.h.

m_runNumber

int Trk::TruthNtupleTool::m_runNumber

private

run number to which this MC truth particle belongs

Definition at line 79 of file TruthNtupleTool.h.

m_TrackLinkIndex

std::vector< std::vector<unsigned int>* > Trk::TruthNtupleTool::m_TrackLinkIndex

private

Definition at line 82 of file TruthNtupleTool.h.

m_trackTruthClassifiers

std::vector<const Trk::ITrackTruthClassifier*> Trk::TruthNtupleTool::m_trackTruthClassifiers

private

the truth classifiers

Definition at line 105 of file TruthNtupleTool.h.

m_truthTrackCounts

std::vector< std::vector<TH1D*> > Trk::TruthNtupleTool::m_truthTrackCounts

private

Definition at line 103 of file TruthNtupleTool.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:

• TruthNtupleTool.h
• TruthNtupleTool.cxx