Writes out RecordedMaterialTrackCollection to a root file. More...

#include <MaterialTrackReader.h>

Inheritance diagram for ActsTrk::MaterialTrackReader:

Collaboration diagram for ActsTrk::MaterialTrackReader:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
virtual unsigned	cardinality () const override
virtual	~MaterialTrackReader ()
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
Gaudi::Property< std::size_t >	m_maxEvents {this, "maxEvents", std::numeric_limits<std::size_t>::max()}
	The number of events in the processed.
Gaudi::Property< std::size_t >	m_skipEvents {this, "skipEvents", 0ul}
	The number of events in the file to skip.
Gaudi::Property< std::size_t >	m_batchSize {this, "batchSize", 1000ul}
	The batch size (number of track per events).
std::size_t	m_nTreeEntries {0ul}
	The number of entries in the tree to read.
std::size_t	m_currEntry {0ul}
	The current processed tree entry.
std::size_t	m_procEvents {0ul}
	The number of processed tree events.
Gaudi::Property< std::vector< std::string > >	m_fileNames {this, "FileNames", {}, "The list of input file names"}
	The list of input filenames.
Gaudi::Property< std::string >	m_treeName {this, "TreeName", "material-tracks", "The input tree name"}
	The name of the input tree.
Gaudi::Property< bool >	m_readCachedSurfaceInformation {this, "ReadCachedSurface", false, "Read surface information for the root file"}
	Read surface information for the root file.
ActsPlugins::RootMaterialTrackIo	m_accessor {{false, m_readCachedSurfaceInformation}}
	The read - write payload.
std::unique_ptr< TChain >	m_inputChain {}
	The input chain of entries.
SG::WriteHandleKey< RecordedMaterialTrackCollection >	m_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "InputMaterialTracks", "Name of the RecordedMaterialTrackCollection"}
	The RecordedMaterialTrackCollection to write.
DataObjIDColl	m_extendedExtraObjects
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

Writes out RecordedMaterialTrackCollection to a root file.

It writes out a MaterialTrack which is usually generated from MaterialTrackRecorder G4UA

Definition at line 31 of file MaterialTrackReader.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~MaterialTrackReader()

ActsTrk::MaterialTrackReader::~MaterialTrackReader ( )

virtualdefault

Member Function Documentation

◆ AthAlgorithm()

AthAlgorithm::AthAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Constructor with parameters:

Definition at line 51 of file AthAlgorithm.cxx.

                                                       :
  ::AthCommonDataStore<AthCommonMsg<Algorithm>>   ( name, pSvcLocator )
{
  // Set up to run AthAlgorithmDHUpdate in sysInitialize before
  // merging dependency lists.  This extends the output dependency
  // list with any symlinks implied by inheritance relations.
  m_updateDataHandles =
    std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
    (m_extendedExtraObjects,
     std::move (m_updateDataHandles));
}

◆ cardinality()

virtual unsigned ActsTrk::MaterialTrackReader::cardinality ( ) const

inlineoverridevirtual

Definition at line 38 of file MaterialTrackReader.h.

38{ return 1; }

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode ActsTrk::MaterialTrackReader::execute ( )

overridevirtual

