#include <AlignTrackCollSplitter.h>

Inheritance diagram for Trk::AlignTrackCollSplitter:

Collaboration diagram for Trk::AlignTrackCollSplitter:

Public Member Functions
	AlignTrackCollSplitter (const std::string &name, ISvcLocator *pSvcLocator)
	constructor
virtual	~AlignTrackCollSplitter ()
	destructor
virtual StatusCode	initialize ()
	initialize method
virtual StatusCode	execute ()
	loops over tracks in event, and accumulates information necessary for alignmnet
virtual StatusCode	stop ()
	stop method
virtual StatusCode	finalize ()
	finalize method
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
StringProperty	m_inputCol
StringProperty	m_outColPrefix
std::vector< std::string >	m_outColNames
	Names of output track collections.
int	m_nevents = 0
	number of processed events
int	m_ntracks = 0
	number of processed tracks
std::vector< int >	m_trackTypeCounter
	counter for different types of tracks
int	m_nRetrievalErrors = 0
	number of retrieval errors at the beginning of the job
IntegerProperty	m_maxRetrievalErrors
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 25 of file AlignTrackCollSplitter.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

◆ AlignTrackCollSplitter()

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

constructor

Definition at line 13 of file AlignTrackCollSplitter.cxx.

  : AthAlgorithm(name, pSvcLocator)
  , m_trackTypeCounter(AlignTrack::NTrackTypes+1,0)
{
}

◆ ~AlignTrackCollSplitter()

AlignTrackCollSplitter::~AlignTrackCollSplitter ( )

virtual

destructor

Definition at line 20 of file AlignTrackCollSplitter.cxx.

{
  ATH_MSG_DEBUG("AlignTrackCollSplitter destructor");
}

Member Function Documentation

◆ 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 AlignTrackCollSplitter::execute ( )

virtual

loops over tracks in event, and accumulates information necessary for alignmnet

Definition at line 41 of file AlignTrackCollSplitter.cxx.

