TruthMatchUtils Namespace Reference

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

Functions
bool	Valid (const G4ID g4ID) noexcept
	Test whether a G4ID returned by the TruthMatchUtils functions is valid. More...
G4ID	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	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	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	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	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...

Typedef Documentation

typedef float TruthMatchUtils::EDeposit

Definition at line 28 of file TruthMatchUtils.h.

typedef int TruthMatchUtils::G4ID

Definition at line 27 of file TruthMatchUtils.h.

typedef std::map<G4ID, EDeposit> TruthMatchUtils::IDToEDepositMap

Definition at line 29 of file TruthMatchUtils.h.

Function Documentation

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.

Parameters

idToEDepMap	the energy deposition map to be filled
pHit	the recob::Hit to be assessed
rollupUnsavedIDs	whether to squash energy deposits for non-saved G4 particles (e.g. shower secondaries) its saved ancestor particle

Definition at line 168 of file TruthMatchUtils.cc.

{
  const art::ServiceHandle<cheat::BackTrackerService> btServ;
  const std::vector<sim::TrackIDE> trackIDEs(btServ->HitToTrackIDEs(clockData, pHit));
  if (trackIDEs.empty()) return;

  for (const sim::TrackIDE& trackIDE : trackIDEs) {
    const G4ID g4ID(
      static_cast<G4ID>(rollupUnsavedIDs ? std::abs(trackIDE.trackID) : trackIDE.trackID));
    const EDeposit eDep(static_cast<EDeposit>(trackIDE.energy));
    auto [iterator, inserted] = idToEDepMap.try_emplace(g4ID, eDep);
    if (!inserted) iterator->second += eDep;
  }

  if (idToEDepMap.empty()) {
    throw art::Exception(art::errors::LogicError)
      << "TruthMatchUtils::FillG4IDToEnergyDepositMap did not fill the IDToEDepositMap map (map "
         "size == "
      << idToEDepMap.size() << ")."
      << "  The sim::TrackIDE vector size is " << trackIDEs.size()
      << ".  The IDToEDepositMap should not be empty when the"
      << " sim::TrackIDE vector is also not empty.  Something has gone wrong.";
  }

  return;
}

TruthMatchUtils::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.

Parameters

pHit	the recob::Hit to be assessed
rollupUnsavedIDs	whether to squash energy deposits for non-saved G4 particles (e.g. shower secondaries) its saved ancestor particle

Returns

the ID of the G4 particle

Definition at line 65 of file TruthMatchUtils.cc.

{
  IDToEDepositMap idToEDepMap;
  TruthMatchUtils::FillG4IDToEnergyDepositMap(idToEDepMap, clockData, pHit, rollupUnsavedIDs);
  if (idToEDepMap.empty()) return kInvalidG4ID;

  return MaxEDepElementInMap(idToEDepMap)->first;
}

TruthMatchUtils::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.

Parameters

pHits	the recob::Hit vector to be assessed
rollupUnsavedIDs	whether to squash energy deposits for non-saved G4 particles (e.g. shower secondaries) its saved ancestor particle

Returns

the ID of the G4 particle

Definition at line 95 of file TruthMatchUtils.cc.

{
  IDToEDepositMap idToChargeDepMap;
  for (const art::Ptr<recob::Hit>& pHit : pHits) {
    const G4ID g4ID(TruthMatchUtils::TrueParticleID(clockData, pHit, rollupUnsavedIDs));
    const EDeposit recoCharge(static_cast<EDeposit>(pHit->Integral()));
    auto [iterator, inserted] = idToChargeDepMap.try_emplace(g4ID, recoCharge);
    if (!inserted) iterator->second += recoCharge;
  }

  if (idToChargeDepMap.empty()) return kInvalidG4ID;

  return MaxEDepElementInMap(idToChargeDepMap)->first;
}

TruthMatchUtils::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.

Parameters

pHits	the recob::Hit vector to be assessed
rollupUnsavedIDs	whether to squash energy deposits for non-saved G4 particles (e.g. shower secondaries) its saved ancestor particle

Returns

the ID of the G4 particle

Definition at line 115 of file TruthMatchUtils.cc.

{
  std::map<G4ID, unsigned int> idToHitCountMap;
  for (const art::Ptr<recob::Hit>& pHit : pHits) {
    const G4ID g4ID(TruthMatchUtils::TrueParticleID(clockData, pHit, rollupUnsavedIDs));
    auto [iterator, inserted] = idToHitCountMap.try_emplace(g4ID, 1);
    if (!(inserted)) iterator->second++;
  }

  if (idToHitCountMap.empty()) return kInvalidG4ID;

  std::map<unsigned int, std::vector<G4ID>> hitCountToIDMap;
  for (auto const& [g4ID, hitCount] : idToHitCountMap) {
    auto [iterator, inserted] = hitCountToIDMap.try_emplace(hitCount, std::vector<G4ID>{g4ID});
    if (!inserted) iterator->second.emplace_back(g4ID);
  }

  if (hitCountToIDMap.empty()) {
    throw art::Exception(art::errors::LogicError)
      << "TruthMatchUtils::TrueParticleIDFromTotalRecoHits - Did not fill the hit count to g4 ID "
         "vector map"
      << "(map size == " << hitCountToIDMap.size() << ")."
      << "  The G4 ID to hit count map size is " << idToHitCountMap.size()
      << ".  The hit count to G4 ID vector map should not be empty in this case."
      << "  Something has gone wrong.";
  }

  std::map<unsigned int, std::vector<G4ID>>::const_reverse_iterator lastElementIt(
    hitCountToIDMap.rbegin());
  unsigned int nMaxContributingIDs(lastElementIt->second.size());

  if (0 == nMaxContributingIDs) {
    throw art::Exception(art::errors::LogicError)
      << "TruthMatchUtils::TrueParticleIDFromTotalRecoHits - Counted a max number of contributing "
         "hits ("
      << lastElementIt->first << " hits) but did not find any G4 IDs.  Something has gone wrong.";
  }
  else if (1 < nMaxContributingIDs) {
    mf::LogInfo("TruthMatchUtils::TrueParticleIDFromTotalRecoHits")
      << "There are " << nMaxContributingIDs
      << " particles which tie for highest number of contributing hits (" << lastElementIt->first
      << " hits).  Using TruthMatchUtils::TrueParticleIDFromTotalTrueEnergy instead." << std::endl;
    return TruthMatchUtils::TrueParticleIDFromTotalTrueEnergy(clockData, pHits, rollupUnsavedIDs);
  }

  return lastElementIt->second.front();
}

TruthMatchUtils::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.

Parameters

pHits	the recob::Hit vector to be assessed
rollupUnsavedIDs	whether to squash energy deposits for non-saved G4 particles (e.g. shower secondaries) its saved ancestor particle

Returns

the ID of the G4 particle

Definition at line 79 of file TruthMatchUtils.cc.

{
  IDToEDepositMap idToEDepMap;
  for (const art::Ptr<recob::Hit>& pHit : pHits)
    TruthMatchUtils::FillG4IDToEnergyDepositMap(idToEDepMap, clockData, pHit, rollupUnsavedIDs);

  if (idToEDepMap.empty()) return kInvalidG4ID;

  return MaxEDepElementInMap(idToEDepMap)->first;
}

bool TruthMatchUtils::Valid ( const G4ID  g4ID )

noexcept

Test whether a G4ID returned by the TruthMatchUtils functions is valid.

Parameters

g4ID	the G4ID to be tested

Returns

validity bool

Definition at line 57 of file TruthMatchUtils.cc.

{
  return kInvalidG4ID != g4ID;
}