PSimHit Class Reference

#include <PSimHit.h>

Inheritance diagram for PSimHit:

Public Member Functions
unsigned int	detUnitId () const
float	energyLoss () const
	The energy deposit in the PSimHit, in ???. More...
Local3DPoint	entryPoint () const
	Entry point in the local Det frame. More...
EncodedEventId	eventId () const
Local3DPoint	exitPoint () const
	Exit point in the local Det frame. More...
LocalVector	localDirection () const
	Obsolete. Same as momentumAtEntry().unit(), for backward compatibility. More...
Local3DPoint	localPosition () const
LocalVector	momentumAtEntry () const
	The momentum of the track that produced the hit, at entry point. More...
unsigned int	offsetTrackId () const
unsigned int	originalTrackId () const
float	pabs () const
	fast and more accurate access to momentumAtEntry().mag() More...
int	particleType () const
Geom::Phi< float >	phiAtEntry () const
	fast and more accurate access to momentumAtEntry().phi() More...
unsigned short	processType () const
	PSimHit ()
	PSimHit (const Local3DPoint &entry, const Local3DPoint &exit, float pabs, float tof, float eloss, int particleType, unsigned int detId, unsigned int trackId, float theta, float phi, unsigned short processType=0)
void	setEventId (EncodedEventId e)
void	setTof (float tof)
Geom::Theta< float >	thetaAtEntry () const
	fast and more accurate access to momentumAtEntry().theta() More...
float	timeOfFlight () const
float	tof () const
	deprecated name for timeOfFlight() More...
unsigned int	trackId () const

Static Public Member Functions
static unsigned int	addTrackIdOffset (unsigned int tId, unsigned int offset)

Static Public Attributes
static constexpr unsigned int	k_tidOffset = 200000000

Protected Attributes
unsigned int	theDetUnitId
float	theEnergyLoss
Local3DPoint	theEntryPoint
EncodedEventId	theEventId
float	thePabs
int	theParticleType
float	thePhiAtEntry
unsigned short	theProcessType
Local3DVector	theSegment
float	theThetaAtEntry
float	theTof
unsigned int	theTrackId

Friends
class	TrackingSlaveSD

Detailed Description

Persistent-capable SimHit. Suitable for tracking detectors.

Definition at line 15 of file PSimHit.h.

Constructor & Destructor Documentation

PSimHit() [1/2]

PSimHit::PSimHit ( )

inline

Definition at line 19 of file PSimHit.h.

: theDetUnitId(0) {}

PSimHit() [2/2]

PSimHit::PSimHit ( const Local3DPoint &  entry, const Local3DPoint &  exit, float  pabs, float  tof, float  eloss, int  particleType, unsigned int  detId, unsigned int  trackId, float  theta, float  phi, unsigned short  processType = 0  )

inline

Definition at line 21 of file PSimHit.h.

      : theEntryPoint(entry),
        theSegment(exit - entry),
        thePabs(pabs),
        theEnergyLoss(eloss),
        theThetaAtEntry(theta),
        thePhiAtEntry(phi),
        theTof(tof),
        theParticleType(particleType),
        theProcessType(processType),
        theDetUnitId(detId),
        theTrackId(trackId) {}

Member Function Documentation

addTrackIdOffset()

static unsigned int PSimHit::addTrackIdOffset ( unsigned int  tId, unsigned int  offset  )

inlinestatic

Definition at line 117 of file PSimHit.h.

References k_tidOffset, and hltrates_dqm_sourceclient-live_cfg::offset.

Referenced by MtdSD::getTrackID().

{ return offset * k_tidOffset + tId; }

detUnitId()

unsigned int PSimHit::detUnitId ( ) const

inline

The DetUnit identifier, to be interpreted in the context of the detector system that produced the hit. E.g. in the Tracker this is index used with DetUnitNumbering<TrackerSimHitTag>. Currently the context is not deducible from the PSimHit and must be known when the PSimHit is created/accessed.

Definition at line 99 of file PSimHit.h.

References theDetUnitId.

Referenced by CkfDebugger::analyseCompatibleMeasurements(), CkfDebugger::analyseRecHitExistance(), TrackerHitAssociator::associateHit(), FWTrackingParticleProxyBuilderFullFramework::build(), FWPSimHitProxyBuilder::buildViewType(), MuonTrackResidualAnalyzer::computeResolution(), TkAccumulatingSensitiveDetector::createHit(), CkfDebugger::det(), CkfDebugger::SimHit::detUnitId(), SubsystemNeutronReader::generateChamberNoise(), ME0SimpleModel::getSimHitBx(), GEMSignalModel::getSimHitBx(), RPCSynchronizer::getSimHitBx(), RPCSynchronizer::getSimHitBxAndTimingForIRPC(), CkfDebugger::hasDelta(), CkfDebugger::nextCorrectHits(), CkfDebugger::position(), MuonSensitiveDetector::saveHit(), TkAccumulatingSensitiveDetector::sendHit(), DTHitAssociator::SimHitOK(), and TkAccumulatingSensitiveDetector::updateHit().

