sim::MergeSimSourcesUtility Class Reference

#include "MergeSimSources.h"

Public Member Functions
	MergeSimSourcesUtility (std::vector< int > const &)
void	Reset ()
void	MergeMCParticles (std::vector< simb::MCParticle > &, const std::vector< simb::MCParticle > &, size_t)
void	MergeSimChannels (std::vector< sim::SimChannel > &, const std::vector< sim::SimChannel > &, size_t)
void	MergeAuxDetSimChannels (std::vector< sim::AuxDetSimChannel > &, const std::vector< sim::AuxDetSimChannel > &, size_t)
void	MergeSimPhotons (std::vector< sim::SimPhotons > &, const std::vector< sim::SimPhotons > &)
void	MergeSimPhotonsLite (std::vector< sim::SimPhotonsLite > &, const std::vector< sim::SimPhotonsLite > &)
void	MergeSimEnergyDeposits (std::vector< sim::SimEnergyDeposit > &, const std::vector< sim::SimEnergyDeposit > &, size_t) const
void	MergeAuxDetHits (std::vector< sim::AuxDetHit > &, const std::vector< sim::AuxDetHit > &, size_t) const
void	MergeParticleAncestryMaps (std::vector< sim::ParticleAncestryMap > &, const sim::ParticleAncestryMap &, size_t) const
const std::vector< std::vector< size_t > > &	GetMCParticleListMap ()

Private Member Functions
void	UpdateG4TrackIDRange (std::pair< int, int >, size_t)

Static Private Member Functions
static sim::SimEnergyDeposit	offsetSimEnergyDepositTrackID (sim::SimEnergyDeposit const &, int)
static sim::AuxDetHit	offsetAuxDetHitTrackID (sim::AuxDetHit const &, int)
static sim::ParticleAncestryMap	offsetParticleAncestryMapTrackID (sim::ParticleAncestryMap const &, int)

Private Attributes
std::vector< int >	fG4TrackIDOffsets
std::vector< std::pair< int, int > >	fG4TrackIDRanges
std::vector< std::vector< size_t > >	fMCParticleListMap

Detailed Description

Definition at line 29 of file MergeSimSources.h.

Constructor & Destructor Documentation

sim::MergeSimSourcesUtility::MergeSimSourcesUtility

(

std::vector< int > const &

)

Title: MergeSimSources Utility Class Author: Wes Ketchum (wketc.nosp@m.hum@.nosp@m.lanl..nosp@m.gov)

Description: Class that merges different simulation sources together to created a combined sim list. Typically just merges vectors/maps/etc together. But, if anything as a G4 trackID, applies a user-defined offset to those IDs.

Definition at line 18 of file MergeSimSources.cxx.

References Reset().

  : fG4TrackIDOffsets(offsets)
{
  Reset();
}

Member Function Documentation

const std::vector<std::vector<size_t> >& sim::MergeSimSourcesUtility::GetMCParticleListMap ( )

inline

Definition at line 65 of file MergeSimSources.h.

References fMCParticleListMap.

{ return fMCParticleListMap; }

void sim::MergeSimSourcesUtility::MergeAuxDetHits	(	std::vector< sim::AuxDetHit > &	,
		const std::vector< sim::AuxDetHit > &	,
		size_t
	)		const

Definition at line 190 of file MergeSimSources.cxx.

References util::begin(), util::end(), fG4TrackIDOffsets, and offsetAuxDetHitTrackID().

{

  int const offset = fG4TrackIDOffsets.at(source_index);
  auto const offsetAuxDetHitID = [offset](sim::AuxDetHit const& adh) {
    return sim::MergeSimSourcesUtility::offsetAuxDetHitTrackID(adh, offset);
  };

  dest.reserve(dest.size() + src.size());
  std::transform(begin(src), end(src), back_inserter(dest), offsetAuxDetHitID);
}

void sim::MergeSimSourcesUtility::MergeAuxDetSimChannels	(	std::vector< sim::AuxDetSimChannel > &	merged_vector,
		const std::vector< sim::AuxDetSimChannel > &	input_vector,
		size_t	source_index
	)

Definition at line 95 of file MergeSimSources.cxx.

References util::abs(), fG4TrackIDOffsets, and UpdateG4TrackIDRange().

