TruthMatchUtils.h File Reference

Utilities for matching a recob::Hit or vector of recob::Hit to the ID of the most significantly contributing G4 particle. Various functions using different definitions of 'most significantly contributing' are provided. More...

#include "canvas/Persistency/Common/Ptr.h"
#include <map>
#include <vector>

Go to the source code of this file.

Namespaces
	recob
	Reconstruction base classes.
	detinfo
	General LArSoft Utilities.
	TruthMatchUtils

Typedefs
typedef int	TruthMatchUtils::G4ID
typedef float	TruthMatchUtils::EDeposit
typedef std::map< G4ID, EDeposit >	TruthMatchUtils::IDToEDepositMap

Functions
bool	TruthMatchUtils::Valid (const G4ID g4ID) noexcept
	Test whether a G4ID returned by the TruthMatchUtils functions is valid. More...
G4ID	TruthMatchUtils::TrueParticleID (detinfo::DetectorClocksData const &clockData, const art::Ptr< recob::Hit > &pHit, const bool rollupUnsavedIDs)
	The G4 ID of the true particle which deposits the most energy in the recob::Hit. More...
G4ID	TruthMatchUtils::TrueParticleIDFromTotalTrueEnergy (detinfo::DetectorClocksData const &clockData, const std::vector< art::Ptr< recob::Hit >> &pHits, const bool rollupUnsavedIDs)
	The G4 ID of the true particle which deposits the most energy in a vector of recob::Hit. More...
G4ID	TruthMatchUtils::TrueParticleIDFromTotalRecoCharge (detinfo::DetectorClocksData const &clockData, const std::vector< art::Ptr< recob::Hit >> &pHits, const bool rollupUnsavedIDs)
	The G4 ID of the true particle whose matched hits have produced the largest amount of reconstructed charge in a recob::Hit vector. More...
G4ID	TruthMatchUtils::TrueParticleIDFromTotalRecoHits (detinfo::DetectorClocksData const &clockData, const std::vector< art::Ptr< recob::Hit >> &pHits, const bool rollupUnsavedIDs)
	The G4 ID of the true particle who has been truth-matched to the most hits in a recob::Hit vector. More...
void	TruthMatchUtils::FillG4IDToEnergyDepositMap (IDToEDepositMap &idToEDepMap, detinfo::DetectorClocksData const &clockData, const art::Ptr< recob::Hit > &pHit, const bool rollupUnsavedIDs)
	Fill an energy deposition map (maps G4 ID to true energy deposition) for a recob::Hit. More...

Detailed Description

Utilities for matching a recob::Hit or vector of recob::Hit to the ID of the most significantly contributing G4 particle. Various functions using different definitions of 'most significantly contributing' are provided.

Author

Dom Brailsford (d.bra.nosp@m.ilsf.nosp@m.ord@l.nosp@m.anca.nosp@m.ster..nosp@m.ac.u.nosp@m.k)

log:

Definition in file TruthMatchUtils.h.