{ return theDetUnitId; }

energyLoss()

float PSimHit::energyLoss ( ) const

inline

The energy deposit in the PSimHit, in ???.

Definition at line 81 of file PSimHit.h.

References theEnergyLoss.

Referenced by TkAccumulatingSensitiveDetector::createHit(), CkfDebugger::SimHit::energyLoss(), SubsystemNeutronReader::generateChamberNoise(), TkAccumulatingSensitiveDetector::sendHit(), CSCGasCollisions::simulate(), TkAccumulatingSensitiveDetector::updateHit(), and CSCGasCollisions::writeSummary().

{ return theEnergyLoss; }

entryPoint()

Local3DPoint PSimHit::entryPoint ( ) const

inline

Entry point in the local Det frame.

Definition at line 45 of file PSimHit.h.

References theEntryPoint.

Referenced by TkAccumulatingSensitiveDetector::createHit(), SubsystemNeutronReader::generateChamberNoise(), SiPixelDigitizerAlgorithm::make_digis(), MuonSensitiveDetector::saveHit(), TkAccumulatingSensitiveDetector::sendHit(), DTHitAssociator::SimHitOK(), CSCGasCollisions::simulate(), TkAccumulatingSensitiveDetector::updateHit(), and CSCGasCollisions::writeSummary().

{ return theEntryPoint; }

eventId()

EncodedEventId PSimHit::eventId ( ) const

inline

Definition at line 119 of file PSimHit.h.

References theEventId.

Referenced by DTHitAssociator::associateDTHitId(), TrackerHitAssociator::associateHit(), and ntupleDataFormat.Event::eventIdStr().

{ return theEventId; }

exitPoint()

Local3DPoint PSimHit::exitPoint ( ) const

inline

Exit point in the local Det frame.

Definition at line 48 of file PSimHit.h.

References theEntryPoint, and theSegment.

Referenced by TkAccumulatingSensitiveDetector::closeHit(), TkAccumulatingSensitiveDetector::createHit(), SubsystemNeutronReader::generateChamberNoise(), SiPixelDigitizerAlgorithm::make_digis(), MuonSensitiveDetector::saveHit(), TkAccumulatingSensitiveDetector::sendHit(), DTHitAssociator::SimHitOK(), CSCGasCollisions::simulate(), TkAccumulatingSensitiveDetector::updateHit(), and CSCGasCollisions::writeSummary().

{ return theEntryPoint + theSegment; }

localDirection()

LocalVector PSimHit::localDirection ( ) const

inline

Obsolete. Same as momentumAtEntry().unit(), for backward compatibility.

Definition at line 60 of file PSimHit.h.

References f, phiAtEntry(), and thetaAtEntry().

Referenced by CkfDebugger::SimHit::localDirection().

{ return LocalVector(thetaAtEntry(), phiAtEntry(), 1.f); }

localPosition()

Local3DPoint PSimHit::localPosition ( ) const

inline

Local position in the Det frame. Normally it is on the detection surface, but this is not checked. It is computed as the middle point between entry and exit.

Definition at line 54 of file PSimHit.h.

References theEntryPoint, and theSegment.

Referenced by CkfDebugger::analyseCompatibleMeasurements(), TestHits::analyze(), TestSmoothHits::analyze(), TestTrackHits::analyze(), FWTrackingParticleProxyBuilderFullFramework::build(), FWPSimHitProxyBuilder::buildViewType(), DTRecHitQuality::compute(), MuonTrackResidualAnalyzer::computeResolution(), Phase2OTValidateRecHitBase::fillOTRecHitHistos(), Phase2ITValidateRecHitBase::fillRechitHistos(), ME0SimpleModel::getSimHitBx(), GEMSignalModel::getSimHitBx(), RPCSynchronizer::getSimHitBx(), RPCSynchronizer::getSimHitBxAndTimingForIRPC(), CkfDebugger::SimHit::globalPosition(), PixelTemplateSmearerBase::hitsMerge(), CkfDebugger::SimHit::localPosition(), CkfDebugger::position(), and DTHitAssociator::SimHitOK().

{ return theEntryPoint + 0.5 * theSegment; }

momentumAtEntry()

LocalVector PSimHit::momentumAtEntry ( ) const

inline

The momentum of the track that produced the hit, at entry point.