{
  ATH_MSG_DEBUG("AlignTrackCollSplitter::execute()");
 
  // increment number of events
  m_nevents++;
 
  // loop over tracks
  const TrackCollection * originalTracks = nullptr;
 
  // check if m_inputCol is a TrackCollection and exists for this event
  // perhaps this can be done in a much nicer way on the python side ala PyUtils/checkFile.py
  // do it here for now
  if( !evtStore()->contains<TrackCollection>(m_inputCol) ||
      evtStore()->retrieve(originalTracks,m_inputCol).isFailure() ) {
    ATH_MSG_DEBUG("input track collection \'"<<m_inputCol<<"\' not found for this event");
 
    if(m_maxRetrievalErrors>=0) {
      ++m_nRetrievalErrors;
      if(m_nRetrievalErrors>=m_maxRetrievalErrors) {
        msg(MSG::FATAL)<<"Input track collection \'"<<m_inputCol<<"\' not found in first "
                       <<m_nRetrievalErrors<<" events. Aborting."<<endmsg;
        msg(MSG::FATAL)<<"Maximum allowed number of events without the track collection "
                       <<"can be changed using the \'MaxRetrievalErrors\' option (-1 for infinite)."
                       <<endmsg;
        return StatusCode::FAILURE;
      }
    }
    return StatusCode::SUCCESS;
  }
 
  // if we're here it means that the track collection m_inputCol exists in the file
  // (it can be empty) so we change the error cutoff to process the whole file
  if(m_maxRetrievalErrors>=0)
    m_maxRetrievalErrors=-1;
 
  if(originalTracks->empty())
    return StatusCode::SUCCESS;
 
  // increment number of processed tracks
  m_ntracks += originalTracks->size();
 
  // vector to keep all different AlignTrack collections
  // +1 is for undefined AlignTrack type
  std::vector<TrackCollection *> alignTracks;
  alignTracks.reserve(AlignTrack::NTrackTypes+1);
 
for(int i=0;i<AlignTrack::NTrackTypes+1;i++)
    alignTracks.push_back(new TrackCollection);
 
  // loop over AlignTracks and fill the corresponding track collections
  int itrk = 0;
  DataVector<Track>::const_iterator it     = originalTracks->begin();
  DataVector<Track>::const_iterator it_end = originalTracks->end();
  for ( ;it != it_end ; ++it, ++itrk) {
 
    ATH_MSG_DEBUG("Processing AlignTrack "<<itrk);
 
    // each track in the collection HAS to be an AlignTrack
    const AlignTrack * alignTrack = dynamic_cast<const AlignTrack*>(*it);
    if(!alignTrack) {
      msg(MSG::FATAL)<<"Track is not an AlignTrack. The code only works with TrackCollection"
                     <<" filled with AlignTracks."<<endmsg;
      return StatusCode::FAILURE;
    }
 
    int type = alignTrack->type();
    ATH_MSG_DEBUG("type of AlignTrack: "<<alignTrack->type());
 
    //previously this check was always returning true (type>=0 || type<AlignTrack::NTrackTypes), meaning that in principle you could try
    //to access an invalid vector element if type was negative. Assume that what we have below is what was meant, as last entry in vector
    // is for undefined tracks? (Nick Styles, 04/02/15)
    int colIndex = (type>=0 && type<AlignTrack::NTrackTypes) ? type : AlignTrack::NTrackTypes;
 
    ATH_MSG_DEBUG("collection index is "<<colIndex);
    alignTracks[colIndex]->push_back(new AlignTrack(*alignTrack));
    ATH_MSG_DEBUG("pushback ok");
 
    ++m_trackTypeCounter[colIndex];
  }
 
  // record the collections in the StoreGate that takes care of deletion
  // only record collection to storegate if it's not empty
  for(int icol=0;icol<AlignTrack::NTrackTypes+1;++icol) {
    ATH_MSG_DEBUG(icol<<": recording "<<m_outColNames[icol]<<"  size "<<alignTracks[icol]->size());
    if(!alignTracks[icol]->empty()) {
      if(evtStore()->record(alignTracks[icol],m_outColNames[icol],false).isFailure()) {
        ATH_MSG_ERROR("Unable to record "<<m_outColNames[icol]<<" in the StoreGate");
        delete alignTracks[icol];
      }
      ATH_MSG_DEBUG("Recorded \'"<<m_outColNames[icol]<<"\' with size "<<alignTracks[icol]->size()<<" to StoreGate");
    }
    else {
      ATH_MSG_DEBUG("not recording "<<m_outColNames[icol]);
      delete alignTracks[icol];
    }
  }
 
  ATH_MSG_DEBUG("returning SUCCESS");
  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 AlignTrackCollSplitter::finalize ( )

virtual

finalize method

Definition at line 159 of file AlignTrackCollSplitter.cxx.

{
  ATH_MSG_DEBUG("AlignTrackCollSplitter::finalize()");
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode AlignTrackCollSplitter::initialize ( )

virtual

initialize method

Definition at line 26 of file AlignTrackCollSplitter.cxx.

{
  ATH_MSG_DEBUG("AlignTrackCollSplitter::initialize()");
 
  // set the track collection names
  ATH_MSG_INFO("Splitting "<<m_inputCol<<" into:");
  for(int icol=0; icol<AlignTrack::NTrackTypes+1; ++icol) {
    m_outColNames.push_back( m_outColPrefix + dumpAlignTrackType((AlignTrack::AlignTrackType)icol) );
    ATH_MSG_INFO(" - "<<m_outColNames[icol]);
  }
 
  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();
  }

◆ stop()

StatusCode AlignTrackCollSplitter::stop ( )

virtual

stop method

Definition at line 144 of file AlignTrackCollSplitter.cxx.

{
  ATH_MSG_DEBUG("AlignTrackCollSplitter::stop()");
 
  ATH_MSG_INFO("Processed "<<m_nevents<<" with "<<m_ntracks<<" AlignTracks");
  ATH_MSG_INFO("Track collections recorded in StoreGate:");
  ATH_MSG_INFO("----------------------------------------------");
  for(int icol=0;icol<AlignTrack::NTrackTypes+1;++icol)
    ATH_MSG_INFO(m_outColPrefix<<AlignTrack::AlignTrackType(icol)<<": "<<m_trackTypeCounter[icol]);
  ATH_MSG_INFO("----------------------------------------------");
 
  return StatusCode::SUCCESS;
}

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

StringProperty Trk::AlignTrackCollSplitter::m_inputCol

private

Initial value:

{this, "InputTrkCol", "AlignTracks",

"Name of input track collection"}

Definition at line 49 of file AlignTrackCollSplitter.h.

49 {this, "InputTrkCol", "AlignTracks",

50 "Name of input track collection"};

◆ m_maxRetrievalErrors

IntegerProperty Trk::AlignTrackCollSplitter::m_maxRetrievalErrors

private

Initial value:

{this, "MaxRetrievalErrors", -1,

"maximum allowed number of retrieval errors at the beginning of the job (-1 for infinite)"}

Definition at line 62 of file AlignTrackCollSplitter.h.

62 {this, "MaxRetrievalErrors", -1,

63 "maximum allowed number of retrieval errors at the beginning of the job (-1 for infinite)"};

◆ m_nevents

int Trk::AlignTrackCollSplitter::m_nevents = 0

private

number of processed events

Definition at line 56 of file AlignTrackCollSplitter.h.

◆ m_nRetrievalErrors

int Trk::AlignTrackCollSplitter::m_nRetrievalErrors = 0

private

number of retrieval errors at the beginning of the job

Definition at line 61 of file AlignTrackCollSplitter.h.

◆ m_ntracks

int Trk::AlignTrackCollSplitter::m_ntracks = 0

private

number of processed tracks

Definition at line 57 of file AlignTrackCollSplitter.h.

◆ m_outColNames

std::vector<std::string> Trk::AlignTrackCollSplitter::m_outColNames

private

Names of output track collections.

Definition at line 54 of file AlignTrackCollSplitter.h.

◆ m_outColPrefix

StringProperty Trk::AlignTrackCollSplitter::m_outColPrefix

private

Initial value:

{this, "OutputColPrefix", "AlignTracks",

"Prefix for names of output track collections"}

Definition at line 51 of file AlignTrackCollSplitter.h.

51 {this, "OutputColPrefix", "AlignTracks",

52 "Prefix for names of output track collections"};

◆ m_trackTypeCounter

std::vector<int> Trk::AlignTrackCollSplitter::m_trackTypeCounter

private

counter for different types of tracks

Definition at line 59 of file AlignTrackCollSplitter.h.

◆ 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

◆ AlignTrackCollSplitter()

◆ ~AlignTrackCollSplitter()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ stop()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputCol

◆ m_maxRetrievalErrors

◆ m_nevents

◆ m_nRetrievalErrors

◆ m_ntracks

◆ m_outColNames

◆ m_outColPrefix

◆ m_trackTypeCounter

◆ m_varHandleArraysDeclared

◆ m_vhka