{
  if (source_index >= fG4TrackIDOffsets.size())
    std::runtime_error("ERROR in MergeSimSourcesUtility: Source index out of range!");

  merged_vector.reserve(merged_vector.size() + input_vector.size());

  std::pair<int, int> range_trackID(std::numeric_limits<int>::max(),
                                    std::numeric_limits<int>::min());

  for (auto const& simchannel : input_vector) {
    std::vector<sim::AuxDetSimChannel>::iterator it =
      std::find(merged_vector.begin(), merged_vector.end(), simchannel);

    if (it == merged_vector.end()) {
      merged_vector.emplace_back(simchannel.AuxDetID(), simchannel.AuxDetSensitiveID());
      it = merged_vector.end() - 1;
    }

    // re-make the AuxDetSimChannel with both pairs of AuxDetIDEs
    int offset = fG4TrackIDOffsets[source_index];
    std::vector<sim::AuxDetIDE> all_ides = it->AuxDetIDEs();
    for (const sim::AuxDetIDE& ide : simchannel.AuxDetIDEs()) {
      all_ides.emplace_back(ide, offset);

      auto tid = std::abs(ide.trackID) + offset;

      if (tid < range_trackID.first) range_trackID.first = tid;
      if (tid > range_trackID.second) range_trackID.second = tid;
    }

    *it = sim::AuxDetSimChannel(
      simchannel.AuxDetID(), std::move(all_ides), simchannel.AuxDetSensitiveID());
  }

  UpdateG4TrackIDRange(range_trackID, source_index);
}

void sim::MergeSimSourcesUtility::MergeMCParticles	(	std::vector< simb::MCParticle > &	merged_vector,
		const std::vector< simb::MCParticle > &	input_vector,
		size_t	source_index
	)

Definition at line 34 of file MergeSimSources.cxx.

References util::abs(), fG4TrackIDOffsets, fMCParticleListMap, and UpdateG4TrackIDRange().

{

  if (source_index >= fG4TrackIDOffsets.size())
    std::runtime_error("ERROR in MergeSimSourcesUtility: Source index out of range!");

  fMCParticleListMap[source_index].resize(input_vector.size());
  merged_vector.reserve(merged_vector.size() + input_vector.size());

  std::pair<int, int> range_trackID(std::numeric_limits<int>::max(),
                                    std::numeric_limits<int>::min());

  for (size_t i_p = 0; i_p < input_vector.size(); i_p++) {
    merged_vector.emplace_back(input_vector[i_p], fG4TrackIDOffsets[source_index]);

    fMCParticleListMap[source_index][i_p] = merged_vector.size() - 1;

    if (std::abs(merged_vector.back().TrackId()) < range_trackID.first)
      range_trackID.first = std::abs(merged_vector.back().TrackId());
    if (std::abs(merged_vector.back().TrackId()) > range_trackID.second)
      range_trackID.second = std::abs(merged_vector.back().TrackId());
  }

  UpdateG4TrackIDRange(range_trackID, source_index);
}

void sim::MergeSimSourcesUtility::MergeParticleAncestryMaps	(	std::vector< sim::ParticleAncestryMap > &	,
		const sim::ParticleAncestryMap &	,
		size_t
	)		const

Definition at line 204 of file MergeSimSources.cxx.

References fG4TrackIDOffsets, and offsetParticleAncestryMapTrackID().

{
  const int offset = fG4TrackIDOffsets.at(source_index);

  dest.reserve(dest.size() + 1);
  dest.push_back(offsetParticleAncestryMapTrackID(src, offset));
}

void sim::MergeSimSourcesUtility::MergeSimChannels	(	std::vector< sim::SimChannel > &	merged_vector,
		const std::vector< sim::SimChannel > &	input_vector,
		size_t	source_index
	)

Definition at line 63 of file MergeSimSources.cxx.

References util::abs(), fG4TrackIDOffsets, and UpdateG4TrackIDRange().

{
  if (source_index >= fG4TrackIDOffsets.size())
    std::runtime_error("ERROR in MergeSimSourcesUtility: Source index out of range!");

  merged_vector.reserve(merged_vector.size() + input_vector.size());

  std::pair<int, int> range_trackID(std::numeric_limits<int>::max(),
                                    std::numeric_limits<int>::min());

  for (auto const& simchannel : input_vector) {
    std::vector<sim::SimChannel>::iterator it =
      std::find(merged_vector.begin(), merged_vector.end(), simchannel);

    if (it == merged_vector.end()) {
      merged_vector.emplace_back(simchannel.Channel());
      it = merged_vector.end() - 1;
    }

    std::pair<int, int> thisrange =
      it->MergeSimChannel(simchannel, fG4TrackIDOffsets[source_index]);
    if (std::abs(thisrange.first) < std::abs(range_trackID.first))
      range_trackID.first = std::abs(thisrange.first);
    if (std::abs(thisrange.second) > std::abs(range_trackID.second))
      range_trackID.second = std::abs(thisrange.second);
  }

  UpdateG4TrackIDRange(range_trackID, source_index);
}

void sim::MergeSimSourcesUtility::MergeSimEnergyDeposits	(	std::vector< sim::SimEnergyDeposit > &	,
		const std::vector< sim::SimEnergyDeposit > &	,
		size_t
	)		const

Definition at line 175 of file MergeSimSources.cxx.

