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

Class for associating clusters to the hits that went into them. More...

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

+ Inheritance diagram for TrkrClusterHitAssocv1:
+ Collaboration diagram for TrkrClusterHitAssocv1:

Public Member Functions

 TrkrClusterHitAssocv1 ()=default
 ctor
 
void Reset () override
 Clear Event.
 
void identify (std::ostream &os=std::cout) const override
 
void addAssoc (TrkrDefs::cluskey ckey, unsigned int hidx) override
 Add association between cluster and hit.
 
ConstRange getHits (TrkrDefs::cluskey) override
 Get all the hits associated with a cluster by key.
 
- Public Member Functions inherited from TrkrClusterHitAssoc
virtual MapgetClusterMap (TrkrDefs::hitsetkey)
 get pointer to cluster-to-hit map corresponding to a given hitset id
 
virtual unsigned int size () const
 
- 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)
 

Private Member Functions

 ClassDefOverride (TrkrClusterHitAssocv1, 1)
 

Private Attributes

Map m_map
 

Additional Inherited Members

- Public Types inherited from TrkrClusterHitAssoc
using Map = std::multimap< TrkrDefs::cluskey, TrkrDefs::hitkey >
 
using ConstIterator = Map::const_iterator
 
using ConstRange = std::pair< Map::const_iterator, Map::const_iterator >
 
- Protected Member Functions inherited from TrkrClusterHitAssoc
 TrkrClusterHitAssoc ()=default
 

Detailed Description

Class for associating clusters to the hits that went into them.

Store the associations between clusters and the hits that went into them.

Definition at line 24 of file TrkrClusterHitAssocv1.h.

View newest version in sPHENIX GitHub at line 24 of file TrkrClusterHitAssocv1.h

Constructor & Destructor Documentation

TrkrClusterHitAssocv1::TrkrClusterHitAssocv1 ( )
default

ctor

Member Function Documentation

void TrkrClusterHitAssocv1::addAssoc ( TrkrDefs::cluskey  ckey,
unsigned int  hidx 
)
overridevirtual

Add association between cluster and hit.

Parameters
[in]ckeyCluster key
[in]hidxIndex of the hit in TrkrHitSet

Implements TrkrClusterHitAssoc.

Definition at line 34 of file TrkrClusterHitAssocv1.cc.

View newest version in sPHENIX GitHub at line 34 of file TrkrClusterHitAssocv1.cc

References m_map.

TrkrClusterHitAssocv1::ClassDefOverride ( TrkrClusterHitAssocv1  ,
 
)
private
TrkrClusterHitAssocv1::ConstRange TrkrClusterHitAssocv1::getHits ( TrkrDefs::cluskey  ckey)
overridevirtual

Get all the hits associated with a cluster by key.

Parameters
[in]ckeyCluster key
[out]Rangeover hits associated with ckey

Implements TrkrClusterHitAssoc.

Definition at line 40 of file TrkrClusterHitAssocv1.cc.

View newest version in sPHENIX GitHub at line 40 of file TrkrClusterHitAssocv1.cc

References m_map.

void TrkrClusterHitAssocv1::identify ( std::ostream &  os = std::cout) const
overridevirtual

identify Function from PHObject

Parameters
osOutput Stream

Reimplemented from PHObject.

Definition at line 17 of file TrkrClusterHitAssocv1.cc.

View newest version in sPHENIX GitHub at line 17 of file TrkrClusterHitAssocv1.cc

References entry, and m_map.

void TrkrClusterHitAssocv1::Reset ( )
overridevirtual

Clear Event.

Reimplemented from TrkrClusterHitAssoc.

Definition at line 12 of file TrkrClusterHitAssocv1.cc.

View newest version in sPHENIX GitHub at line 12 of file TrkrClusterHitAssocv1.cc

References m_map.

Member Data Documentation

Map TrkrClusterHitAssocv1::m_map
private

Definition at line 49 of file TrkrClusterHitAssocv1.h.

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

Referenced by addAssoc(), getHits(), identify(), and Reset().


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