Definition at line 82 of file MaterialTrackReader.cxx.

                                     {
    const EventContext& ctx{Gaudi::Hive::currentContext()};
    // Write to the collection to the EventStore
    SG::WriteHandle materialTracks{m_materialTrackCollectionKey, ctx};
 
    // Record the collection once per event if not already there
    if (!materialTracks.isPresent()) {
        ATH_CHECK(materialTracks.record(std::make_unique<ActsTrk::RecordedMaterialTrackCollection>()));
    }
 
    if (m_currEntry >= m_nTreeEntries) {
        m_inputChain.reset();
        return StatusCode::SUCCESS;
    }
 
    std::size_t nProcEvents{0ul};
    std::size_t nCurrentEvt{m_accessor.eventId()};
 
    for (; m_currEntry< m_nTreeEntries; ++m_currEntry) {
        ATH_MSG_VERBOSE("Fetched entry "<<m_currEntry<<", eventId: "<<m_accessor.eventId());       
        // get the correspoing entry and read it
        m_inputChain->GetEntry(m_currEntry);
        Acts::RecordedMaterialTrack rmTrack = m_accessor.read();
        m_accessor.eventId();
 
        ATH_MSG_VERBOSE("Track vertex:  " << Amg::toString(rmTrack.first.first)
                    <<", momentum:" << Amg::toString(rmTrack.first.second));
 
        // filling the collection
        materialTracks->push_back(std::move(rmTrack));
        if (nCurrentEvt != m_accessor.eventId()) {
            ++nProcEvents;
            ++m_procEvents;
            nCurrentEvt = m_accessor.eventId();
        }
 
        if (m_procEvents >= m_maxEvents) {
            ATH_MSG_INFO("All "<<m_maxEvents<<" events have been processed");
            m_currEntry = m_nTreeEntries;
            return StatusCode::SUCCESS;
        }
 
        if (nProcEvents >=m_batchSize) {
            ATH_MSG_DEBUG("Batch processing "<<nProcEvents<<" completed. ");
            break;
        }
 
    }
    return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode ActsTrk::MaterialTrackReader::finalize ( )

overridevirtual

Definition at line 72 of file MaterialTrackReader.cxx.

                                                {
    if (m_inputChain) {
        ATH_MSG_ERROR("Not all entries / events have been processed. Processed entries: "
                <<(m_currEntry+ 1)<<"/"<<m_nTreeEntries<<", processed events: "
                <<m_procEvents<<"/"<<m_maxEvents.value());
    }
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ActsTrk::MaterialTrackReader::initialize ( )

overridevirtual

Definition at line 16 of file MaterialTrackReader.cxx.

{
    ATH_CHECK(m_materialTrackCollectionKey.initialize());
 
    if (m_fileNames.empty()) {
        ATH_MSG_ERROR("No input files given... Please check!!");
        return StatusCode::FAILURE;
    }
 
    // set up the input chain
    m_inputChain = std::make_unique<TChain>(m_treeName.value().c_str());
 
    // loop over the input files
    for (const auto& inputFile : m_fileNames) {
        // add file to the input chain
        ATH_MSG_DEBUG("Adding File " << inputFile << " to tree '" << m_treeName << "'.");
        if (!m_inputChain->Add(inputFile.c_str())) {
            ATH_MSG_ERROR("Failed to load file "<<inputFile);
            return StatusCode::FAILURE;
        }
    }
 
    // Connect the branches
    m_accessor.connectForRead(*m_inputChain);
    // get the number of events, which also loads the tree
    m_nTreeEntries = m_inputChain->GetEntries();
  
    if (m_skipEvents >0ul) {
        std::optional<std::uint32_t> evt{0ul};
        std::size_t procEvts{0ul};
        ATH_MSG_DEBUG("Skip "<<m_skipEvents<<" events. ");
        for (; m_currEntry < m_nTreeEntries; ++m_currEntry) {
            m_inputChain->GetEntry(m_currEntry);
            if (!evt) {
                evt = m_accessor.eventId();
            } else if ((*evt) != m_accessor.eventId()) {
                ++procEvts;
                evt = m_accessor.eventId();
            }
            if (procEvts == m_skipEvents) {
                break;
            }
        }
        ATH_MSG_INFO("Skipped "<<procEvts<<" events. Corresponding to "
                      <<m_currEntry<<" tree entries");
    }
    if (!m_nTreeEntries) {
        ATH_MSG_ERROR("Input does not contain any recorded track");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("Material files contain " << m_nTreeEntries << " entries. Process "
                <<m_batchSize.value()<<" material events per athena event. Until "
                <<m_maxEvents.value()<<" events are processed or the tree is finished");
    return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_accessor

ActsPlugins::RootMaterialTrackIo ActsTrk::MaterialTrackReader::m_accessor {{false, m_readCachedSurfaceInformation}}

private

The read - write payload.

Definition at line 61 of file MaterialTrackReader.h.

61{{false, m_readCachedSurfaceInformation}};

ActsTrk::MaterialTrackReader::m_readCachedSurfaceInformation

Gaudi::Property< bool > m_readCachedSurfaceInformation

Read surface information for the root file.

Definition MaterialTrackReader.h:59

◆ m_batchSize

Gaudi::Property<std::size_t> ActsTrk::MaterialTrackReader::m_batchSize {this, "batchSize", 1000ul}

private

The batch size (number of track per events).

Definition at line 47 of file MaterialTrackReader.h.

47{this, "batchSize", 1000ul};

◆ m_currEntry

std::size_t ActsTrk::MaterialTrackReader::m_currEntry {0ul}

private

The current processed tree entry.

Definition at line 51 of file MaterialTrackReader.h.

51{0ul};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_fileNames

Gaudi::Property<std::vector<std::string> > ActsTrk::MaterialTrackReader::m_fileNames {this, "FileNames", {}, "The list of input file names"}

private

The list of input filenames.

Definition at line 55 of file MaterialTrackReader.h.

55{this, "FileNames", {}, "The list of input file names"};

◆ m_inputChain

std::unique_ptr<TChain> ActsTrk::MaterialTrackReader::m_inputChain {}

private

The input chain of entries.

Definition at line 63 of file MaterialTrackReader.h.

63{};

◆ m_materialTrackCollectionKey

SG::WriteHandleKey<RecordedMaterialTrackCollection> ActsTrk::MaterialTrackReader::m_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "InputMaterialTracks", "Name of the RecordedMaterialTrackCollection"}

private

The RecordedMaterialTrackCollection to write.

Definition at line 65 of file MaterialTrackReader.h.

65{this, "MaterialTrackCollectionKey", "InputMaterialTracks", "Name of the RecordedMaterialTrackCollection"};

◆ m_maxEvents

Gaudi::Property<std::size_t> ActsTrk::MaterialTrackReader::m_maxEvents {this, "maxEvents", std::numeric_limits<std::size_t>::max()}

private

The number of events in the processed.

Definition at line 43 of file MaterialTrackReader.h.

43{this, "maxEvents", std::numeric_limits<std::size_t>::max()};

◆ m_nTreeEntries

std::size_t ActsTrk::MaterialTrackReader::m_nTreeEntries {0ul}

private

The number of entries in the tree to read.

Definition at line 49 of file MaterialTrackReader.h.

49{0ul};

◆ m_procEvents

std::size_t ActsTrk::MaterialTrackReader::m_procEvents {0ul}

private

The number of processed tree events.

Definition at line 53 of file MaterialTrackReader.h.

53{0ul};

◆ m_readCachedSurfaceInformation

Gaudi::Property<bool> ActsTrk::MaterialTrackReader::m_readCachedSurfaceInformation {this, "ReadCachedSurface", false, "Read surface information for the root file"}

private

Read surface information for the root file.

Definition at line 59 of file MaterialTrackReader.h.

59{this, "ReadCachedSurface", false, "Read surface information for the root file"};

◆ m_skipEvents

Gaudi::Property<std::size_t> ActsTrk::MaterialTrackReader::m_skipEvents {this, "skipEvents", 0ul}

private

The number of events in the file to skip.

Definition at line 45 of file MaterialTrackReader.h.

45{this, "skipEvents", 0ul};

◆ m_treeName

Gaudi::Property<std::string> ActsTrk::MaterialTrackReader::m_treeName {this, "TreeName", "material-tracks", "The input tree name"}

private

The name of the input tree.

Definition at line 57 of file MaterialTrackReader.h.

57{this, "TreeName", "material-tracks", "The input tree name"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~MaterialTrackReader()

Member Function Documentation

◆ AthAlgorithm()

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accessor

◆ m_batchSize

◆ m_currEntry

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_fileNames

◆ m_inputChain

◆ m_materialTrackCollectionKey

◆ m_maxEvents

◆ m_nTreeEntries

◆ m_procEvents

◆ m_readCachedSurfaceInformation

◆ m_skipEvents

◆ m_treeName

◆ m_varHandleArraysDeclared

◆ m_vhka