Trk::PRD_AssociationTool Class Reference

Concrete Implementation of the IPRD_AssociationTool interface. More...

#include <PRD_AssociationTool.h>

Inheritance diagram for Trk::PRD_AssociationTool:

Collaboration diagram for Trk::PRD_AssociationTool:

Public Member Functions
	PRD_AssociationTool (const std::string &, const std::string &, const IInterface *)
virtual	~PRD_AssociationTool ()=default
virtual StatusCode	initialize () override
virtual StatusCode	addPRDs (const Track &track) override
	add the PRDs from this track to the store More...
virtual StatusCode	addPRDs (Maps &maps, const Track &track) const override
	add the PRDs from this track to maps. More...
virtual StatusCode	removePRDs (Maps &maps, const Track &track) const override
	remove the PRDs from this track from maps More...
virtual StatusCode	removePRDs (const Track &track) override
	remove the PRDs from this track from the store More...
virtual bool	isUsed (const Maps &maps, const PrepRawData &prd) const override final
	does this PRD belong to at least one track in maps? More...
virtual bool	isUsed (const PrepRawData &prd) const override final
	does this PRD belong to at least one track? More...
virtual bool	isShared (const Maps &maps, const PrepRawData &prd) const override final
	does this PRD belong to more than one track in maps? More...
virtual bool	isShared (const PrepRawData &prd) const override final
	does this PRD belong to more than one track? More...
virtual std::vector< const PrepRawData * >	getPrdsOnTrack (const Track &track) const override
	returns a vector of PRDs belonging to the passed track. More...
virtual std::vector< const PrepRawData * >	getPrdsOnTrack (const Maps &maps, const Track &track) const override
virtual IPRD_AssociationTool::TrackSet	findConnectedTracks (const Track &track) const override
	returns set of tracks which share PRD with this one More...
virtual IPRD_AssociationTool::TrackSet	findConnectedTracks (const Maps &maps, const Track &track) const override
virtual IPRD_AssociationTool::PrepRawDataTrackMapRange	onTracks (const PrepRawData &prd) const override
	get the Tracks associated with this Trk::PrepRawData. More...
virtual IPRD_AssociationTool::PrepRawDataTrackMapRange	onTracks (const Maps &maps, const PrepRawData &prd) const override
virtual void	reset () override
	resets the tool - should be called before using tool (and maybe afterwards to free up memory) More...

Private Attributes
Maps	m_maps
SG::ReadHandleKey< Trk::PRDtoTrackMap >	m_prdToTrackMap {this,"PRDtoTrackMap",""}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

Detailed Description

Concrete Implementation of the IPRD_AssociationTool interface.

Definition at line 24 of file PRD_AssociationTool.h.

Constructor & Destructor Documentation

PRD_AssociationTool()

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

Definition at line 16 of file PRD_AssociationTool.cxx.

  :
  base_class(t,n,p)
{
}

~PRD_AssociationTool()

virtual Trk::PRD_AssociationTool::~PRD_AssociationTool ( )

virtualdefault

Member Function Documentation

addPRDs() [1/2]

StatusCode Trk::PRD_AssociationTool::addPRDs ( const Track &  track )

overridevirtual

add the PRDs from this track to the store

Parameters

track

all PRDs from 'track' will be added to PRD_AssociationTool's internal store.

Definition at line 33 of file PRD_AssociationTool.cxx.

{
  if (!m_prdToTrackMap.key().empty()) throw std::runtime_error("Cannot modify(addPRDs) the PRDtoTrackMap that was read from storegate!");
  return addPRDs (m_maps, track);
}

addPRDs() [2/2]

StatusCode Trk::PRD_AssociationTool::addPRDs ( Maps &  maps, const Track &  track  ) const

overridevirtual

add the PRDs from this track to maps.

Parameters

track

all PRDs from 'track' will be added to PRD_AssociationTool's internal store.

Definition at line 39 of file PRD_AssociationTool.cxx.

{
  // test caching
  TrackPrepRawDataMap::const_iterator itvec = maps.m_trackPrepRawDataMap.find(&track);
  if (itvec!=maps.m_trackPrepRawDataMap.end())
  {
    ATH_MSG_ERROR ("track already found in cache, should not happen");
    return StatusCode::FAILURE;
  }
  // get all prds on 'track'
  std::vector< const Trk::PrepRawData* > prds = getPrdsOnTrack( maps, track );
  for (const Trk::PrepRawData* prd : prds) {
     maps.m_prepRawDataTrackMap.emplace(prd, &track);
  }
 
  // cache this using m_trackPrepRawDataMap
  maps.m_trackPrepRawDataMap.emplace(&track, prds);
 
  ATH_MSG_DEBUG ("Added PRDs from Track at ("<<&track<<") - map now has size: \t"<<
                 maps.m_prepRawDataTrackMap.size());
  return StatusCode::SUCCESS;
}