References util::begin(), edep, util::end(), fG4TrackIDOffsets, and offsetSimEnergyDepositTrackID().

{

  int const offset = fG4TrackIDOffsets.at(source_index);
  auto const offsetEDepID = [offset](sim::SimEnergyDeposit const& edep) {
    return sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID(edep, offset);
  };

  dest.reserve(dest.size() + src.size());
  std::transform(begin(src), end(src), back_inserter(dest), offsetEDepID);
}

void sim::MergeSimSourcesUtility::MergeSimPhotons	(	std::vector< sim::SimPhotons > &	merged_vector,
		const std::vector< sim::SimPhotons > &	input_vector
	)

Definition at line 136 of file MergeSimSources.cxx.

{

  merged_vector.reserve(merged_vector.size() + input_vector.size());

  for (auto const& simphotons : input_vector) {
    std::vector<sim::SimPhotons>::iterator it =
      std::find(merged_vector.begin(), merged_vector.end(), simphotons);

    if (it == merged_vector.end()) {
      merged_vector.emplace_back(simphotons.OpChannel());
      it = merged_vector.end() - 1;
    }

    *it += simphotons;
  }
}

void sim::MergeSimSourcesUtility::MergeSimPhotonsLite	(	std::vector< sim::SimPhotonsLite > &	merged_vector,
		const std::vector< sim::SimPhotonsLite > &	input_vector
	)

Definition at line 155 of file MergeSimSources.cxx.

{

  merged_vector.reserve(merged_vector.size() + input_vector.size());

  for (auto const& simphotons : input_vector) {
    std::vector<sim::SimPhotonsLite>::iterator it =
      std::find(merged_vector.begin(), merged_vector.end(), simphotons);

    if (it == merged_vector.end()) {
      merged_vector.emplace_back(simphotons.OpChannel);
      it = merged_vector.end() - 1;
    }

    *it += simphotons;
  }
}

sim::AuxDetHit sim::MergeSimSourcesUtility::offsetAuxDetHitTrackID ( sim::AuxDetHit const &  adh, int  offset  )

staticprivate

Definition at line 271 of file MergeSimSources.cxx.

References sim::AuxDetHit::GetEnergyDeposited(), sim::AuxDetHit::GetEntryT(), sim::AuxDetHit::GetEntryX(), sim::AuxDetHit::GetEntryY(), sim::AuxDetHit::GetEntryZ(), sim::AuxDetHit::GetExitMomentumX(), sim::AuxDetHit::GetExitMomentumY(), sim::AuxDetHit::GetExitMomentumZ(), sim::AuxDetHit::GetExitT(), sim::AuxDetHit::GetExitX(), sim::AuxDetHit::GetExitY(), sim::AuxDetHit::GetExitZ(), sim::AuxDetHit::GetID(), and sim::AuxDetHit::GetTrackID().

Referenced by MergeAuxDetHits().

{

  auto tid = (adh.GetTrackID() >= 0) ? (adh.GetTrackID() + offset) : (adh.GetTrackID() - offset);

  return sim::AuxDetHit{
    adh.GetID(), // copy number
    tid,         // g4 track id
    adh.GetEnergyDeposited(),
    adh.GetEntryX(),
    adh.GetEntryY(),
    adh.GetEntryZ(),
    adh.GetEntryT(),
    adh.GetExitX(),
    adh.GetExitY(),
    adh.GetExitZ(),
    adh.GetExitT(),
    adh.GetExitMomentumX(),
    adh.GetExitMomentumY(),
    adh.GetExitMomentumZ(),
  };
} // sim::MergeSimSourcesUtility::offsetAuxDetHitTrackID()

sim::ParticleAncestryMap sim::MergeSimSourcesUtility::offsetParticleAncestryMapTrackID ( sim::ParticleAncestryMap const &  pam, int  offset  )

staticprivate

Definition at line 295 of file MergeSimSources.cxx.

References sim::ParticleAncestryMap::GetMap().

Referenced by MergeParticleAncestryMaps().

{
  std::map<int, std::set<int>> newMap;

  for (auto const& [ancestor, descendants] : pam.GetMap()) {
    const int newAnc = (ancestor >= 0) ? ancestor + offset : ancestor - offset;

    for (auto const& descendant : descendants) {
      const int newDesc = (descendant >= 0) ? descendant + offset : descendant - offset;
      newMap[newAnc].insert(newDesc);
    }
  }

  return sim::ParticleAncestryMap(newMap);
}

sim::SimEnergyDeposit sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID ( sim::SimEnergyDeposit const &  edep, int  offset  )

staticprivate

Definition at line 247 of file MergeSimSources.cxx.

