sim::OBTRHelper Class Reference

#include "OpDetBacktrackerRecord.h"

Public Types
typedef double	timePDclock_t
typedef SDP::TrackID_t	TrackID_t

Public Member Functions
	OBTRHelper (TrackID_t trackID)
void	AddScintillationPhotonsToMap (TrackID_t trackID, timePDclock_t iTimePDclock, double numberPhotons, double const *xyz, double energy)

Private Attributes
std::map< timePDclock_t, std::vector< sim::SDP > >	fTimePDclockSDPs
TrackID_t	fTrackID

Friends
class	OpDetBacktrackerRecord

Detailed Description

Definition at line 88 of file OpDetBacktrackerRecord.h.

Member Typedef Documentation

typedef double sim::OBTRHelper::timePDclock_t

Definition at line 92 of file OpDetBacktrackerRecord.h.

typedef SDP::TrackID_t sim::OBTRHelper::TrackID_t

Definition at line 93 of file OpDetBacktrackerRecord.h.

Constructor & Destructor Documentation

sim::OBTRHelper::OBTRHelper ( TrackID_t  trackID )

inline

Definition at line 95 of file OpDetBacktrackerRecord.h.

References sim::TrackSDP::energy, and sim::TrackSDP::trackID.

: fTrackID(trackID) {}

Member Function Documentation

void sim::OBTRHelper::AddScintillationPhotonsToMap	(	TrackID_t	trackID,
		timePDclock_t	iTimePDclock,
		double	numberPhotons,
		double const *	xyz,
		double	energy
	)

The iTimePDclock from OpFastScintillation (where OpDetBacktrackerRecords originate) is done with CLHEP::ns (units of nanoseconds).

Definition at line 25 of file OpDetBacktrackerRecord.cxx.

References energy, fTimePDclockSDPs, MF_LOG_ERROR, and weight.

  {
    // look at the collection to see if the current iTimePDclock already
    // exists, if not, add it, if so, just add a new track id to the
    // vector, or update the information if track is already present

    // no photons? no good!
    if ((numberPhotons < std::numeric_limits<double>::epsilon()) ||
        (energy <= std::numeric_limits<double>::epsilon())) {
      // will throw
      MF_LOG_ERROR("OpDetBacktrackerRecord")
        << "AddTrackPhotons() trying to add to iTimePDclock #" << iTimePDclock << " "
        << numberPhotons << " photons with " << energy
        << " MeV of energy from track ID=" << trackID;
      return;
    } // if no photons

    int rounded_time = std::round(iTimePDclock);

    auto itr = fTimePDclockSDPs.lower_bound(rounded_time);

    // check if this iTimePDclock value is in the vector, it is possible that
    // the lower bound is different from the given TimePDclock, in which case
    // we need to add something for that TimePDclock
    if (itr == fTimePDclockSDPs.end() || fTimePDclockSDPs.key_comp()(rounded_time, itr->first)) {
      fTimePDclockSDPs.insert(
        {rounded_time,
         std::vector<sim::SDP>{sim::SDP(trackID, numberPhotons, energy, xyz[0], xyz[1], xyz[2])}});
    }
    else { // we have that iTimePDclock already; itr points to it

      // loop over the SDP vector for this iTimePDclock and add the electrons
      // to the entry with the same track id
      for (auto& sdp : itr->second) {

        if (sdp.trackID != trackID) continue;

        // make a weighted average for the location information
        double weight = sdp.numPhotons + numberPhotons;
        sdp.x = (sdp.x * sdp.numPhotons + xyz[0] * numberPhotons) / weight;
        sdp.y = (sdp.y * sdp.numPhotons + xyz[1] * numberPhotons) / weight;
        sdp.z = (sdp.z * sdp.numPhotons + xyz[2] * numberPhotons) / weight;
        sdp.numPhotons = weight;
        sdp.energy = sdp.energy + energy;

        // found the track id we wanted, so return;
        return;
      } // for

      // if we never found the track id, then this is the first instance of
      // the track id for this TimePDclock, so add sdp to the vector
      itr->second.emplace_back(trackID, numberPhotons, energy, xyz[0], xyz[1], xyz[2]);

    } // end of else "We have that iTimePDclock already"

  } // OBTRHelper::AddIonizationElectrons()

Friends And Related Function Documentation

friend class OpDetBacktrackerRecord

friend

Definition at line 89 of file OpDetBacktrackerRecord.h.

Member Data Documentation

std::map<timePDclock_t, std::vector<sim::SDP> > sim::OBTRHelper::fTimePDclockSDPs

private

Definition at line 106 of file OpDetBacktrackerRecord.h.

Referenced by AddScintillationPhotonsToMap(), and sim::OpDetBacktrackerRecord::OpDetBacktrackerRecord().

TrackID_t sim::OBTRHelper::fTrackID

private

Definition at line 107 of file OpDetBacktrackerRecord.h.

---

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

• lardataobj/v10_01_00/source/lardataobj/Simulation/OpDetBacktrackerRecord.h
• lardataobj/v10_01_00/source/lardataobj/Simulation/OpDetBacktrackerRecord.cxx