findConnectedTracks() [1/2]

Trk::IPRD_AssociationTool::TrackSet Trk::PRD_AssociationTool::findConnectedTracks ( const Maps &  maps, const Track &  track  ) const

overridevirtual

Definition at line 127 of file PRD_AssociationTool.cxx.

{
  TrackSet connectedTracks;
 
  std::vector< const Trk::PrepRawData* > prds = getPrdsOnTrack(maps, track);
  for (const Trk::PrepRawData* prd : prds)
  {
    IPRD_AssociationTool::PrepRawDataTrackMapRange range = onTracks(maps, *prd);
 
    // TODO use remove_copy_if instead.
    for ( ; range.first!=range.second; ++(range.first) )
    {
      const Track* conTrack = (range.first)->second;
      // don't copy this track!
      if (conTrack!=&track) {
        // this does actually not allow for double entries
        connectedTracks.insert(conTrack);
        ATH_MSG_VERBOSE ("Track "<<&track<<" \tshares PRD "<<prd<<" \twith track:"<<conTrack);
      }
    }
    ATH_MSG_VERBOSE ("Added in connected tracks for PRD:"<<prd<<
                     "\tsize of list now:"<<connectedTracks.size());
  }
 
  return connectedTracks;
}

findConnectedTracks() [2/2]

Trk::IPRD_AssociationTool::TrackSet Trk::PRD_AssociationTool::findConnectedTracks ( const Track &  track ) const

overridevirtual

returns set of tracks which share PRD with this one

Parameters

track

this Track must be known to this tool.

Returns

a set of tracks which share PRD/hits with the passed 'track'

Definition at line 120 of file PRD_AssociationTool.cxx.

{
  if (!m_prdToTrackMap.key().empty()) throw std::runtime_error("findConnectedTracks not supported when using a PRDtoTrackMap from storegate.");
  return findConnectedTracks (m_maps, track);
}

getPrdsOnTrack() [1/2]

std::vector< const Trk::PrepRawData * > Trk::PRD_AssociationTool::getPrdsOnTrack ( const Maps &  maps, const Track &  track  ) const

overridevirtual

Definition at line 165 of file PRD_AssociationTool.cxx.

{
  using PRDs_t = std::vector<const PrepRawData *>;
 
  // test caching
  TrackPrepRawDataMap::const_iterator itvec = maps.m_trackPrepRawDataMap.find(&track);
  if (itvec!=maps.m_trackPrepRawDataMap.end())
  {
    ATH_MSG_VERBOSE ("found track in cache, return cached PRD vector for track");
    return itvec->second;
  }
 
  if (track.measurementsOnTrack()==nullptr) {
    ATH_MSG_WARNING ("Track has no RoTs");
    return {};
  }
 
  PRDs_t vec;
  vec.reserve(track.measurementsOnTrack()->size());
  for (const MeasurementBase* meas : *track.measurementsOnTrack())
  {
    const RIO_OnTrack* rot = dynamic_cast<const RIO_OnTrack*>(meas);
    if (rot){
      if(m_idHelperSvc->isMuon(rot->identify())){
        //only use precision hits for muon track overlap
        if(!m_idHelperSvc->isMdt(rot->identify()) && (!m_idHelperSvc->isCsc(rot->identify()) || m_idHelperSvc->measuresPhi(rot->identify()))) continue;
      }
      vec.push_back(rot->prepRawData());
    }
    else{
      const Trk::CompetingRIOsOnTrack* competingROT = dynamic_cast <const Trk::CompetingRIOsOnTrack*> (meas);
      if(competingROT){
        const unsigned int numROTs = competingROT->numberOfContainedROTs();
        for( unsigned int i=0;i<numROTs;++i ){
          const Trk::RIO_OnTrack* rot = &competingROT->rioOnTrack(i);
          if( !rot || !rot->prepRawData() || !m_idHelperSvc->isMuon(rot->identify()) ) continue;
          //only use precision hits for muon track overlap
          if(!m_idHelperSvc->isMdt(rot->identify()) && (!m_idHelperSvc->isCsc(rot->identify()) || m_idHelperSvc->measuresPhi(rot->identify()))) continue;
          vec.push_back(rot->prepRawData());
        }
      }
    }
  }
  ATH_MSG_DEBUG (" Getting "<<vec.size()<<" PRDs from track at:"<<&track);
 
  return vec;
}

