ntupleDataFormat.TrackingParticle Class Reference

Inheritance diagram for ntupleDataFormat.TrackingParticle:

Public Member Functions
def	__init__ (self, tree, index)
def	bestMatchingTrack (self)
def	decayVertices (self)
def	isLooper (self)
def	matchedSeedInfos (self)
def	matchedTrackInfos (self)
def	nMatchedSeeds (self)
def	nMatchedTracks (self)
def	nSimHits (self)
def	parentVertex (self)
def	simHits (self)
Public Member Functions inherited from ntupleDataFormat._Object
def	__getattr__ (self, attr)
def	__init__ (self, tree, index, prefix)
def	index (self)
def	isValid (self)

Private Member Functions
def	_nMatchedSeeds (self)
def	_nMatchedTracks (self)

Detailed Description

Class representing a TrackingParticle.

Definition at line 971 of file ntupleDataFormat.py.

Constructor & Destructor Documentation

__init__()

def ntupleDataFormat.TrackingParticle.__init__	(		self,
			tree,
			index
	)

Constructor.

Arguments:
tree  -- TTree object
index -- Index of the TrackingParticle

Definition at line 973 of file ntupleDataFormat.py.

    def __init__(self, tree, index):
        """Constructor.

        Arguments:
        tree  -- TTree object
        index -- Index of the TrackingParticle
        """
        super(TrackingParticle, self).__init__(tree, index, "sim")

Member Function Documentation

_nMatchedSeeds()

def ntupleDataFormat.TrackingParticle._nMatchedSeeds (   self )

private

Internal function to get the number of matched seeds.

Definition at line 1029 of file ntupleDataFormat.py.

References SeedingNode< DATA >._index, lhef::H5Handler._index, RPCMuonExtraStruct._index, ntupleDataFormat._Object._index, python.cmstools.EventTree._index, python.cmstools.EventBranch._index, html.HtmlReport._index, ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, and findQualityFiles.size.

Referenced by ntupleDataFormat.TrackingParticle.matchedSeedInfos(), and ntupleDataFormat.TrackingParticle.nMatchedSeeds().

    def _nMatchedSeeds(self):
        """Internal function to get the number of matched seeds."""
        return self._tree.sim_seedIdx[self._index].size()

_nMatchedTracks()

def ntupleDataFormat.TrackingParticle._nMatchedTracks (   self )

private

Internal function to get the number of matched tracks.

Definition at line 982 of file ntupleDataFormat.py.

References SeedingNode< DATA >._index, lhef::H5Handler._index, RPCMuonExtraStruct._index, ntupleDataFormat._Object._index, python.cmstools.EventTree._index, python.cmstools.EventBranch._index, html.HtmlReport._index, ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, and findQualityFiles.size.

Referenced by ntupleDataFormat.TrackingParticle.bestMatchingTrack(), ntupleDataFormat.TrackingParticle.matchedTrackInfos(), and ntupleDataFormat.TrackingParticle.nMatchedTracks().

    def _nMatchedTracks(self):
        """Internal function to get the number of matched tracks."""
        return self._tree.sim_trkIdx[self._index].size()

bestMatchingTrack()

def ntupleDataFormat.TrackingParticle.bestMatchingTrack

(

self

)

Returns best-matching track, even for non-reconstructed TrackingParticles, or None, if there is no best-matching track.

Best-matching is defined as the one with largest number of
hits matched to the hits of a TrackingParticle (>= 3). If
there are many fulfilling the same number of hits, the one
inducing the innermost hit of the TrackingParticle is chosen.

Definition at line 1000 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), ntupleDataFormat.TrackingParticle._nMatchedTracks(), ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, ntupleDataFormat.TrackingParticle.matchedTrackInfos(), GetRecoTauVFromDQM_MC_cff.next, MuonTruth.simHits(), MuonSimHitMatcher.simHits(), EdgeProperty.simHits, PHcalTB06Info.simHits(), Phase2TrackerValidateDigi.simHits, ntupleDataFormat.TrackingParticle.simHits(), and HLT_2023v12_cff.track.

    def bestMatchingTrack(self):
        """Returns best-matching track, even for non-reconstructed TrackingParticles, or None, if there is no best-matching track.

        Best-matching is defined as the one with largest number of
        hits matched to the hits of a TrackingParticle (>= 3). If
        there are many fulfilling the same number of hits, the one
        inducing the innermost hit of the TrackingParticle is chosen.
        """
        self._checkIsValid()
        if self._nMatchedTracks() == 1:
            return next(self.matchedTrackInfos()).track()

        tracks = collections.OrderedDict()
        for hit in self.simHits():
            for recHit in hit.hits():
                for track in recHit.tracks():
                    if track.index() in tracks:
                        tracks[track.index()] += 1
                    else:
                        tracks[track.index()] = 1

        best = (None, 2)
        for trackIndex, nhits in tracks.items():
            if nhits > best[1]:
                best = (trackIndex, nhits)
        if best[0] is None:
            return None
        return Tracks(self._tree)[best[0]]

decayVertices()

def ntupleDataFormat.TrackingParticle.decayVertices

(

self

)

Returns a generator for decay vertices.

The generator returns TrackingVertex objects.

