#include <MuonTrackStatisticsAlg.h>

Inheritance diagram for MuonTrackStatisticsAlg:

Collaboration diagram for MuonTrackStatisticsAlg:

Public Member Functions
	MuonTrackStatisticsAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~MuonTrackStatisticsAlg ()
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
virtual unsigned int	cardinality () const override final
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
void	storeTruthTracks (void)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< MuonTrackStatisticsTool >	m_statisticsTool {this, "StatTool", "" }
std::string	m_fileName
	name of external file to write statistics
std::ofstream	m_fileOutput
	output file
bool	m_writeToFile
bool	m_doTruth
SG::ReadHandleKeyArray< TrackCollection >	m_trackKeys
SG::ReadHandleKeyArray< DetailedTrackTruthCollection >	m_truthKeys
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

Definition at line 19 of file MuonTrackStatisticsAlg.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

◆ MuonTrackStatisticsAlg()

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

Definition at line 12 of file MuonTrackStatisticsAlg.cxx.

                                                                                              :
    AthAlgorithm(name, pSvcLocator), m_writeToFile(false), m_doTruth(false) {
    declareProperty("doTruth", m_doTruth);
    declareProperty("writeToFile", m_writeToFile);
    declareProperty("FileName", m_fileName);
}

◆ ~MuonTrackStatisticsAlg()

MuonTrackStatisticsAlg::~MuonTrackStatisticsAlg ( )

virtualdefault

Member Function Documentation

◆ cardinality()

virtual unsigned int MuonTrackStatisticsAlg::cardinality ( ) const

inlinefinaloverridevirtual

Definition at line 30 of file MuonTrackStatisticsAlg.h.

30{ 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 MuonTrackStatisticsAlg::execute ( )

overridevirtual

Definition at line 32 of file MuonTrackStatisticsAlg.cxx.

                                           {
    ATH_MSG_DEBUG("MuonTrackStatisticsAlg in execute() ...");
 
    for (SG::ReadHandle<TrackCollection>& trackColl : m_trackKeys.makeHandles()) {
        if (!trackColl.isPresent()) {
            ATH_MSG_DEBUG("track collection " << trackColl.key() << " not present");
            continue;
        }
        if (!trackColl.isValid()) {
            ATH_MSG_WARNING("track collection " << trackColl.key() << " not valid!");
            return StatusCode::FAILURE;
        }
        ATH_CHECK(m_statisticsTool->updateTrackCounters(trackColl.key(), trackColl.cptr()));
    }
 
    for (SG::ReadHandle<DetailedTrackTruthCollection>& truthMap : m_truthKeys.makeHandles()) {
        if (!truthMap.isPresent()) {
            ATH_MSG_DEBUG("truth map " << truthMap.key() << " not present");
            continue;
        }
        if (!truthMap.isValid()) {
            ATH_MSG_WARNING("truth map " << truthMap.key() << " not valid!");
            return StatusCode::FAILURE;
        }
        ATH_CHECK(m_statisticsTool->updateTruthTrackCounters(truthMap.key(), truthMap.cptr()));
    }
 
    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 MuonTrackStatisticsAlg::finalize ( )

overridevirtual

Definition at line 65 of file MuonTrackStatisticsAlg.cxx.

                                            {
    ATH_MSG_INFO(std::endl << m_statisticsTool->printTrackCounters());
    // write to file
    if (m_writeToFile) {
        m_fileOutput.open(m_fileName.c_str(), std::ios::trunc);
        m_fileOutput << m_statisticsTool->printTrackCounters() << std::endl;
        m_fileOutput.close();
    }
 
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode MuonTrackStatisticsAlg::initialize ( )

overridevirtual

Definition at line 21 of file MuonTrackStatisticsAlg.cxx.

                                              {
    ATH_CHECK(m_statisticsTool.retrieve());
    ATH_CHECK(m_trackKeys.initialize());
    ATH_CHECK(m_truthKeys.initialize());
 
    for (unsigned int i = 0; i < m_trackKeys.size(); i++) m_statisticsTool->addTrackCounters(m_trackKeys[i].key());
    for (unsigned int i = 0; i < m_truthKeys.size(); i++) m_statisticsTool->addTrackCounters(m_truthKeys[i].key());
 
    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();
  }

◆ storeTruthTracks()

void MuonTrackStatisticsAlg::storeTruthTracks ( void )

private

Definition at line 77 of file MuonTrackStatisticsAlg.cxx.

77{}

◆ 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_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_doTruth

bool MuonTrackStatisticsAlg::m_doTruth

private

Definition at line 44 of file MuonTrackStatisticsAlg.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_fileName

std::string MuonTrackStatisticsAlg::m_fileName

private

name of external file to write statistics

Definition at line 38 of file MuonTrackStatisticsAlg.h.

◆ m_fileOutput

std::ofstream MuonTrackStatisticsAlg::m_fileOutput

private

output file

Definition at line 41 of file MuonTrackStatisticsAlg.h.

◆ m_statisticsTool

ToolHandle<MuonTrackStatisticsTool> MuonTrackStatisticsAlg::m_statisticsTool {this, "StatTool", "" }

private

Definition at line 33 of file MuonTrackStatisticsAlg.h.

33{this, "StatTool", "" };

◆ m_trackKeys

SG::ReadHandleKeyArray<TrackCollection> MuonTrackStatisticsAlg::m_trackKeys

private

Initial value:

{

this, "TrackLocationList", {"MuonSpectrometerTracks"}, "track collections to track"}

Definition at line 46 of file MuonTrackStatisticsAlg.h.

46 {

47 this, "TrackLocationList", {"MuonSpectrometerTracks"}, "track collections to track"};

◆ m_truthKeys

SG::ReadHandleKeyArray<DetailedTrackTruthCollection> MuonTrackStatisticsAlg::m_truthKeys

private

Initial value:

{

this, "TruthTrackLocationList", {"MuonSpectrometerTracksTruth"}, "truth track collections"}

Definition at line 48 of file MuonTrackStatisticsAlg.h.

48 {

49 this, "TruthTrackLocationList", {"MuonSpectrometerTracksTruth"}, "truth track collections"};

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

◆ m_writeToFile

bool MuonTrackStatisticsAlg::m_writeToFile

private

Definition at line 43 of file MuonTrackStatisticsAlg.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

◆ MuonTrackStatisticsAlg()

◆ ~MuonTrackStatisticsAlg()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ storeTruthTracks()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_doTruth

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_fileName

◆ m_fileOutput

◆ m_statisticsTool

◆ m_trackKeys

◆ m_truthKeys

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeToFile