#include "BackTracker.h"

Inheritance diagram for cheat::BackTracker:

Classes
struct	fhiclConfig

Public Member Functions
	BackTracker (const fhiclConfig &config, const cheat::ParticleInventory partInv, const geo::GeometryCore geom)

	BackTracker (const fhicl::ParameterSet &pSet, const cheat::ParticleInventory partInv, const geo::GeometryCore geom)

	BackTracker (BackTracker const &)=delete

template<typename Evt >
void	PrepEvent (const Evt &evt)

template<typename Evt >
void	PrepSimChannels (const Evt &evt)

template<typename Evt >
bool	CanRun (const Evt &evt)

template<typename Evt >
std::vector< art::Ptr< recob::Hit > >	SpacePointToHits_Ps (art::Ptr< recob::SpacePoint > const &spt, const Evt &evt) const

template<typename Evt >
std::vector< double >	SpacePointToXYZ (detinfo::DetectorClocksData const &clockData, art::Ptr< recob::SpacePoint > const &spt, const Evt &evt) const

void	ClearEvent ()

bool	SimChannelsReady () const

const std::vector< art::Ptr< sim::SimChannel > > &	SimChannels () const

std::vector< const sim::IDE * >	TrackIdToSimIDEs_Ps (int const &id) const

std::vector< const sim::IDE * >	TrackIdToSimIDEs_Ps (int const &id, const geo::View_t view) const

art::Ptr< sim::SimChannel >	FindSimChannelPtr (raw::ChannelID_t channel) const
	Returns the cached `sim::SimChannel` on the specified `channel`. More...

art::Ptr< sim::SimChannel >	FindSimChannel (raw::ChannelID_t channel) const
	Returns the cached `sim::SimChannel` on the specified `channel`. More...

std::vector< sim::TrackIDE >	ChannelToTrackIDEs (detinfo::DetectorClocksData const &clockData, raw::ChannelID_t channel, const double hit_start_time, const double hit_end_time) const

std::vector< sim::TrackIDE >	HitToTrackIDEs (detinfo::DetectorClocksData const &clockData, recob::Hit const &hit) const

std::vector< sim::TrackIDE >	HitToTrackIDEs (detinfo::DetectorClocksData const &clockData, art::Ptr< recob::Hit > const &hit) const

std::vector< int >	HitToTrackIds (detinfo::DetectorClocksData const &clockData, recob::Hit const &hit) const

std::vector< sim::TrackIDE >	HitToEveTrackIDEs (detinfo::DetectorClocksData const &clockData, recob::Hit const &hit) const

std::vector< sim::TrackIDE >	HitToEveTrackIDEs (detinfo::DetectorClocksData const &clockData, art::Ptr< recob::Hit > const &hit) const

std::vector< art::Ptr< recob::Hit > >	TrackIdToHits_Ps (detinfo::DetectorClocksData const &clockData, int tkId, std::vector< art::Ptr< recob::Hit >> const &hitsIn) const

std::vector< std::vector< art::Ptr< recob::Hit > > >	TrackIdsToHits_Ps (detinfo::DetectorClocksData const &clockData, std::vector< int > const &tkIds, std::vector< art::Ptr< recob::Hit >> const &hitsIn) const

std::vector< sim::IDE >	HitToAvgSimIDEs (detinfo::DetectorClocksData const &clockData, recob::Hit const &hit) const

std::vector< sim::IDE >	HitToAvgSimIDEs (detinfo::DetectorClocksData const &clockData, art::Ptr< recob::Hit > const &hit) const

std::vector< const sim::IDE * >	HitToSimIDEs_Ps (detinfo::DetectorClocksData const &clockData, recob::Hit const &hit) const

std::vector< const sim::IDE * >	HitToSimIDEs_Ps (detinfo::DetectorClocksData const &clockData, art::Ptr< recob::Hit > const &hit) const

std::vector< double >	SimIDEsToXYZ (std::vector< sim::IDE > const &ides) const

std::vector< double >	SimIDEsToXYZ (std::vector< const sim::IDE * > const &ide_Ps) const

std::vector< double >	HitToXYZ (detinfo::DetectorClocksData const &clockData, const recob::Hit &hit) const

std::vector< double >	HitToXYZ (detinfo::DetectorClocksData const &clockData, art::Ptr< recob::Hit > const &hit) const

double	HitCollectionPurity (detinfo::DetectorClocksData const &clockData, std::set< int > const &trackIds, std::vector< art::Ptr< recob::Hit >> const &hits) const

double	HitChargeCollectionPurity (detinfo::DetectorClocksData const &clockData, std::set< int > const &trackIds, std::vector< art::Ptr< recob::Hit >> const &hits) const

double	HitCollectionEfficiency (detinfo::DetectorClocksData const &clockData, std::set< int > const &trackIds, std::vector< art::Ptr< recob::Hit >> const &hits, std::vector< art::Ptr< recob::Hit >> const &allhits, geo::View_t const &view) const

double	HitChargeCollectionEfficiency (detinfo::DetectorClocksData const &clockData, std::set< int > const &trackIds, std::vector< art::Ptr< recob::Hit >> const &hits, std::vector< art::Ptr< recob::Hit >> const &allhits, geo::View_t const &view) const

std::set< int >	GetSetOfTrackIds () const

std::set< int >	GetSetOfEveIds () const

std::set< int >	GetSetOfTrackIds (detinfo::DetectorClocksData const &clockData, std::vector< art::Ptr< recob::Hit >> const &hits) const

std::set< int >	GetSetOfEveIds (detinfo::DetectorClocksData const &clockData, std::vector< art::Ptr< recob::Hit >> const &hits) const

std::vector< double >	SpacePointHitsToWeightedXYZ (detinfo::DetectorClocksData const &clockData, std::vector< art::Ptr< recob::Hit >> const &hits) const

Private Attributes
const cheat::ParticleInventory *	fPartInv

const geo::GeometryCore *	fGeom

const art::InputTag	fG4ModuleLabel

const art::InputTag	fSimChannelModuleLabel

const art::InputTag	fHitLabel

const double	fMinHitEnergyFraction

const bool	fOverrideRealData

const double	fHitTimeRMS

std::vector< art::Ptr< sim::SimChannel > >	fSimChannels

Detailed Description

Definition at line 39 of file BackTracker.h.

Constructor & Destructor Documentation

cheat::BackTracker::BackTracker	(	const fhiclConfig &	config,
		const cheat::ParticleInventory *	partInv,
		const geo::GeometryCore *	geom
	)

Definition at line 25 of file BackTracker.cc.

     : fPartInv(partInv)
     , fGeom(geom)
     , fG4ModuleLabel(config.G4ModuleLabel())
     , fSimChannelModuleLabel(config.SimChannelModuleLabel())
     , fHitLabel(config.DefaultHitModuleLabel())
     , fMinHitEnergyFraction(config.MinHitEnergyFraction())
     , fOverrideRealData(config.OverrideRealData())
     , fHitTimeRMS(config.HitTimeRMS())
   {}

cheat::BackTracker::BackTracker	(	const fhicl::ParameterSet &	pSet,
		const cheat::ParticleInventory *	partInv,
		const geo::GeometryCore *	geom
	)

Definition at line 39 of file BackTracker.cc.

     : fPartInv(partInv)
     , fGeom(geom)
     , fG4ModuleLabel(pSet.get<art::InputTag>("G4ModuleLabel", "largeant"))
     , fSimChannelModuleLabel(pSet.get<art::InputTag>("SimChannelModuleLabel", fG4ModuleLabel))
     , // -- D.R. if not provided, default behavior is to use the G4ModuleLabel
     fHitLabel(pSet.get<art::InputTag>("DefaultHitModuleLabel", "hitfd"))
     , fMinHitEnergyFraction(pSet.get<double>("MinHitEnergyFraction", 0.010))
     , fOverrideRealData(pSet.get<bool>("OverrideRealData", false))
     , fHitTimeRMS(pSet.get<double>("HitTimeRMS", 1.0))
   {}

cheat::BackTracker::BackTracker ( BackTracker const & )

delete

Member Function Documentation

template<typename Evt >

bool cheat::BackTracker::CanRun ( const Evt & evt )

inline

Definition at line 92 of file BackTracker.h.

References tca::evt.

Referenced by cheat::BackTrackerService::priv_CanRun().

     {
       return !evt.isRealData() || fOverrideRealData;
     }

std::vector< sim::TrackIDE > cheat::BackTracker::ChannelToTrackIDEs	(	detinfo::DetectorClocksData const &	clockData,
		raw::ChannelID_t	channel,
		const double	hit_start_time,
		const double	hit_end_time
	)		const

Definition at line 127 of file BackTracker.cc.

References e, energy, sim::TrackIDE::energy, sim::TrackIDE::energyFrac, FindSimChannelPtr(), sim::NoParticleId, sim::TrackIDE::numElectrons, detinfo::DetectorClocksData::TPCTick2TDC(), sim::TrackIDE::trackID, and sim::SimChannel::TrackIDsAndEnergies().

Referenced by cheat::BackTrackerService::ChannelToTrackIDEs(), GetSetOfTrackIds(), HitToTrackIDEs(), TrackIdsToHits_Ps(), and TrackIdToHits_Ps().

   {
     art::Ptr<sim::SimChannel> schannel = this->FindSimChannelPtr(channel);
     if (!schannel) return {};
 
     std::vector<sim::TrackIDE> trackIDEs;
     double totalE = 0.;
 
     // loop over the electrons in the channel and grab those that are in time
     // with the identified hit start and stop times
     int start_tdc = clockData.TPCTick2TDC(hit_start_time);
     int end_tdc = clockData.TPCTick2TDC(hit_end_time);
     if (start_tdc < 0) start_tdc = 0;
     if (end_tdc < 0) end_tdc = 0;
     std::vector<sim::IDE> simides = schannel->TrackIDsAndEnergies(start_tdc, end_tdc);
 
     // first get the total energy represented by all track ids for
     // this channel and range of tdc values
     for (size_t e = 0; e < simides.size(); ++e)
       totalE += simides[e].energy;
 
     // protect against a divide by zero below
     if (totalE < 1.e-5) totalE = 1.;
 
     // loop over the entries in the map and fill the input vectors
 
     for (size_t e = 0; e < simides.size(); ++e) {
 
       if (simides[e].trackID == sim::NoParticleId) continue;
 
       sim::TrackIDE info;
       info.trackID = simides[e].trackID;
       info.energyFrac = simides[e].energy / totalE;
       info.energy = simides[e].energy;
       info.numElectrons = simides[e].numElectrons;
 
       trackIDEs.push_back(info);
     }
 
     return trackIDEs;
   }

void cheat::BackTracker::ClearEvent ( )

Definition at line 54 of file BackTracker.cc.

References fSimChannels.

Referenced by cheat::BackTrackerService::priv_PrepEvent().

   {
     fSimChannels.clear();
     //    fAllHitList.clear();
   }

art::Ptr< sim::SimChannel > cheat::BackTracker::FindSimChannel ( raw::ChannelID_t channel ) const

Returns the cached sim::SimChannel on the specified channel.

Parameters

channel ID of the TPC channel to find

Returns: art pointer to sim::SimChannel

Exceptions

cet::exception (category: "BackTracker") if no sim::SimChannel for the requested channel found

See also: FindSimChannelPtr()

Definition at line 119 of file BackTracker.cc.

References FindSimChannelPtr().

Referenced by cheat::BackTrackerService::FindSimChannel(), HitToAvgSimIDEs(), and HitToSimIDEs_Ps().

   {
     if (auto const chan = FindSimChannelPtr(channel)) return chan;
     throw cet::exception("BackTracker") << "No sim::SimChannel corresponding "
                                         << "to channel: " << channel << "\n";
   }

art::Ptr< sim::SimChannel > cheat::BackTracker::FindSimChannelPtr ( raw::ChannelID_t channel ) const

Returns the cached sim::SimChannel on the specified channel.

Parameters

channel ID of the TPC channel to find

Returns: art pointer to sim::SimChannel, or an null pointer if none

See also: FindSimChannel()

Definition at line 105 of file BackTracker.cc.

References fSimChannels.

Referenced by ChannelToTrackIDEs(), and FindSimChannel().

   {
     auto ilb = std::lower_bound(fSimChannels.begin(),
                                 fSimChannels.end(),
                                 channel,
                                 [](art::Ptr<sim::SimChannel> const& a, raw::ChannelID_t channel) {
                                   return (a->Channel() < channel);
                                 });
     return ((ilb != fSimChannels.end()) && ((*ilb)->Channel() == channel)) ?
              *ilb :
              art::Ptr<sim::SimChannel>{};
   }

std::set<int> cheat::BackTracker::GetSetOfEveIds ( ) const

inline

Definition at line 228 of file BackTracker.h.

References hits(), and lar::dump::vector().

Referenced by cheat::BackTrackerService::GetSetOfEveIds().

228 { return fPartInv->GetSetOfEveIds(); }

cheat::BackTracker::fPartInv

const cheat::ParticleInventory * fPartInv

Definition: BackTracker.h:240

cheat::ParticleInventory::GetSetOfEveIds

std::set< int > GetSetOfEveIds() const

Definition: ParticleInventory.cc:115

std::set< int > cheat::BackTracker::GetSetOfEveIds	(	detinfo::DetectorClocksData const &	clockData,
		std::vector< art::Ptr< recob::Hit >> const &	hits
	)		const

Definition at line 543 of file BackTracker.cc.

References hits(), and HitToEveTrackIDEs().

   {
     std::set<int> eveIds;
     for (const auto& hit : hits) {
       const std::vector<sim::TrackIDE> ides = this->HitToEveTrackIDEs(clockData, hit);
       for (const auto& ide : ides) {
         eveIds.insert(ide.trackID);
       } // end ides
     }   // End for hits
     return eveIds;
   }

std::set<int> cheat::BackTracker::GetSetOfTrackIds ( ) const

inline

Definition at line 227 of file BackTracker.h.

Referenced by cheat::BackTrackerService::GetSetOfTrackIds().

227 { return fPartInv->GetSetOfTrackIds(); }

cheat::ParticleInventory::GetSetOfTrackIds

std::set< int > GetSetOfTrackIds() const

Definition: ParticleInventory.cc:105

cheat::BackTracker::fPartInv

const cheat::ParticleInventory * fPartInv

Definition: BackTracker.h:240

std::set< int > cheat::BackTracker::GetSetOfTrackIds	(	detinfo::DetectorClocksData const &	clockData,
		std::vector< art::Ptr< recob::Hit >> const &	hits
	)		const

Definition at line 526 of file BackTracker.cc.

References ChannelToTrackIDEs(), util::end(), fHitTimeRMS, and hits().

   {
     std::set<int> tids;
     for (const auto& hit : hits) {
       const double start = hit->PeakTimeMinusRMS(fHitTimeRMS);
       const double end = hit->PeakTimePlusRMS(fHitTimeRMS);
       std::vector<sim::TrackIDE> trackIDEs =
         this->ChannelToTrackIDEs(clockData, hit->Channel(), start, end);
       for (const auto& ide : trackIDEs) {
         tids.insert(ide.trackID);
       } // End for TrackIDEs
     }   // End for hits
     return tids;
   } // End GetSetOfTrackIds

double cheat::BackTracker::HitChargeCollectionEfficiency	(	detinfo::DetectorClocksData const &	clockData,
		std::set< int > const &	trackIds,
		std::vector< art::Ptr< recob::Hit >> const &	hits,
		std::vector< art::Ptr< recob::Hit >> const &	allhits,
		geo::View_t const &	view
	)		const

Definition at line 490 of file BackTracker.cc.

References fMinHitEnergyFraction, hits(), HitToTrackIDEs(), and geo::k3D.

Referenced by cheat::BackTrackerService::HitChargeCollectionEfficiency().

   {
     double desired = 0., total = 0.;
     for (const auto& hit : hits) {
       std::vector<sim::TrackIDE> hitTrackIDEs = this->HitToTrackIDEs(clockData, hit);
       for (const auto& hitIDE : hitTrackIDEs) {
         if (trackIds.find(hitIDE.trackID) != trackIds.end() &&
             hitIDE.energyFrac >= fMinHitEnergyFraction) {
           desired += hit->Integral();
           break;
         } // end if hit id matches and energy sufficient.
       }   // End for IDE in HitTrackIDEs.
     }     // End for hit in hits.
 
     for (const auto& hit : allHits) {
       if (hit->View() != view && view != geo::k3D) { continue; }
       std::vector<sim::TrackIDE> hitTrackIDEs = this->HitToTrackIDEs(clockData, hit);
       for (const auto& hitIDE : hitTrackIDEs) {
         if (trackIds.find(hitIDE.trackID) != trackIds.end() &&
             hitIDE.energyFrac >= fMinHitEnergyFraction) {
           total += hit->Integral();
           break;
         } // end if hit matches
       }   // end for ide in ides
     }     // End for hit in allHits
 
     if (total > 0.) { return desired / total; }
     return 0.;
   }

double cheat::BackTracker::HitChargeCollectionPurity	(	detinfo::DetectorClocksData const &	clockData,
		std::set< int > const &	trackIds,
		std::vector< art::Ptr< recob::Hit >> const &	hits
	)		const

Definition at line 432 of file BackTracker.cc.

References hits(), and HitToTrackIDEs().

Referenced by cheat::BackTrackerService::HitChargeCollectionPurity().

   {
     double totalCharge = 0., desired = 0.;
     for (const auto& hit : hits) {
       totalCharge += hit->Integral();
       std::vector<sim::TrackIDE> trackIDEs = this->HitToTrackIDEs(clockData, hit);
       for (const auto& trackIDE : trackIDEs) {
         if (trackIds.find(trackIDE.trackID) != trackIds.end()) {
           desired += hit->Integral();
           break;
         } // End if trackId in trackIds.
       }   // End for trackIDE in trackIDEs
     }     // End for Hit in Hits
     if (totalCharge > 0.0) { return (desired / totalCharge); }
     return 0.0;
   }

double cheat::BackTracker::HitCollectionEfficiency	(	detinfo::DetectorClocksData const &	clockData,
		std::set< int > const &	trackIds,
		std::vector< art::Ptr< recob::Hit >> const &	hits,
		std::vector< art::Ptr< recob::Hit >> const &	allhits,
		geo::View_t const &	view
	)		const

Definition at line 452 of file BackTracker.cc.

References fMinHitEnergyFraction, hits(), HitToTrackIDEs(), and geo::k3D.

Referenced by cheat::BackTrackerService::HitCollectionEfficiency().

   {
 
     int desired = 0, total = 0;
 
     for (const auto& hit : hits) {
       std::vector<sim::TrackIDE> hitTrackIDEs = this->HitToTrackIDEs(clockData, hit);
       for (const auto& trackIDE : hitTrackIDEs) {
         if (trackIds.find(trackIDE.trackID) != trackIds.end() &&
             trackIDE.energyFrac >= fMinHitEnergyFraction) {
           ++desired;
           break;
         } // End if trackID in trackIds.
       }   // end for trackIDE in TrackIDEs
     }     // end for hit in hits
 
     for (const auto& hit : allHits) {
       if (hit->View() != view && view != geo::k3D) {
         continue;
       } // End if hit.view = view or view = geo::k3D
       std::vector<sim::TrackIDE> hitTrackIDEs = this->HitToTrackIDEs(clockData, hit);
       for (const auto& hitIDE : hitTrackIDEs) {
         if (trackIds.find(hitIDE.trackID) != trackIds.end() &&
             hitIDE.energyFrac >= fMinHitEnergyFraction) {
           ++total;
           break;
         }
       } // END for all IDEs in HitTrackIDEs.
     }   // end for hit in allHits.
     if (total >= 0) { return double(double(desired) / double(total)); }
     return 0.;
   }

double cheat::BackTracker::HitCollectionPurity	(	detinfo::DetectorClocksData const &	clockData,
		std::set< int > const &	trackIds,
		std::vector< art::Ptr< recob::Hit >> const &	hits
	)		const

Definition at line 413 of file BackTracker.cc.

References hits(), and HitToTrackIDEs().

Referenced by cheat::BackTrackerService::HitCollectionPurity().

   {
     int desired = 0;
     for (const auto& hit : hits) {
       std::vector<sim::TrackIDE> hitTrackIDEs = this->HitToTrackIDEs(clockData, hit);
       for (const auto& tIDE : hitTrackIDEs) {
         if (trackIds.find(tIDE.trackID) != trackIds.end()) {
           ++desired;
           break;
         } // End if TID Found
       }   // END for trackIDE in TrackIDEs
     }     // End for hit in hits
     if (hits.size() > 0) { return double(double(desired) / double(hits.size())); }
     return 0;
   }

std::vector< sim::IDE > cheat::BackTracker::HitToAvgSimIDEs	(	detinfo::DetectorClocksData const &	clockData,
		recob::Hit const &	hit
	)		const

Definition at line 304 of file BackTracker.cc.

References recob::Hit::Channel(), fHitTimeRMS, FindSimChannel(), recob::Hit::PeakTimeMinusRMS(), recob::Hit::PeakTimePlusRMS(), and detinfo::DetectorClocksData::TPCTick2TDC().

Referenced by cheat::BackTrackerService::HitToAvgSimIDEs().

   {
     // Get services.
 
     int start_tdc = clockData.TPCTick2TDC(hit.PeakTimeMinusRMS(fHitTimeRMS));
     int end_tdc = clockData.TPCTick2TDC(hit.PeakTimePlusRMS(fHitTimeRMS));
     if (start_tdc < 0) start_tdc = 0;
     if (end_tdc < 0) end_tdc = 0;
 
     return (this->FindSimChannel(hit.Channel()))->TrackIDsAndEnergies(start_tdc, end_tdc);
   }

std::vector<sim::IDE> cheat::BackTracker::HitToAvgSimIDEs	(	detinfo::DetectorClocksData const &	clockData,
		art::Ptr< recob::Hit > const &	hit
	)		const

inline

Definition at line 183 of file BackTracker.h.

     {
       return this->HitToAvgSimIDEs(clockData, *hit);
     }

std::vector< sim::TrackIDE > cheat::BackTracker::HitToEveTrackIDEs	(	detinfo::DetectorClocksData const &	clockData,
		recob::Hit const &	hit
	)		const

Definition at line 196 of file BackTracker.cc.

References sim::TrackIDE::energy, sim::TrackIDE::energyFrac, fPartInv, HitToTrackIDEs(), sim::TrackIDE::numElectrons, sim::TrackIDE::trackID, and cheat::ParticleInventory::TrackIdToEveTrackId().