getPrdsOnTrack() [2/2]

std::vector< const Trk::PrepRawData * > Trk::PRD_AssociationTool::getPrdsOnTrack ( const Track &  track ) const

overridevirtual

returns a vector of PRDs belonging to the passed track.

It's basically for the convenience of users and is created purely from the passed track.

i.e. there is no caching if you do it multiple times on the same track, you're being inefficient!!

Parameters

track

this Track will be iterated through and all PrepRawData added to a vector

Returns

vector of PrepRawData* belonging to 'track'. The PrepRawData should NOT be deleted

• they belong to the Track (and thus the event).

Definition at line 157 of file PRD_AssociationTool.cxx.

{
  if (!m_prdToTrackMap.key().empty()) throw std::runtime_error("getPrdsOnTrack not supported when using a PRDtoTrackMap from storegate.");
  return getPrdsOnTrack (m_maps, track);
}

initialize()

StatusCode Trk::PRD_AssociationTool::initialize ( )

overridevirtual

Definition at line 24 of file PRD_AssociationTool.cxx.

{
  StatusCode sc = AlgTool::initialize();
  if (sc.isFailure()) return sc;
  ATH_CHECK( m_prdToTrackMap.initialize( !m_prdToTrackMap.key().empty() ) );
  ATH_CHECK( m_idHelperSvc.retrieve());
  return StatusCode::SUCCESS;
}

isShared() [1/2]

bool Trk::PRD_AssociationTool::isShared ( const Maps &  maps, const PrepRawData &  prd  ) const

inlinefinaloverridevirtual

does this PRD belong to more than one track in maps?

Parameters

prd	the PrepRawData in question

Returns

true if 'prd' exists on more than one track (of course PRD_AssociationTool can only give information about tracks it knows about i.e. that were added to maps with addPRDs()

Definition at line 129 of file PRD_AssociationTool.h.

{
  return (maps.m_prepRawDataTrackMap.count(&prd)>1);
}

isShared() [2/2]

bool Trk::PRD_AssociationTool::isShared ( const PrepRawData &  prd ) const

inlinefinaloverridevirtual

does this PRD belong to more than one track?

Parameters

prd	the PrepRawData in question

Returns

true if 'prd' exists on more than one track (of course PRD_AssociationTool can only give information about tracks it knows about i.e. that were added with addPRDs()

Definition at line 135 of file PRD_AssociationTool.h.

{
  if (!m_prdToTrackMap.key().empty()) {return SG::ReadHandle<Trk::PRDtoTrackMap>(m_prdToTrackMap)->isShared(prd);}
  return isShared (m_maps, prd);
}

isUsed() [1/2]

bool Trk::PRD_AssociationTool::isUsed ( const Maps &  maps, const PrepRawData &  prd  ) const

inlinefinaloverridevirtual

does this PRD belong to at least one track in maps?

Parameters

prd	the PrepRawData in question

Returns

true if 'prd' exists in at least one track (of course PRD_AssociationTool can only give information about tracks it knows about i.e. that were added to maps with addPRDs()

Definition at line 117 of file PRD_AssociationTool.h.

{
  return (maps.m_prepRawDataTrackMap.count(&prd)>0);
}

isUsed() [2/2]

bool Trk::PRD_AssociationTool::isUsed ( const PrepRawData &  prd ) const

inlinefinaloverridevirtual

does this PRD belong to at least one track?

Parameters

prd	the PrepRawData in question

Returns

true if 'prd' exists in at least one track (of course PRD_AssociationTool can only give information about tracks it knows about i.e. that were added with addPRDs()

Definition at line 123 of file PRD_AssociationTool.h.

{
  if (!m_prdToTrackMap.key().empty()) {return SG::ReadHandle<Trk::PRDtoTrackMap>(m_prdToTrackMap)->isUsed(prd);}
  return isUsed (m_maps, prd);
}

onTracks() [1/2]

Trk::IPRD_AssociationTool::PrepRawDataTrackMapRange Trk::PRD_AssociationTool::onTracks ( const Maps &  maps, const PrepRawData &  prd  ) const

overridevirtual

Definition at line 222 of file PRD_AssociationTool.cxx.

{
//  std::pair<IPRD_AssociationTool::PRD_MapIt, IPRD_AssociationTool::PRD_MapIt>       range =
  return maps.m_prepRawDataTrackMap.equal_range(&prd);
}

onTracks() [2/2]

Trk::IPRD_AssociationTool::PrepRawDataTrackMapRange Trk::PRD_AssociationTool::onTracks ( const PrepRawData &  prd ) const

overridevirtual

get the Tracks associated with this Trk::PrepRawData.

IMPORTANT: Please use the typedefs IPRD_AssociationTool::PrepRawDataRange and IPRD_AssociationTool::ConstPRD_MapIt (defined in the interface) to access the tracks, as the way the data is stored internally may change.

Definition at line 215 of file PRD_AssociationTool.cxx.

{
  if (!m_prdToTrackMap.key().empty()) {return SG::ReadHandle<Trk::PRDtoTrackMap>(m_prdToTrackMap)->onTracks(prd);}
  return onTracks (m_maps, prd);
}

removePRDs() [1/2]

StatusCode Trk::PRD_AssociationTool::removePRDs ( const Track &  track )

overridevirtual

remove the PRDs from this track from the store

Parameters

track

all PRDs from 'track' will be removed from the PRD_AssociationTool's internal store.

Definition at line 62 of file PRD_AssociationTool.cxx.

{
  if (!m_prdToTrackMap.key().empty()) throw std::runtime_error("Cannot modify(removePRDs) the PRDtoTrackMap that was read from storegate!");
  return removePRDs (m_maps, track);
}

removePRDs() [2/2]

StatusCode Trk::PRD_AssociationTool::removePRDs ( Maps &  maps, const Track &  track  ) const

overridevirtual

remove the PRDs from this track from maps

Parameters

track

all PRDs from 'track' will be removed from maps

Definition at line 68 of file PRD_AssociationTool.cxx.

{
  // This is NOT pretty code!
  // At the moment I'm brute-forcing, but maybe I need a second map, containing <Track*, iterator>
  // The problem is that I think filling such a map is also time-consuming.
  // Since removes happen much less frequently than add, then the slow bit should be here.
  // EJWM
 
  // save for debugging purposes
  int oldSize = maps.m_prepRawDataTrackMap.size();//used in debug output at end.
 
  // test caching
  TrackPrepRawDataMap::iterator itvec = maps.m_trackPrepRawDataMap.find(&track);
  if (itvec==maps.m_trackPrepRawDataMap.end())
  {
    ATH_MSG_ERROR ("Track not found in cache, this should not happen");
    return StatusCode::FAILURE;
  }
 
  // get all prds on 'track'
  std::vector< const Trk::PrepRawData* > prds = itvec->second;
  for (const Trk::PrepRawData* prd : prds)
  {
    // now get all map elements (i.e. Tracks) that contain this PRD
    IPRD_AssociationTool::PrepRawDataTrackMapRange
        range = maps.m_prepRawDataTrackMap.equal_range(prd);
 
    // get iterators for range
    ConstPRD_MapIt mapIt    = range.first;
    ConstPRD_MapIt mapItEnd = range.second;
 
    // simple for loop instead of fancier remove_if above
    for ( ;mapIt!=mapItEnd; ++mapIt)
    {
      if ( mapIt->second==&track )
      {
        maps.m_prepRawDataTrackMap.erase( mapIt );
        break;//should only ever be one Track
      }
    }
  }
 
  // remove cached PRD vector
  maps.m_trackPrepRawDataMap.erase( itvec );
 
  ATH_MSG_DEBUG ("Removed  PRDs from track (" <<&track<<") \t- map has changed "<<
                 "size from \t"<<oldSize <<" \tto "<<maps.m_prepRawDataTrackMap.size());
  return StatusCode::SUCCESS;
}

reset()

void Trk::PRD_AssociationTool::reset ( )

overridevirtual

resets the tool - should be called before using tool (and maybe afterwards to free up memory)

Definition at line 228 of file PRD_AssociationTool.cxx.

{
  if (!m_prdToTrackMap.key().empty()) throw std::runtime_error("cannot reset PRDtoTrack map when it is taken from storegate.");
  m_maps.m_prepRawDataTrackMap.clear();
  m_maps.m_trackPrepRawDataMap.clear();
}

Member Data Documentation

m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Trk::PRD_AssociationTool::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Definition at line 114 of file PRD_AssociationTool.h.

m_maps

Maps Trk::PRD_AssociationTool::m_maps

private

Definition at line 111 of file PRD_AssociationTool.h.

m_prdToTrackMap

SG::ReadHandleKey<Trk::PRDtoTrackMap> Trk::PRD_AssociationTool::m_prdToTrackMap {this,"PRDtoTrackMap",""}

private

Definition at line 112 of file PRD_AssociationTool.h.

---

The documentation for this class was generated from the following files:

• PRD_AssociationTool.h
• PRD_AssociationTool.cxx