Definition at line 1062 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), SeedingNode< DATA >._index, lhef::H5Handler._index, RPCMuonExtraStruct._index, ntupleDataFormat._Object._index, python.cmstools.EventTree._index, python.cmstools.EventBranch._index, html.HtmlReport._index, ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, and python.cmstools.EventTree._tree.

    def decayVertices(self):
        """Returns a generator for decay vertices.

        The generator returns TrackingVertex objects.
        """
        self._checkIsValid()
        for ivtx in self._tree.sim_decayVtxIdx[self._index]:
            yield TrackingVertex(self._tree, ivtx)

isLooper()

def ntupleDataFormat.TrackingParticle.isLooper

(

self

)

Returns True if this TrackingParticle is a looper.

Note that the check involves looping over the SimHits, so it is not too cheap.

Definition at line 1071 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, TrackingNtuple::TPHitIndex.simHitIdx, hit.x, and hit.y.

    def isLooper(self):
        """Returns True if this TrackingParticle is a looper.

        Note that the check involves looping over the SimHits, so it is not too cheap."""
        self._checkIsValid()
        prevr = 0
        for ihit in self.simHitIdx():
            hit = SimHit(self._tree, ihit)
            r = hit.x()**2 + hit.y()**2
            if r < prevr:
                return True
            prevr = r
        return False

matchedSeedInfos()

def ntupleDataFormat.TrackingParticle.matchedSeedInfos

(

self

)

Returns a generator for matched tracks.

The generator returns SeedMatchInfo objects.

Definition at line 1038 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), SeedingNode< DATA >._index, lhef::H5Handler._index, RPCMuonExtraStruct._index, ntupleDataFormat._Object._index, python.cmstools.EventTree._index, python.cmstools.EventBranch._index, html.HtmlReport._index, ntupleDataFormat.TrackingParticle._nMatchedSeeds(), CommonAnalyzer._prefix, ntupleDataFormat._Object._prefix, html.PageSet._prefix, ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, and FastTimerService_cff.range.

    def matchedSeedInfos(self):
        """Returns a generator for matched tracks.

        The generator returns SeedMatchInfo objects.
        """
        self._checkIsValid()
        for imatch in range(self._nMatchedSeeds()):
            yield SeedMatchInfo(self._tree, self._index, imatch, self._prefix)

matchedTrackInfos()

def ntupleDataFormat.TrackingParticle.matchedTrackInfos

(

self

)

Returns a generator for matched tracks.

The generator returns TrackMatchInfo objects.

Definition at line 991 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), SeedingNode< DATA >._index, lhef::H5Handler._index, RPCMuonExtraStruct._index, ntupleDataFormat._Object._index, python.cmstools.EventTree._index, python.cmstools.EventBranch._index, html.HtmlReport._index, ntupleDataFormat.TrackingParticle._nMatchedTracks(), CommonAnalyzer._prefix, ntupleDataFormat._Object._prefix, html.PageSet._prefix, ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, and FastTimerService_cff.range.

Referenced by ntupleDataFormat.TrackingParticle.bestMatchingTrack().

    def matchedTrackInfos(self):
        """Returns a generator for matched tracks.

        The generator returns TrackMatchInfo objects.
        """
        self._checkIsValid()
        for imatch in range(self._nMatchedTracks()):
            yield TrackMatchInfo(self._tree, self._index, imatch, self._prefix)

nMatchedSeeds()

def ntupleDataFormat.TrackingParticle.nMatchedSeeds

(

self

)

Returns the number of matched seeds.

Definition at line 1033 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), and ntupleDataFormat.TrackingParticle._nMatchedSeeds().

    def nMatchedSeeds(self):
        """Returns the number of matched seeds."""
        self._checkIsValid()
        return self._nMatchedSeeds()

nMatchedTracks()

def ntupleDataFormat.TrackingParticle.nMatchedTracks

(

self

)

Returns the number of matched tracks.

Definition at line 986 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), and ntupleDataFormat.TrackingParticle._nMatchedTracks().

    def nMatchedTracks(self):
        """Returns the number of matched tracks."""
        self._checkIsValid()
        return self._nMatchedTracks()

nSimHits()

def ntupleDataFormat.TrackingParticle.nSimHits

(

self

)

Definition at line 1047 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), TrackingNtuple::TPHitIndex.simHitIdx, and findQualityFiles.size.

    def nSimHits(self):
        self._checkIsValid()
        return self.simHitIdx().size()

parentVertex()

def ntupleDataFormat.TrackingParticle.parentVertex

(

self

)

Returns the parent TrackingVertex.

Definition at line 1057 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), SeedingNode< DATA >._index, lhef::H5Handler._index, RPCMuonExtraStruct._index, ntupleDataFormat._Object._index, python.cmstools.EventTree._index, python.cmstools.EventBranch._index, html.HtmlReport._index, ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, and python.cmstools.EventTree._tree.

    def parentVertex(self):
        """Returns the parent TrackingVertex."""
        self._checkIsValid()
        return TrackingVertex(self._tree, self._tree.sim_parentVtxIdx[self._index])

simHits()

def ntupleDataFormat.TrackingParticle.simHits

(

self

)

Returns generator for SimHits.

Definition at line 1051 of file ntupleDataFormat.py.

References ntupleDataFormat._Object._checkIsValid(), ntupleDataFormat._Collection._tree, ntupleDataFormat._Object._tree, python.cmstools.EventTree._tree, and TrackingNtuple::TPHitIndex.simHitIdx.

Referenced by ntupleDataFormat.TrackingParticle.bestMatchingTrack().

    def simHits(self):
        """Returns generator for SimHits."""
        self._checkIsValid()
        for ihit in self.simHitIdx():
            yield SimHit(self._tree, ihit)