Referenced by GetSetOfEveIds(), and cheat::BackTrackerService::HitToEveTrackIDEs().

   {
     std::vector<sim::TrackIDE> eveIDEs;
     std::vector<sim::TrackIDE> trackIDEs = this->HitToTrackIDEs(clockData, hit);
     std::map<int, std::pair<double, double>> eveToEMap;
     double totalE = 0.0;
     for (const auto& trackIDE : trackIDEs) {
       auto check = eveToEMap.emplace(fPartInv->TrackIdToEveTrackId(trackIDE.trackID),
                                      std::make_pair(trackIDE.energy, trackIDE.numElectrons));
       if (check.second == false) {
         check.first->second.first += trackIDE.energy;
         check.first->second.second += trackIDE.numElectrons;
       }
       //      eveToEMap[fPartInv->TrackIdToEveTrackId(trackIDE.trackID)].first
       //      += trackIDE.energy;
       totalE += trackIDE.energy;
     } // End for trackIDEs
     eveIDEs.reserve(eveToEMap.size());
     for (const auto& eveToE : eveToEMap) {
       sim::TrackIDE eveTrackIDE_tmp;
 
       eveTrackIDE_tmp.trackID = eveToE.first;
       eveTrackIDE_tmp.energy = eveToE.second.first;
       eveTrackIDE_tmp.energyFrac = (eveTrackIDE_tmp.energy) / (totalE);
       eveTrackIDE_tmp.numElectrons = eveToE.second.second;
 
       eveIDEs.push_back(eveTrackIDE_tmp);
     } // END eveToEMap loop
     return eveIDEs;
   }

std::vector<sim::TrackIDE> cheat::BackTracker::HitToEveTrackIDEs	(	detinfo::DetectorClocksData const &	clockData,
		art::Ptr< recob::Hit > const &	hit
	)		const

inline

Definition at line 163 of file BackTracker.h.

References lar::dump::vector().

     {
       return this->HitToEveTrackIDEs(clockData, *hit);
     }

std::vector< const sim::IDE * > cheat::BackTracker::HitToSimIDEs_Ps	(	detinfo::DetectorClocksData const &	clockData,
		recob::Hit const &	hit
	)		const

Definition at line 318 of file BackTracker.cc.

References recob::Hit::Channel(), fHitTimeRMS, FindSimChannel(), recob::Hit::PeakTimeMinusRMS(), recob::Hit::PeakTimePlusRMS(), and detinfo::DetectorClocksData::TPCTick2TDC().

Referenced by cheat::BackTrackerService::HitToSimIDEs_Ps(), and HitToXYZ().

   {
     std::vector<const sim::IDE*> retVec;
     int start_tdc = clockData.TPCTick2TDC(hit.PeakTimeMinusRMS(fHitTimeRMS));
     int end_tdc = clockData.TPCTick2TDC(hit.PeakTimePlusRMS(fHitTimeRMS));
     if (start_tdc < 0) start_tdc = 0;
     if (end_tdc < 0) end_tdc = 0;
 
     if (start_tdc > end_tdc) { throw; }
 
     const std::vector<std::pair<unsigned short, std::vector<sim::IDE>>>& tdcIDEMap =
       (this->FindSimChannel(hit.Channel()))
         ->TDCIDEMap(); // This in fact does not return a std::map. It returns a
                        // vector... with no guarantee that it is sorted...
     std::vector<const std::pair<unsigned short, std::vector<sim::IDE>>*> tdcIDEMap_SortedPointers;
     for (auto& pair : tdcIDEMap) {
       tdcIDEMap_SortedPointers.push_back(&pair);
     }
 
     // This is a bunch of extra steps, due to needing a vector we can sort, and
     // needing those items in the sorted vector to be the items from the sim
     // channels (so a pointer to the IDEs inside the sim channels can be made).
     // The work around is to make a vector of pointers to IDEs inside the
     // TDCIDEMap (which is a constant reference to the fTDCIDEs in the
     // SimChannel.)
     auto pairSort = [](auto& a, auto& b) { return a->first < b->first; };
     if (!std::is_sorted(
           tdcIDEMap_SortedPointers.begin(), tdcIDEMap_SortedPointers.end(), pairSort)) {
       std::sort(tdcIDEMap_SortedPointers.begin(), tdcIDEMap_SortedPointers.end(), pairSort);
     }
 
     std::vector<sim::IDE> dummyVec; // I need something to stick in a pair to compare pair<tdcVal,
                                     // IDE>. This is an otherwise useless "hack".
     std::pair<double, std::vector<sim::IDE>> start_tdcPair =
       std::make_pair(start_tdc, dummyVec); // This pair is a "hack" to make my comparison work
                                            // for lower and upper bound.
     std::pair<double, std::vector<sim::IDE>> end_tdcPair = std::make_pair(end_tdc, dummyVec);
     auto start_tdcPair_P = &start_tdcPair;
     auto end_tdcPair_P = &end_tdcPair;
     auto mapFirst = std::lower_bound(
       tdcIDEMap_SortedPointers.begin(), tdcIDEMap_SortedPointers.end(), start_tdcPair_P, pairSort);
 
     // iterator to just after the last interesting IDE
     auto mapLast = std::upper_bound(
       tdcIDEMap_SortedPointers.begin(), tdcIDEMap_SortedPointers.end(), end_tdcPair_P, pairSort);
     for (auto& mapitr = mapFirst; mapitr != mapLast; ++mapitr) {
       for (auto& ide : (*mapitr)->second) {
         retVec.push_back(&ide);
       } // Add all interesting IDEs to the retVec
     }
     return retVec;
   }

std::vector<const sim::IDE*> cheat::BackTracker::HitToSimIDEs_Ps	(	detinfo::DetectorClocksData const &	clockData,
		art::Ptr< recob::Hit > const &	hit
	)		const

inline

Definition at line 191 of file BackTracker.h.

     {
       return this->HitToSimIDEs_Ps(clockData, *hit);
     }

std::vector< sim::TrackIDE > cheat::BackTracker::HitToTrackIDEs	(	detinfo::DetectorClocksData const &	clockData,
		recob::Hit const &	hit
	)		const

Definition at line 174 of file BackTracker.cc.

References recob::Hit::Channel(), ChannelToTrackIDEs(), util::end(), fHitTimeRMS, recob::Hit::PeakTimeMinusRMS(), and recob::Hit::PeakTimePlusRMS().