Definition at line 57 of file PSimHit.h.

References pabs(), phiAtEntry(), and thetaAtEntry().

Referenced by TestHits::analyze(), TestSmoothHits::analyze(), TestTrackHits::analyze(), FWTrackingParticleProxyBuilderFullFramework::build(), MuonTrackResidualAnalyzer::computeResolution(), and PixelTemplateSmearerBase::hitsMerge().

{ return LocalVector(thetaAtEntry(), phiAtEntry(), pabs()); }

offsetTrackId()

unsigned int PSimHit::offsetTrackId ( ) const

inline

Definition at line 115 of file PSimHit.h.

References k_tidOffset, and theTrackId.

{ return theTrackId / k_tidOffset; }

originalTrackId()

unsigned int PSimHit::originalTrackId ( ) const

inline

In case te SimTrack ID is incremented by the k_tidOffset for hit category definition, this methods returns the original theTrackId value directly.

Definition at line 113 of file PSimHit.h.

References k_tidOffset, and theTrackId.

{ return theTrackId % k_tidOffset; }

pabs()

float PSimHit::pabs ( ) const

inline

fast and more accurate access to momentumAtEntry().mag()

Definition at line 69 of file PSimHit.h.

References thePabs.

Referenced by CkfDebugger::associated(), SubsystemNeutronReader::generateChamberNoise(), CkfDebugger::goodSimHit(), momentumAtEntry(), CkfDebugger::SimHit::pabs(), TkAccumulatingSensitiveDetector::sendHit(), CSCGasCollisions::simulate(), and CSCGasCollisions::writeSummary().

{ return thePabs; }

particleType()

int PSimHit::particleType ( ) const

inline

The particle type of the track that produced this hit, in standard PDG code. NB: This differs from ORCA5 and earlier, where the code was Geant3. The particle type of the hit may differ from the particle type of the SimTrack with id trackId(). This happends if the hit was created by a secondary track (e.g. a delta ray) originating from the trackId() and not existing as a separate SimTrack.

Definition at line 91 of file PSimHit.h.

References theParticleType.

Referenced by FWPSimHitProxyBuilder::buildViewType(), SubsystemNeutronReader::generateChamberNoise(), GEMBaseValidation::isMuonSimHit(), CkfDebugger::SimHit::particleType(), CSCGasCollisions::simulate(), and CSCGasCollisions::writeSummary().

{ return theParticleType; }

phiAtEntry()

Geom::Phi<float> PSimHit::phiAtEntry ( ) const

inline

fast and more accurate access to momentumAtEntry().phi()

Definition at line 66 of file PSimHit.h.

References thePhiAtEntry.

Referenced by SubsystemNeutronReader::generateChamberNoise(), localDirection(), momentumAtEntry(), and CkfDebugger::SimHit::phiAtEntry().

{ return Geom::Phi<float>(thePhiAtEntry); }

processType()

unsigned short PSimHit::processType ( ) const

inline

The ID of the physics process that created the track that produced the hit. This is useful for identifying hits from secondary interactions, especially in the case when the track that produced the hit was not saved as a SimTrack. The meaning of the ID is defined outside of the PSimHit; The only value with special significance is zero (for "undefined"), so zero should not be the ID of any process.

Definition at line 131 of file PSimHit.h.

References theProcessType.

Referenced by CkfDebugger::analyseCompatibleMeasurements(), TestHits::analyze(), TestSmoothHits::analyze(), TestOutliers::analyze(), TestTrackHits::analyze(), TrackerHitAssociator::associateHit(), SubsystemNeutronReader::generateChamberNoise(), SiPixelDigitizerAlgorithm::make_digis(), and CkfDebugger::SimHit::processType().

{ return theProcessType; }

setEventId()

void PSimHit::setEventId ( EncodedEventId  e )

inline

Definition at line 121 of file PSimHit.h.

References MillePedeFileConverter_cfg::e, and theEventId.

{ theEventId = e; }

setTof()

void PSimHit::setTof ( float  tof )

inline

Definition at line 133 of file PSimHit.h.

References theTof, and tof().

{ theTof = tof; }

thetaAtEntry()

Geom::Theta<float> PSimHit::thetaAtEntry ( ) const

inline

fast and more accurate access to momentumAtEntry().theta()

Definition at line 63 of file PSimHit.h.

References theThetaAtEntry.

Referenced by SubsystemNeutronReader::generateChamberNoise(), localDirection(), momentumAtEntry(), and CkfDebugger::SimHit::thetaAtEntry().

{ return Geom::Theta<float>(theThetaAtEntry); }

timeOfFlight()

float PSimHit::timeOfFlight ( ) const

inline