References sim::SimEnergyDeposit::End(), sim::SimEnergyDeposit::Energy(), sim::SimEnergyDeposit::NumElectrons(), sim::SimEnergyDeposit::NumPhotons(), sim::SimEnergyDeposit::OrigTrackID(), sim::SimEnergyDeposit::PdgCode(), sim::SimEnergyDeposit::ScintYieldRatio(), sim::SimEnergyDeposit::Start(), sim::SimEnergyDeposit::T0(), sim::SimEnergyDeposit::T1(), and sim::SimEnergyDeposit::TrackID().

Referenced by MergeSimEnergyDeposits().

{

  auto tid = (edep.TrackID() >= 0) ? (edep.TrackID() + offset) : (edep.TrackID() - offset);
  auto orig_tid =
    (edep.OrigTrackID() >= 0) ? (edep.OrigTrackID() + offset) : (edep.OrigTrackID() - offset);

  return sim::SimEnergyDeposit{
    edep.NumPhotons(),      // np
    edep.NumElectrons(),    // ne
    edep.ScintYieldRatio(), // sy
    edep.Energy(),          // e
    edep.Start(),           // start
    edep.End(),             // end
    edep.T0(),              // t0
    edep.T1(),              // t1
    tid,                    // id
    edep.PdgCode(),         // pdg
    orig_tid                // orig id
  };
} // sim::MergeSimSourcesUtility::offsetTrackID()

void sim::MergeSimSourcesUtility::Reset

(

)

Definition at line 24 of file MergeSimSources.cxx.

References fG4TrackIDOffsets, fG4TrackIDRanges, and fMCParticleListMap.

Referenced by MergeSimSourcesUtility().

{
  fG4TrackIDRanges.clear();
  fG4TrackIDRanges.resize(
    fG4TrackIDOffsets.size(),
    std::make_pair(std::numeric_limits<int>::max(), std::numeric_limits<int>::min()));
  fMCParticleListMap.clear();
  fMCParticleListMap.resize(fG4TrackIDOffsets.size(), std::vector<size_t>());
}

void sim::MergeSimSourcesUtility::UpdateG4TrackIDRange ( std::pair< int, int >  newrange, size_t  source_index  )

private

Definition at line 215 of file MergeSimSources.cxx.

References fG4TrackIDOffsets, and fG4TrackIDRanges.

Referenced by MergeAuxDetSimChannels(), MergeMCParticles(), and MergeSimChannels().

{
  if (source_index >= fG4TrackIDOffsets.size())
    std::runtime_error("ERROR in MergeSimSourcesUtility: Source index out of range!");

  if (newrange.first >= fG4TrackIDRanges[source_index].first &&
      newrange.second <= fG4TrackIDRanges[source_index].second)
    return;

  for (size_t i = 0; i < fG4TrackIDRanges.size(); i++) {
    if (i == source_index) continue;

    if ((newrange.first >= fG4TrackIDRanges[i].first &&
         newrange.first <= fG4TrackIDRanges[i].second) ||
        (newrange.second >= fG4TrackIDRanges[i].first &&
         newrange.second <= fG4TrackIDRanges[i].second)) {
      std::stringstream ss;
      ss << "ERROR in MergeSimSourcesUtility: Source trackIDs overlap!"
         << "\n\t" << i << "\t" << fG4TrackIDRanges[i].first << " " << fG4TrackIDRanges[i].second
         << "\n\t"
         << "n\t" << newrange.first << " " << newrange.second;
      throw std::runtime_error(ss.str());
    }
  }

  if (newrange.first < fG4TrackIDRanges[source_index].first)
    fG4TrackIDRanges[source_index].first = newrange.first;
  if (newrange.second > fG4TrackIDRanges[source_index].second)
    fG4TrackIDRanges[source_index].second = newrange.second;
}

Member Data Documentation

std::vector<int> sim::MergeSimSourcesUtility::fG4TrackIDOffsets

private

Definition at line 68 of file MergeSimSources.h.

Referenced by MergeAuxDetHits(), MergeAuxDetSimChannels(), MergeMCParticles(), MergeParticleAncestryMaps(), MergeSimChannels(), MergeSimEnergyDeposits(), Reset(), and UpdateG4TrackIDRange().

std::vector<std::pair<int, int> > sim::MergeSimSourcesUtility::fG4TrackIDRanges

private

Definition at line 69 of file MergeSimSources.h.

Referenced by Reset(), and UpdateG4TrackIDRange().

std::vector<std::vector<size_t> > sim::MergeSimSourcesUtility::fMCParticleListMap

private

Definition at line 71 of file MergeSimSources.h.

Referenced by GetMCParticleListMap(), MergeMCParticles(), and Reset().

---

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

• larsim/v09_43_00/source/larsim/MergeSimSources/MergeSimSources.h
• larsim/v09_43_00/source/larsim/MergeSimSources/MergeSimSources.cxx