Referenced by HitChargeCollectionEfficiency(), HitChargeCollectionPurity(), HitCollectionEfficiency(), HitCollectionPurity(), HitToEveTrackIDEs(), cheat::BackTrackerService::HitToTrackIDEs(), and HitToTrackIds().

   {
     const double start = hit.PeakTimeMinusRMS(fHitTimeRMS);
     const double end = hit.PeakTimePlusRMS(fHitTimeRMS);
     return this->ChannelToTrackIDEs(clockData, hit.Channel(), start, end);
   }

std::vector<sim::TrackIDE> cheat::BackTracker::HitToTrackIDEs	(	detinfo::DetectorClocksData const &	clockData,
		art::Ptr< recob::Hit > const &	hit
	)		const

inline

Definition at line 150 of file BackTracker.h.

     {
       return this->HitToTrackIDEs(clockData, *hit);
     }

std::vector< int > cheat::BackTracker::HitToTrackIds	(	detinfo::DetectorClocksData const &	clockData,
		recob::Hit const &	hit
	)		const

Definition at line 184 of file BackTracker.cc.

References HitToTrackIDEs().

Referenced by cheat::BackTrackerService::HitToTrackIds().

   {
     std::vector<int> retVec;
     for (auto const trackIDE : this->HitToTrackIDEs(clockData, hit)) {
       retVec.push_back(trackIDE.trackID);
     }
     return retVec;
   }

std::vector< double > cheat::BackTracker::HitToXYZ	(	detinfo::DetectorClocksData const &	clockData,
		const recob::Hit &	hit
	)		const

Definition at line 405 of file BackTracker.cc.

References HitToSimIDEs_Ps(), and SimIDEsToXYZ().

Referenced by cheat::BackTrackerService::HitToXYZ(), and SpacePointHitsToWeightedXYZ().

   {
     std::vector<const sim::IDE*> ide_Ps = this->HitToSimIDEs_Ps(clockData, hit);
     return this->SimIDEsToXYZ(ide_Ps);
   }

std::vector<double> cheat::BackTracker::HitToXYZ	(	detinfo::DetectorClocksData const &	clockData,
		art::Ptr< recob::Hit > const &	hit
	)		const

inline

Definition at line 202 of file BackTracker.h.

References hits(), and lar::dump::vector().

     {
       return this->HitToXYZ(clockData, *hit);
     }

template<typename Evt >

void cheat::BackTracker::PrepEvent ( const Evt & evt )

template<typename Evt >

void cheat::BackTracker::PrepSimChannels ( const Evt & evt )

Referenced by cheat::BackTrackerService::priv_PrepSimChannels().

const std::vector<art::Ptr<sim::SimChannel> >& cheat::BackTracker::SimChannels ( ) const

inline

Definition at line 113 of file BackTracker.h.

Referenced by cheat::BackTrackerService::SimChannels().

113 { return fSimChannels; }

cheat::BackTracker::fSimChannels

std::vector< art::Ptr< sim::SimChannel > > fSimChannels

Definition: BackTracker.h:249

bool cheat::BackTracker::SimChannelsReady ( ) const

inline

Definition at line 111 of file BackTracker.h.

111 { return !fSimChannels.empty(); }

cheat::BackTracker::fSimChannels

std::vector< art::Ptr< sim::SimChannel > > fSimChannels

Definition: BackTracker.h:249

std::vector< double > cheat::BackTracker::SimIDEsToXYZ ( std::vector< sim::IDE > const & ides ) const

Definition at line 374 of file BackTracker.cc.

References e, w, and weight.

Referenced by HitToXYZ(), cheat::BackTrackerService::SimIDEsToXYZ(), and SimIDEsToXYZ().

   {
     std::vector<double> xyz(3, 0.0);
     double w = 0.0;
     for (auto const& ide : ides) {
       double weight = ide.numElectrons;
       w += weight;
       xyz[0] += (weight * ide.x);
       xyz[1] += (weight * ide.y);
       xyz[2] += (weight * ide.z);
     }
     if (w < 1.e-5)
       throw cet::exception("BackTracker") << "No sim::IDEs providing non-zero number of electrons"
                                           << " can't determine originating location from truth\n";
     xyz[0] = xyz[0] / w;
     xyz[1] = xyz[1] / w;
     xyz[2] = xyz[2] / w;
     return xyz;
   }

std::vector< double > cheat::BackTracker::SimIDEsToXYZ ( std::vector< const sim::IDE * > const & ide_Ps ) const

Definition at line 395 of file BackTracker.cc.

References SimIDEsToXYZ().

   {
     std::vector<sim::IDE> ides;
     for (auto ide_P : ide_Ps) {
       ides.push_back(*ide_P);
     }
     return this->SimIDEsToXYZ(ides);
   }

std::vector< double > cheat::BackTracker::SpacePointHitsToWeightedXYZ	(	detinfo::DetectorClocksData const &	clockData,
		std::vector< art::Ptr< recob::Hit >> const &	hits
	)		const

Definition at line 558 of file BackTracker.cc.

References geo::CryostatID::Cryostat, fGeom, hits(), HitToXYZ(), recob::Hit::Integral(), geo::GeometryCore::Ncryostats(), geo::GeometryCore::Nplanes(), geo::GeometryCore::NTPC(), geo::PlaneID::Plane, geo::GeometryCore::PositionToTPCID(), geo::TPCID::TPC, and recob::Hit::WireID().

