This validation tool writes basic information about Trk::Track into an ntuple; it is also the steering tool for all Trk::IValidationNtupleTool. More...

#include <DirectTrackNtupleWriterTool.h>

Inheritance diagram for Trk::DirectTrackNtupleWriterTool:

Collaboration diagram for Trk::DirectTrackNtupleWriterTool:

Public Member Functions
	DirectTrackNtupleWriterTool (const std::string &, const std::string &, const IInterface *)
	~DirectTrackNtupleWriterTool ()
StatusCode	initialize ()
StatusCode	finalize ()
	finalize
virtual StatusCode	writeTrackData (const Trk::Track &, const int iterationIndex, const unsigned int fitStatCode)
	fill AND write ntuple data of a given track
virtual StatusCode	writeTrackParticleData (const Trk::TrackParticleBase &)
	fill AND write ntuple data of a given track particle
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
StatusCode	writeRecord (TTree *tree)
	write the filled data into the ntuple
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandleArray< Trk::ITrackValidationNtupleTool >	m_ValidationNtupleTools
	set of tools for writting Trk::Track into the Ntuple
ToolHandle< Trk::IExtrapolator >	m_extrapolatorHandle
	extrapolator, in case tracks do not have Perigee
std::string	m_ntupleFileName
	jobOption: Ntuple file name
std::string	m_ntupleDirName
	jobOption: Ntuple directory name
std::string	m_ntupleTreeName
	jobOption: Ntuple tree name
TTree *	m_nt
	Pointer to the NTuple tree.
bool	m_doTruth
	switch to turn truth on/off
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

This validation tool writes basic information about Trk::Track into an ntuple; it is also the steering tool for all Trk::IValidationNtupleTool.

It books the ntuple, create the tree directory and add basic entries. With every call this tool writes the current record to the ntuple file and starts a new entry. One can give a list of Trk::IValidationNtupleTool by joboptions.

Every entry (track) contains the event number, a track id (numbering the tracks within one event) and an optional iteration index, which can be used if different intermediate results of a track are produced in the refit procedure. The track id is the same for all tracks generated within one iteration process and reset to 0 every time a new event is started. Perigee parameters are filled for every track if available.

Author: Sebas.nosp@m.tian.nosp@m..Flei.nosp@m.schm.nosp@m.ann@c.nosp@m.ern..nosp@m.ch

Definition at line 49 of file DirectTrackNtupleWriterTool.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

◆ DirectTrackNtupleWriterTool()

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

Definition at line 25 of file DirectTrackNtupleWriterTool.cxx.

        :
        AthAlgTool(t,n,p),
        m_ValidationNtupleTools(),
        m_extrapolatorHandle("Trk::Extrapolator/InDetExtrapolator"),
        m_nt(nullptr),
        m_doTruth(true)
{
    declareInterface<IDirectTrackNtupleWriter>(this);
    // Declare tool handles
    declareProperty("ValidationNtupleTools",      m_ValidationNtupleTools, "set of tools to write the validation ntuple");
    declareProperty("ExtrapolatorTool",           m_extrapolatorHandle,                   "Extrapolator, eg for tracks without Pergiee parameters");
     
    // Declare the properties
    declareProperty("NtupleFileName",               m_ntupleFileName = "/NTUPLES/FILE1",    "Ntuple file handle");
    declareProperty("NtupleDirectoryName",          m_ntupleDirName = "FitterValidation",   "dircetory name for ntuple tree");
    declareProperty("NtupleTreeName",               m_ntupleTreeName = "Validation",        "Name of the ntuple tree");
    declareProperty("DoTruth",                      m_doTruth,                              "Write truth data?");
}

◆ ~DirectTrackNtupleWriterTool()

Trk::DirectTrackNtupleWriterTool::~DirectTrackNtupleWriterTool ( )

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

finalize