Time of flight in nanoseconds from the primary interaction to the entry point. Always positive in a PSimHit, but may become negative in a SimHit due to bunch assignment.

Definition at line 75 of file PSimHit.h.

References tof().

Referenced by CkfDebugger::associated(), ME0SimpleModel::getSimHitBx(), GEMSignalModel::getSimHitBx(), RPCSynchronizer::getSimHitBx(), RPCSynchronizer::getSimHitBxAndTimingForIRPC(), CkfDebugger::nextCorrectHits(), TkAccumulatingSensitiveDetector::sendHit(), and CkfDebugger::SimHit::timeOfFlight().

{ return tof(); }

tof()

float PSimHit::tof ( ) const

inline

deprecated name for timeOfFlight()

Definition at line 78 of file PSimHit.h.

References theTof.

Referenced by SubsystemNeutronReader::generateChamberNoise(), SortByTime::operator()(), setTof(), and timeOfFlight().

{ return theTof; }

trackId()

unsigned int PSimHit::trackId ( ) const

inline

The SimTrack ID of the "mother" track. This may be the actual charged track that produced the hit, or a "mother" of this track, in case the track that produced the hit was not saved as a SimTrack. This ID must be interpreted in the context of the SimEvent to which the PSimHit belongs.

Definition at line 108 of file PSimHit.h.

References theTrackId.

Referenced by CkfDebugger::analyseRecHitExistance(), DTHitAssociator::associateDTHitId(), TrackerHitAssociator::associateHit(), CkfDebugger::correctMeas(), TkAccumulatingSensitiveDetector::createHit(), Phase2OTValidateRecHitBase::fillOTRecHitHistos(), Phase2ITValidateRecHitBase::fillRechitHistos(), SubsystemNeutronReader::generateChamberNoise(), SiPixelDigitizerAlgorithm::make_digis(), FastTrackerRecHitMatcher::produce(), TkAccumulatingSensitiveDetector::sendHit(), CkfDebugger::SimHit::trackId(), and TkAccumulatingSensitiveDetector::updateHit().

{ return theTrackId; }

Friends And Related Function Documentation

TrackingSlaveSD

friend class TrackingSlaveSD

friend

Definition at line 154 of file PSimHit.h.

Member Data Documentation

k_tidOffset

constexpr unsigned int PSimHit::k_tidOffset = 200000000

static

Definition at line 17 of file PSimHit.h.

Referenced by addTrackIdOffset(), offsetTrackId(), originalTrackId(), and SimTrackManager::reallyStoreTracks().

theDetUnitId

unsigned int PSimHit::theDetUnitId

protected

Definition at line 150 of file PSimHit.h.

Referenced by detUnitId().

theEnergyLoss

float PSimHit::theEnergyLoss

protected

Definition at line 140 of file PSimHit.h.

Referenced by UpdatablePSimHit::addEnergyLoss(), energyLoss(), and UpdatablePSimHit::setEnergyLoss().

theEntryPoint

Local3DPoint PSimHit::theEntryPoint

protected

Definition at line 137 of file PSimHit.h.

Referenced by entryPoint(), exitPoint(), localPosition(), UpdatablePSimHit::setEntryPoint(), and UpdatablePSimHit::updateExitPoint().

theEventId

EncodedEventId PSimHit::theEventId

protected

Definition at line 152 of file PSimHit.h.

Referenced by eventId(), and setEventId().

thePabs

float PSimHit::thePabs

protected

Definition at line 139 of file PSimHit.h.

Referenced by pabs().

theParticleType

int PSimHit::theParticleType

protected

Definition at line 145 of file PSimHit.h.

Referenced by particleType().

thePhiAtEntry

float PSimHit::thePhiAtEntry

protected

Definition at line 142 of file PSimHit.h.

Referenced by phiAtEntry().

theProcessType

unsigned short PSimHit::theProcessType

protected

Definition at line 146 of file PSimHit.h.

Referenced by processType().

theSegment

Local3DVector PSimHit::theSegment

protected

Definition at line 138 of file PSimHit.h.

Referenced by exitPoint(), localPosition(), UpdatablePSimHit::setEntryPoint(), and UpdatablePSimHit::updateExitPoint().

theThetaAtEntry

float PSimHit::theThetaAtEntry

protected

Definition at line 141 of file PSimHit.h.

Referenced by thetaAtEntry().

theTof

float PSimHit::theTof

protected

Definition at line 144 of file PSimHit.h.

Referenced by setTof(), and tof().

theTrackId

unsigned int PSimHit::theTrackId

protected

Definition at line 151 of file PSimHit.h.

Referenced by offsetTrackId(), originalTrackId(), UpdatablePSimHit::setTrackId(), and trackId().