Referenced by cheat::BackTrackerService::SpacePointHitsToWeightedXYZ().

   {
     std::vector<std::vector<std::vector<int>>> numHits(fGeom->Ncryostats());
     std::vector<std::vector<std::vector<double>>> hitWeight(fGeom->Ncryostats());
     std::vector<std::vector<std::vector<std::vector<double>>>> hitPos(fGeom->Ncryostats());
     // Do we need to resize everything...
     for (size_t c = 0; c < numHits.size(); ++c) {
       geo::CryostatID const cid(c);
       numHits[c].resize(fGeom->NTPC(cid));
       hitWeight[c].resize(fGeom->NTPC(cid));
       hitPos[c].resize(fGeom->NTPC(cid));
       for (size_t t = 0; t < numHits[c].size(); ++t) {
         geo::TPCID const tpcid(cid, t);
         numHits[c][t].resize(fGeom->Nplanes(tpcid));
         hitWeight[c][t].resize(fGeom->Nplanes(tpcid));
         hitPos[c][t].resize(fGeom->Nplanes(tpcid));
       }
     }
 
     for (auto const& hit_ptr : hits) {
       const recob::Hit& hit = *hit_ptr;
 
       // use the HitToXYZ and Geometry::PositionToTPC
       // to figure out which drift volume the hit originates from
       std::vector<double> hitOrigin = this->HitToXYZ(clockData, hit_ptr);
       geo::Point_t const worldLoc{hitOrigin[0], hitOrigin[1], hitOrigin[2]};
       auto const tpcid = fGeom->PositionToTPCID(worldLoc);
 
       auto const [cstat, tpc] = std::make_tuple(tpcid.Cryostat, tpcid.TPC);
 
       if (hit.WireID().Cryostat == cstat && hit.WireID().TPC == tpc) {
         ++numHits[cstat][tpc][hit.WireID().Plane];
         hitWeight[cstat][tpc][hit.WireID().Plane] = hit.Integral();
         hitPos[cstat][tpc][hit.WireID().Plane] = hitOrigin;
       }
     }
 
     // loop over the vectors we made and find the average position for the hits
     // in the future we might take a weighted average
     int nhits = 0;
     std::vector<double> xyz(3);
     for (size_t c = 0; c < numHits.size(); ++c) {
       for (size_t t = 0; t < numHits[c].size(); ++t) {
         for (size_t p = 0; p < numHits[c][t].size(); ++p) {
 
           if (numHits[c][t][p] == 1) {
             ++nhits;
             xyz[0] += hitPos[c][t][p][0];
             xyz[1] += hitPos[c][t][p][1];
             xyz[2] += hitPos[c][t][p][2];
           }
 
         } // end loop over planes
       }   // end loop over tpcs
     }     // end loop over cryostats
 
     // get the average position
     if (nhits < 1)
       throw cet::exception("BackTracker")
         << "No hits to determine originating location from truth\n";
 
     xyz[0] /= nhits;
     xyz[1] /= nhits;
     xyz[2] /= nhits;
 
     // Done.
     return xyz;
   }

template<typename Evt >

std::vector<art::Ptr<recob::Hit> > cheat::BackTracker::SpacePointToHits_Ps	(	art::Ptr< recob::SpacePoint > const &	spt,
		const Evt &	evt
	)		const

Referenced by cheat::BackTrackerService::SpacePointToHits_Ps().

template<typename Evt >

std::vector<double> cheat::BackTracker::SpacePointToXYZ	(	detinfo::DetectorClocksData const &	clockData,
		art::Ptr< recob::SpacePoint > const &	spt,
		const Evt &	evt
	)		const

Referenced by cheat::BackTrackerService::SpacePointToXYZ().

std::vector< std::vector< art::Ptr< recob::Hit > > > cheat::BackTracker::TrackIdsToHits_Ps	(	detinfo::DetectorClocksData const &	clockData,
		std::vector< int > const &	tkIds,
		std::vector< art::Ptr< recob::Hit >> const &	hitsIn
	)		const

Definition at line 259 of file BackTracker.cc.

References recob::Hit::Channel(), ChannelToTrackIDEs(), fHitTimeRMS, fMinHitEnergyFraction, recob::Hit::PeakTimeMinusRMS(), and recob::Hit::PeakTimePlusRMS().

Referenced by cheat::BackTrackerService::TrackIdsToHits_Ps().

   {
     // returns a subset of the hits in the hitsIn collection that are matched
     // to MC particles listed in tkIds
 
     // temporary vector of TrackIds and Ptrs to hits so only one
     // loop through the (possibly large) hitsIn collection is needed
     std::vector<std::pair<int, art::Ptr<recob::Hit>>> hitList;
     std::vector<sim::TrackIDE> tids;
     for (auto itr = hitsIn.begin(); itr != hitsIn.end(); ++itr) {
       tids.clear();
       art::Ptr<recob::Hit> const& hit = *itr;
       tids = this->ChannelToTrackIDEs(clockData,
                                       hit->Channel(),
                                       hit->PeakTimeMinusRMS(fHitTimeRMS),
                                       hit->PeakTimePlusRMS(fHitTimeRMS));
       for (auto itid = tids.begin(); itid != tids.end(); ++itid) {
         for (auto itkid = tkIds.begin(); itkid != tkIds.end(); ++itkid) {
           if (itid->trackID == *itkid) {
             if (itid->energyFrac > fMinHitEnergyFraction)
               hitList.push_back(std::make_pair(*itkid, hit));
           }
         } // itkid
       }   // itid
     }     // itr
 
     // now build the truHits vector that will be returned to the caller
     std::vector<std::vector<art::Ptr<recob::Hit>>> truHits;
     // temporary vector containing hits assigned to one MC particle
     std::vector<art::Ptr<recob::Hit>> tmpHits;
     for (auto itkid = tkIds.begin(); itkid != tkIds.end(); ++itkid) {
       tmpHits.clear();
       for (auto itr = hitList.begin(); itr != hitList.end(); ++itr) {
         if (*itkid == (*itr).first) tmpHits.push_back((*itr).second);
       }
       truHits.push_back(tmpHits);
     }
     return truHits;
   }

