Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TrkrHitTruthAssoc Class Reference

Association object for PHG4Cells contributiong to TrkrHits. More...

#include <coresoftware/blob/master/offline/packages/trackbase/TrkrHitTruthAssoc.h>

+ Inheritance diagram for TrkrHitTruthAssoc:
+ Collaboration diagram for TrkrHitTruthAssoc:

Public Types

using MMap = std::multimap< TrkrDefs::hitsetkey, std::pair< TrkrDefs::hitkey, PHG4HitDefs::keytype > >
 typedefs for convenience
 
using Iterator = MMap::iterator
 
using ConstIterator = MMap::const_iterator
 
using Range = std::pair< Iterator, Iterator >
 
using ConstRange = std::pair< ConstIterator, ConstIterator >
 

Public Member Functions

void Reset () override
 Clear Event.
 
void identify (std::ostream &=std::cout) const override
 
virtual void addAssoc (const TrkrDefs::hitsetkey, const TrkrDefs::hitkey, const PHG4HitDefs::keytype)
 Add an association between hit and cell.
 
virtual void findOrAddAssoc (const TrkrDefs::hitsetkey, const TrkrDefs::hitkey, const PHG4HitDefs::keytype)
 Add an association between hit and cell if it does not already exist.
 
virtual void removeAssoc (const TrkrDefs::hitsetkey, const TrkrDefs::hitkey)
 
virtual void getG4Hits (const TrkrDefs::hitsetkey, const unsigned int, MMap &) const
 Get cell keys associated with desired hit.
 
- Public Member Functions inherited from PHObject
 PHObject ()
 ctor
 
 ~PHObject () override
 dtor
 
virtual PHObjectCloneMe () const
 Virtual copy constructor.
 
virtual PHObjectclone () const final
 
PHObjectClone (const char *newname="") const final
 
void Copy (TObject &object) const final
 
virtual int isValid () const
 isValid returns non zero if object contains vailid data
 
virtual int Integrate () const
 
virtual int Integrate (PHObject *)
 
virtual void CopyFrom (const PHObject *obj)
 

Protected Member Functions

 TrkrHitTruthAssoc ()=default
 ctor
 

Private Member Functions

 ClassDefOverride (TrkrHitTruthAssoc, 1)
 

Detailed Description

Association object for PHG4Cells contributiong to TrkrHits.

Association object holding a multimap of PHG4Cells associated with a given TrkrHit

Definition at line 25 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 25 of file TrkrHitTruthAssoc.h

Member Typedef Documentation

using TrkrHitTruthAssoc::ConstIterator = MMap::const_iterator

Definition at line 33 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 33 of file TrkrHitTruthAssoc.h

Definition at line 35 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 35 of file TrkrHitTruthAssoc.h

using TrkrHitTruthAssoc::Iterator = MMap::iterator

Definition at line 32 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 32 of file TrkrHitTruthAssoc.h

typedefs for convenience

Definition at line 31 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 31 of file TrkrHitTruthAssoc.h

Definition at line 34 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 34 of file TrkrHitTruthAssoc.h

Constructor & Destructor Documentation

TrkrHitTruthAssoc::TrkrHitTruthAssoc ( )
protecteddefault

ctor

Member Function Documentation

virtual void TrkrHitTruthAssoc::addAssoc ( const TrkrDefs::hitsetkey  ,
const TrkrDefs::hitkey  ,
const PHG4HitDefs::keytype   
)
inlinevirtual

Add an association between hit and cell.

Parameters
[in]hsetTrkrHitSet key
[in]hidxTrkrHit index in TrkrHitSet
[in]ckeyKey for assocuated g4hit

Reimplemented in TrkrHitTruthAssocv1.

Definition at line 49 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 49 of file TrkrHitTruthAssoc.h

Referenced by PHG4TpcElectronDrift::process_event().

+ Here is the caller graph for this function:

TrkrHitTruthAssoc::ClassDefOverride ( TrkrHitTruthAssoc  ,
 
)
private
virtual void TrkrHitTruthAssoc::findOrAddAssoc ( const TrkrDefs::hitsetkey  ,
const TrkrDefs::hitkey  ,
const PHG4HitDefs::keytype   
)
inlinevirtual

Add an association between hit and cell if it does not already exist.

Parameters
[in]hsetTrkrHitSet key
[in]hidxTrkrHit index in TrkrHitSet
[in]ckeyKey for assocuated g4hit

Reimplemented in TrkrHitTruthAssocv1.

Definition at line 58 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 58 of file TrkrHitTruthAssoc.h

virtual void TrkrHitTruthAssoc::getG4Hits ( const TrkrDefs::hitsetkey  ,
const unsigned int  ,
MMap  
) const
inlinevirtual
void TrkrHitTruthAssoc::identify ( std::ostream &  os = std::cout) const
inlineoverridevirtual

identify Function from PHObject

Parameters
osOutput Stream

Reimplemented from PHObject.

Reimplemented in TrkrHitTruthAssocv1.

Definition at line 40 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 40 of file TrkrHitTruthAssoc.h

Referenced by PHG4TpcElectronDrift::process_event().

+ Here is the caller graph for this function:

virtual void TrkrHitTruthAssoc::removeAssoc ( const TrkrDefs::hitsetkey  ,
const TrkrDefs::hitkey   
)
inlinevirtual

Reimplemented in TrkrHitTruthAssocv1.

Definition at line 61 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 61 of file TrkrHitTruthAssoc.h

void TrkrHitTruthAssoc::Reset ( )
inlineoverridevirtual

Clear Event.

Reimplemented from PHObject.

Reimplemented in TrkrHitTruthAssocv1.

Definition at line 37 of file TrkrHitTruthAssoc.h.

View newest version in sPHENIX GitHub at line 37 of file TrkrHitTruthAssoc.h


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