Definition at line 91 of file DirectTrackNtupleWriterTool.cxx.

                                                    {
 
  ATH_MSG_DEBUG ("start finalize() in " << name());
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::DirectTrackNtupleWriterTool::initialize ( )

Definition at line 55 of file DirectTrackNtupleWriterTool.cxx.

                                                      {
 
  StatusCode sc(StatusCode::SUCCESS);
    
  // 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");
  // NB: we must not delete the tree, this is done by THistSvc
  std::string fullNtupleName =  "/"+m_ntupleFileName+"/"+m_ntupleDirName+"/"+m_ntupleTreeName;
  ATH_CHECK( tHistSvc->regTree(fullNtupleName, m_nt) );
 
  // Get Validation ntuple Tools
  ATH_CHECK( m_ValidationNtupleTools.retrieve() );
 
  // add the ntuple branches to our tree
  ToolHandleArray< Trk::ITrackValidationNtupleTool >::iterator itTools;
  itTools = m_ValidationNtupleTools.begin();
  for (  ; itTools != m_ValidationNtupleTools.end(); ++itTools ) {
     if (((*itTools)->addNtupleItems(m_nt)).isFailure()) {
       ATH_MSG_ERROR ("ValidationNtupleTool could not add its branches for tree " << fullNtupleName);
       return StatusCode::FAILURE;
     }
   }
   
   // FIXME retrieve extrapolator
   
   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::IDirectTrackNtupleWriter::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 63 of file IDirectTrackNtupleWriter.h.

                                                                   {
    return IID_IDirectTrackNtupleWriter;
}

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

◆ writeRecord()

StatusCode Trk::DirectTrackNtupleWriterTool::writeRecord ( TTree * tree )

private

write the filled data into the ntuple

Definition at line 147 of file DirectTrackNtupleWriterTool.cxx.

                                                                  {
    if (!tree) return StatusCode::FAILURE;
    tree->Fill();
    // reset variables for next call
    ToolHandleArray< Trk::ITrackValidationNtupleTool >::iterator itTools;
    itTools = m_ValidationNtupleTools.begin();
    for ( ; itTools != m_ValidationNtupleTools.end(); ++itTools ) (*itTools)->resetVariables();
    return StatusCode::SUCCESS;
}

◆ writeTrackData()

StatusCode Trk::DirectTrackNtupleWriterTool::writeTrackData	(	const Trk::Track &	track,
		const int	iterationIndex,
		const unsigned int	fitStatCode )

virtual

fill AND write ntuple data of a given track

write track data to ntuple

Implements Trk::IDirectTrackNtupleWriter.

Definition at line 100 of file DirectTrackNtupleWriterTool.cxx.

                                      {
//     const Trk::FitterStatusCode fitStatCode )  const {
    
  ATH_MSG_VERBOSE ("in writeTrackData(trk, indx)");
 
  ToolHandleArray< Trk::ITrackValidationNtupleTool >::iterator itTools;
  itTools = m_ValidationNtupleTools.begin();
  for (  ; itTools != m_ValidationNtupleTools.end(); ++itTools ) {
    if (((*itTools)->fillTrackData( track, iterationIndex, fitStatCode )).isFailure()) {
      ATH_MSG_ERROR ("Validation Ntuple Tool could not fill track data.");
      return StatusCode::FAILURE;
    }
  }
 
  //----------------------------------------------
  // write the ntuple record out (once per call)
  return writeRecord(m_nt);
}

◆ writeTrackParticleData()

StatusCode Trk::DirectTrackNtupleWriterTool::writeTrackParticleData ( const Trk::TrackParticleBase & particlebase )

virtual

fill AND write ntuple data of a given track particle

write track particle data to ntuple

Implements Trk::IDirectTrackNtupleWriter.

Definition at line 125 of file DirectTrackNtupleWriterTool.cxx.

                                                {
    
  ATH_MSG_VERBOSE ("in writeTrackParticleData()");
 
  ToolHandleArray< Trk::ITrackValidationNtupleTool >::iterator itTools;
  itTools = m_ValidationNtupleTools.begin();
  for (  ; itTools != m_ValidationNtupleTools.end(); ++itTools ) {
    if (((*itTools)->fillTrackParticleData( particlebase )).isFailure()) {
      ATH_MSG_ERROR ("Validation Ntuple Tool could not fill particlebase data.");
      return StatusCode::FAILURE;
    }
  }
 
  //----------------------------------------------
  // write the ntuple record out (once per call)
  return writeRecord(m_nt);
}

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_doTruth

bool Trk::DirectTrackNtupleWriterTool::m_doTruth

private

switch to turn truth on/off

Definition at line 80 of file DirectTrackNtupleWriterTool.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_extrapolatorHandle

ToolHandle<Trk::IExtrapolator> Trk::DirectTrackNtupleWriterTool::m_extrapolatorHandle

private

extrapolator, in case tracks do not have Perigee

Definition at line 75 of file DirectTrackNtupleWriterTool.h.

◆ m_nt

TTree* Trk::DirectTrackNtupleWriterTool::m_nt

private

Pointer to the NTuple tree.

Definition at line 79 of file DirectTrackNtupleWriterTool.h.

◆ m_ntupleDirName

std::string Trk::DirectTrackNtupleWriterTool::m_ntupleDirName

private

jobOption: Ntuple directory name

Definition at line 77 of file DirectTrackNtupleWriterTool.h.

◆ m_ntupleFileName

std::string Trk::DirectTrackNtupleWriterTool::m_ntupleFileName

private

jobOption: Ntuple file name

Definition at line 76 of file DirectTrackNtupleWriterTool.h.

◆ m_ntupleTreeName

std::string Trk::DirectTrackNtupleWriterTool::m_ntupleTreeName

private

jobOption: Ntuple tree name

Definition at line 78 of file DirectTrackNtupleWriterTool.h.

◆ m_ValidationNtupleTools

ToolHandleArray<Trk::ITrackValidationNtupleTool> Trk::DirectTrackNtupleWriterTool::m_ValidationNtupleTools

private

set of tools for writting Trk::Track into the Ntuple

Definition at line 74 of file DirectTrackNtupleWriterTool.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

◆ DirectTrackNtupleWriterTool()

◆ ~DirectTrackNtupleWriterTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ writeRecord()

◆ writeTrackData()

◆ writeTrackParticleData()

Member Data Documentation

◆ m_detStore

◆ m_doTruth

◆ m_evtStore

◆ m_extrapolatorHandle

◆ m_nt

◆ m_ntupleDirName

◆ m_ntupleFileName

◆ m_ntupleTreeName

◆ m_ValidationNtupleTools

◆ m_varHandleArraysDeclared

◆ m_vhka