std::vector< art::Ptr< recob::Hit > > cheat::BackTracker::TrackIdToHits_Ps	(	detinfo::DetectorClocksData const &	clockData,
		int	tkId,
		std::vector< art::Ptr< recob::Hit >> const &	hitsIn
	)		const

Definition at line 230 of file BackTracker.cc.

References recob::Hit::Channel(), ChannelToTrackIDEs(), fHitTimeRMS, fMinHitEnergyFraction, recob::Hit::PeakTimeMinusRMS(), and recob::Hit::PeakTimePlusRMS().

Referenced by cheat::BackTrackerService::TrackIdToHits_Ps().

   {
     // returns a subset of the hits in the hitsIn collection that are matched
     // to the given track
 
     // temporary vector of TrackIds and Ptrs to hits so only one
     // loop through the (possibly large) hitsIn collection is needed
     std::vector<art::Ptr<recob::Hit>> hitList;
     std::vector<sim::TrackIDE> trackIDE;
     for (auto itr = hitsIn.begin(); itr != hitsIn.end(); ++itr) {
       trackIDE.clear();
       art::Ptr<recob::Hit> const& hit = *itr;
       trackIDE = this->ChannelToTrackIDEs(clockData,
                                           hit->Channel(),
                                           hit->PeakTimeMinusRMS(fHitTimeRMS),
                                           hit->PeakTimePlusRMS(fHitTimeRMS));
       for (auto itr_trakIDE = trackIDE.begin(); itr_trakIDE != trackIDE.end(); ++itr_trakIDE) {
         if (itr_trakIDE->trackID == tkId && itr_trakIDE->energyFrac > fMinHitEnergyFraction)
           hitList.push_back(hit);
       } // itr_trakIDE
     }   // itr
     return hitList;
   }

std::vector< const sim::IDE * > cheat::BackTracker::TrackIdToSimIDEs_Ps ( int const & id ) const

Definition at line 61 of file BackTracker.cc.

References util::abs(), fSimChannels, and sc.

Referenced by cheat::BackTrackerService::TrackIdToSimIDEs_Ps().

   {
     std::vector<const sim::IDE*> ideps;
     for (size_t sc = 0; sc < fSimChannels.size(); ++sc) {
       const auto& tdcidemap = fSimChannels[sc]->TDCIDEMap(); // This returns a reference.
       // loop over the IDEMAP
       for (auto mapitr = tdcidemap.begin(); mapitr != tdcidemap.end(); mapitr++) {
         // loop over the vector of IDE objects.
         const std::vector<sim::IDE>& idevec =
           (*mapitr).second; // note, mapitr.second returns the actual data from
                             // the map, not a copy
         for (size_t iv = 0; iv < idevec.size(); ++iv) {
           // const sim::IDE* const idep = &idevec[iv];
           // if( abs(idevec[iv].trackID) == id) continue;
           // ideps.push_back(idep);
           if (abs(idevec[iv].trackID) == id) ideps.push_back(&(idevec[iv]));
         } // end for index in idevec
       }   // end loop over map from sim::SimChannel
     }     // end loop over sim::SimChannels
     return ideps;
   }

std::vector< const sim::IDE * > cheat::BackTracker::TrackIdToSimIDEs_Ps	(	int const &	id,
		const geo::View_t	view
	)		const

Definition at line 84 of file BackTracker.cc.

References util::abs(), fGeom, fSimChannels, sc, sim::IDE::trackID, and geo::GeometryCore::View().

   {
     std::vector<const sim::IDE*> ide_Ps;
     for (const art::Ptr<sim::SimChannel> sc : fSimChannels) {
       if (fGeom->View(sc->Channel()) != view) continue;
 
       // loop over the IDEMAP
       for (const auto& item : sc->TDCIDEMap()) {
 
         // loop over the vector of IDE objects.
         for (const sim::IDE& ide : item.second) {
           if (abs(ide.trackID) == id) ide_Ps.push_back(&ide);
         }
       } // end loop over map from sim::SimChannel
     }   // end loop over sim::SimChannels
 
     return ide_Ps;
   }

Member Data Documentation

const art::InputTag cheat::BackTracker::fG4ModuleLabel

private

Definition at line 242 of file BackTracker.h.

const geo::GeometryCore* cheat::BackTracker::fGeom

private

Definition at line 241 of file BackTracker.h.

Referenced by SpacePointHitsToWeightedXYZ(), and TrackIdToSimIDEs_Ps().

const art::InputTag cheat::BackTracker::fHitLabel

private

Definition at line 244 of file BackTracker.h.

const double cheat::BackTracker::fHitTimeRMS

private

Definition at line 247 of file BackTracker.h.

Referenced by GetSetOfTrackIds(), HitToAvgSimIDEs(), HitToSimIDEs_Ps(), HitToTrackIDEs(), TrackIdsToHits_Ps(), and TrackIdToHits_Ps().

const double cheat::BackTracker::fMinHitEnergyFraction

private

Definition at line 245 of file BackTracker.h.

Referenced by HitChargeCollectionEfficiency(), HitCollectionEfficiency(), TrackIdsToHits_Ps(), and TrackIdToHits_Ps().

const bool cheat::BackTracker::fOverrideRealData

private

Definition at line 246 of file BackTracker.h.

const cheat::ParticleInventory* cheat::BackTracker::fPartInv

private

Definition at line 240 of file BackTracker.h.

Referenced by HitToEveTrackIDEs().

const art::InputTag cheat::BackTracker::fSimChannelModuleLabel

private

Definition at line 243 of file BackTracker.h.

std::vector<art::Ptr<sim::SimChannel> > cheat::BackTracker::fSimChannels

mutableprivate

Definition at line 249 of file BackTracker.h.

Referenced by ClearEvent(), FindSimChannelPtr(), and TrackIdToSimIDEs_Ps().

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

larsim/v09_43_00/source/larsim/MCCheater/BackTracker.h
larsim/v09_43_00/source/larsim/MCCheater/BackTracker.cc

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation