sim::ParticleNavigator Class Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-24/Simulation/ParticleNavigator.h"

Public Types
typedef std::map< int, sim::Particle * >	list_type
typedef list_type::key_type	key_type
typedef list_type::mapped_type	mapped_type
typedef list_type::value_type	value_type
typedef list_type::iterator	iterator
typedef list_type::const_iterator	const_iterator
typedef list_type::reverse_iterator	reverse_iterator
typedef list_type::const_reverse_iterator	const_reverse_iterator
typedef list_type::size_type	size_type
typedef list_type::difference_type	difference_type
typedef list_type::key_compare	key_compare
typedef list_type::allocator_type	allocator_type

Public Member Functions
	ParticleNavigator ()
	ParticleNavigator (const std::vector< sim::Particle > &parts)
virtual	~ParticleNavigator ()
	ParticleNavigator (const ParticleNavigator &rhs)
ParticleNavigator &	operator= (const ParticleNavigator &rhs)
void	Cut (const double &)
const key_type &	TrackId (const size_type) const
mapped_type	Particle (const size_type) const
mapped_type	Particle (const size_type)
bool	IsPrimary (int trackID) const
int	NumberOfPrimaries () const
const sim::Particle *	Primary (const int) const
sim::Particle *	Primary (const int)
ParticleNavigator	Add (const int &offset) const
ParticleNavigator	operator+ (const int &value) const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const
size_type	size () const
bool	empty () const
void	swap (ParticleNavigator &other)
iterator	find (const key_type &key)
const_iterator	find (const key_type &key) const
iterator	upper_bound (const key_type &key)
const_iterator	upper_bound (const key_type &key) const
iterator	lower_bound (const key_type &key)
const_iterator	lower_bound (const key_type &key) const
mapped_type	operator[] (const key_type &key) const
mapped_type	operator[] (const key_type &key)
mapped_type	at (const key_type &key)
mapped_type	at (const key_type &key) const
void	insert (sim::Particle *value)
void	Add (sim::Particle *value)
void	clear ()
size_type	erase (const key_type &key)
int	EveId (const int trackID) const

Static Public Member Functions
static void	AdoptEveIdCalculator (EveIdCalculator *)

Private Types
typedef std::set< int >	primaries_type
typedef primaries_type::iterator	primaries_iterator
typedef primaries_type::const_iterator	primaries_const_iterator

Private Attributes
list_type	fParticleList
	Sorted list of particles in the event. More...
primaries_type	fPrimaries
	Sorted list of the track IDs of primary particles. More...

Friends
ParticleNavigator	operator+ (const int &value, const ParticleNavigator &list)
std::ostream &	operator<< (std::ostream &output, const ParticleNavigator &)

Detailed Description

A container for particles generated during an event simulation. It acts like a map<int,Particle*> but with additional features:

• A method Cut(double) that will remove all particles with energy less than the argument.
• Methods TrackId(int) and Particle(int) for those who are unfamiliar with the concepts associated with STL maps: sim::ParticleNavigator* particleList = // ...; int numberOfParticles = particleList->size(); for (int i=0; i<numberOfParticles; ++i) { int trackID = particleList->TrackId(i); sim::Particle* particle = particleList->Particle(i); } The STL equivalent to the above statements (more efficient): sim::ParticleNavigator* particleList = // ...; for ( sim::ParticleNavigator::const_iterator i = particleList->begin(); i != particleList->end(); ++i ) { const sim::Particle* particle = (*i).second; int trackID = particle->TrackId(); // or... int trackID = (*i).first; }

• Methods to access the list of primary particles in the event: sim::ParticleNavigator particleList = // ...; int numberOfPrimaries = particleList->NumberOfPrimaries(); for ( int i = 0; i != numberOfPrimaries; ++i ) { sim::Particle* particle = particleList->Primary(i); ... } There's also a simple test: int trackID = // ...; if ( particleList->IsPrimary(trackID) ) {...}

  (Aside: note that particleList[i] does NOT give you the "i-th" particle in the list; it gives you the particle whose trackID is "i".)

  • A method EveId(int) to determine the "eve ID" (or ultimate mother) for a given particle. For more information, including how to supply your own eve ID calculation, see Simulation/EveIdCalculator.h and Simulation/EmEveIdCalculator.h.
• If you use the clear() or erase() methods, the list will also delete the underlying Particle*. (This means that if you use insert() or Add() to add a particle to the list, the ParticleNavigator will take over management of it. Don't delete the pointer yourself!)
• Print() and operator<< methods for ROOT display and ease of debugging.

Definition at line 76 of file ParticleNavigator.h.

Member Typedef Documentation

typedef list_type::allocator_type sim::ParticleNavigator::allocator_type

Definition at line 92 of file ParticleNavigator.h.

typedef list_type::const_iterator sim::ParticleNavigator::const_iterator

Definition at line 86 of file ParticleNavigator.h.

typedef list_type::const_reverse_iterator sim::ParticleNavigator::const_reverse_iterator

Definition at line 88 of file ParticleNavigator.h.

typedef list_type::difference_type sim::ParticleNavigator::difference_type

Definition at line 90 of file ParticleNavigator.h.

typedef list_type::iterator sim::ParticleNavigator::iterator

Definition at line 85 of file ParticleNavigator.h.

typedef list_type::key_compare sim::ParticleNavigator::key_compare

Definition at line 91 of file ParticleNavigator.h.

typedef list_type::key_type sim::ParticleNavigator::key_type

Definition at line 82 of file ParticleNavigator.h.

typedef std::map<int,sim::Particle*> sim::ParticleNavigator::list_type

Definition at line 81 of file ParticleNavigator.h.

typedef list_type::mapped_type sim::ParticleNavigator::mapped_type

Definition at line 83 of file ParticleNavigator.h.

typedef primaries_type::const_iterator sim::ParticleNavigator::primaries_const_iterator

private

Definition at line 197 of file ParticleNavigator.h.

typedef primaries_type::iterator sim::ParticleNavigator::primaries_iterator

private

Definition at line 196 of file ParticleNavigator.h.

typedef std::set< int > sim::ParticleNavigator::primaries_type

private

Definition at line 195 of file ParticleNavigator.h.

typedef list_type::reverse_iterator sim::ParticleNavigator::reverse_iterator

Definition at line 87 of file ParticleNavigator.h.

typedef list_type::size_type sim::ParticleNavigator::size_type

Definition at line 89 of file ParticleNavigator.h.

typedef list_type::value_type sim::ParticleNavigator::value_type

Definition at line 84 of file ParticleNavigator.h.

Constructor & Destructor Documentation

sim::ParticleNavigator::ParticleNavigator

(

)

Definition at line 37 of file ParticleNavigator.cxx.

  {
  }  

sim::ParticleNavigator::ParticleNavigator ( const std::vector< sim::Particle > &  parts )

explicit

Definition at line 42 of file ParticleNavigator.cxx.

References Add().

  {
    for(size_t p = 0; p < parts.size(); ++p) Add(new sim::Particle(parts[p]));
  }

sim::ParticleNavigator::~ParticleNavigator ( )

virtual

Definition at line 49 of file ParticleNavigator.cxx.

References clear().

  {
    this->clear();
  }

sim::ParticleNavigator::ParticleNavigator

(

const ParticleNavigator &

rhs

)

Definition at line 57 of file ParticleNavigator.cxx.

References clear(), HTMLTools::entry(), fParticleList, and insert().

  {
    // Clear any contents that we already possess.
    this->clear();
    
    // Copy each entry in the other ParticleNavigator.
    for ( const_iterator entry = rhs.fParticleList.begin();
          entry != rhs.fParticleList.end(); ++entry ){
      const sim::Particle* original = (*entry).second;
      sim::Particle* copy = new sim::Particle( *original );
      this->insert( copy );
    }
  }

Member Function Documentation

ParticleNavigator sim::ParticleNavigator::Add

(

const int &

offset

)

const

Definition at line 189 of file ParticleNavigator.cxx.

References simb::MCParticle::AddDaughter(), simb::MCParticle::AddTrajectoryPoint(), d, simb::MCParticle::Daughter(), fParticleList, MECModelEnuComparisons::i, insert(), simb::MCParticle::Mass(), simb::MCParticle::Momentum(), simb::MCParticle::Mother(), simb::MCParticle::NumberDaughters(), simb::MCParticle::NumberTrajectoryPoints(), PandAna.reco_validation.add_data::offset, simb::MCParticle::PdgCode(), simb::MCParticle::Polarization(), simb::MCParticle::Position(), simb::MCParticle::Process(), fillBadChanDBTables::result, simb::MCParticle::SetPolarization(), confusionMatrixTree::t, and simb::MCParticle::TrackId().

Referenced by nuesand::FillNueSandbox::GetECF(), operator+(), ParticleNavigator(), g4n::ParticleListAction::PreTrackingAction(), and cheat::BackTracker::Rebuild().

  {
    // Start with a fresh ParticleNavigator, the destination of the
    // particles with adjusted track numbers.
    ParticleNavigator result;

    // For each particle in our list:
    for ( const_iterator i = fParticleList.begin(); i != fParticleList.end(); ++i ){
      const sim::Particle* particle = (*i).second;
      
      // Create a new particle with an adjusted track ID.
      sim::Particle* adjusted = new sim::Particle( particle->TrackId() + offset,
                                                   particle->PdgCode(),
                                                   particle->Process(),
                                                   particle->Mother(),
                                                   particle->Mass() );
      
      adjusted->SetPolarization( particle->Polarization() );
      
      // Copy all the daughters, adjusting the track ID.
      for ( int d = 0; d < particle->NumberDaughters(); ++d ){
        int daughterID = particle->Daughter(d);
        adjusted->AddDaughter( daughterID + offset );
      }
      
      // Copy the trajectory points.
      for ( size_t t = 0; t < particle->NumberTrajectoryPoints(); ++t ){
        adjusted->AddTrajectoryPoint( particle->Position(t), particle->Momentum(t) );
      }
      
      // Add the adjusted particle to the destination particle list.
      // This will also adjust the destination's list of primary
      // particles, if needed.
      result.insert( adjusted );
    }
    
    return result;
  }

void sim::ParticleNavigator::Add ( sim::Particle *  value )

inline

Definition at line 177 of file ParticleNavigator.h.

References AdoptEveIdCalculator(), clear(), erase(), EveId(), insert(), operator<<, output, and trackID.

{ insert(value); }

void sim::ParticleNavigator::AdoptEveIdCalculator ( EveIdCalculator *  calc )

static

Set a pointer to a different eve ID calculation. The name begins with "Adopt" because it accepts control of the ponters; do NOT delete the pointer yourself if you use this method.

Definition at line 367 of file ParticleNavigator.cxx.

Referenced by Add(), and EveId().

  {
    eveIdCalculator.reset(calc);
  }

mapped_type sim::ParticleNavigator::at ( const key_type &  key )

inline

Definition at line 168 of file ParticleNavigator.h.

References operator[]().

{ return operator[](key); }

mapped_type sim::ParticleNavigator::at ( const key_type &  key ) const

inline

Definition at line 169 of file ParticleNavigator.h.

References insert(), and operator[]().

{ return operator[](key); }

iterator sim::ParticleNavigator::begin ( )

inline

Definition at line 136 of file ParticleNavigator.h.

References fParticleList.

Referenced by cheat::TestTrackIds::analyze(), ve::VertexEva::analyze(), ddt::SMMEff::analyze(), ddt::SMMADC::analyze(), mcchk::ShowerAnaCheck::analyze(), zcl::SMMTriggerAna::analyze(), mcchk::MonopoleAna::analyze(), mcchk::CosmicAna::analyze(), vf::TrackEva::analyze(), zcl::MMCheater::analyze(), zcl::FmmTriggerAna::analyze(), zcl::FmmTrackerValidation::analyze(), ddt::SlicerEva::analyze(), zcl::FastMMStudy::analyze(), ddt::SuperDDTEva::analyze(), htk::HoughTrack::analyze(), g4n::ParticleListAction::EndOfEventAction(), bsf::BremShowerFilter::findShowerByTruth(), g4n::ParticleListAction::GetList(), evd::MCTrueView::LoadEvent(), evd::SimulationDrawer::MCTruthTrajectoriesAnyD(), sim::operator<<(), novaddt::UpMuAna::populateFLSmap(), zcl::SMMCluster::produce(), and cheat::MCCheater::produce().

{ return fParticleList.begin();  }

const_iterator sim::ParticleNavigator::begin ( ) const

inline

Definition at line 137 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.begin();  }

void sim::ParticleNavigator::clear

(

)

Definition at line 270 of file ParticleNavigator.cxx.

References fParticleList, fPrimaries, and MECModelEnuComparisons::i.

Referenced by Add(), ncs::NCAna::analyze(), g4n::ParticleListAction::BeginOfEventAction(), operator=(), ParticleNavigator(), cheat::BackTracker::Rebuild(), and ~ParticleNavigator().

  {
    for ( iterator i = fParticleList.begin(); i != fParticleList.end(); ++i ){
      delete (*i).second;
    }

    fParticleList.clear();
    fPrimaries.clear();

    eveIdCalculator.reset();

    return;
  }

void sim::ParticleNavigator::Cut

(

const double &

cut

)

Apply an energy threshold cut to the particles in the list, removing all those that fall below the cut.

Definition at line 94 of file ParticleNavigator.cxx.

References simb::MCParticle::E(), erase(), fParticleList, and MECModelEnuComparisons::i.

  {
    // The safest way to do this is to create a list of track IDs that
    // fail the cut, then delete those IDs.
    
    // Define a list of IDs.
    typedef std::set< key_type > keyList_type;
    keyList_type keyList;
    
    // Add each ID that fails the cut to the list.
    for ( const_iterator i = fParticleList.begin(); i != fParticleList.end(); ++i ){
      const sim::Particle* particle = (*i).second;
      Double_t totalInitialEnergy = particle->E();
      if ( totalInitialEnergy < cut ) { 
        keyList.insert( (*i).first ); 
      }
    }
    
    // Go through the list, deleting the particles that are on the list.
    for ( keyList_type::const_iterator i = keyList.begin(); i != keyList.end(); ++i ){
      this->erase( *i );
    }
  }

bool sim::ParticleNavigator::empty ( ) const

inline

Definition at line 146 of file ParticleNavigator.h.

References fParticleList.

Referenced by mono::Monopole::analyze().

{ return fParticleList.empty(); }

iterator sim::ParticleNavigator::end ( )

inline

Definition at line 138 of file ParticleNavigator.h.

References fParticleList.

Referenced by cheat::TestTrackIds::analyze(), ve::VertexEva::analyze(), ddt::SMMEff::analyze(), ddt::SMMADC::analyze(), zcl::SMMTriggerAna::analyze(), mcchk::ShowerAnaCheck::analyze(), mcchk::MonopoleAna::analyze(), mcchk::CosmicAna::analyze(), vf::TrackEva::analyze(), zcl::MMCheater::analyze(), zcl::FmmTriggerAna::analyze(), ddt::SlicerEva::analyze(), zcl::FmmTrackerValidation::analyze(), zcl::FastMMStudy::analyze(), ddt::SuperDDTEva::analyze(), htk::HoughTrack::analyze(), g4n::ParticleListAction::EndOfEventAction(), bsf::BremShowerFilter::findShowerByTruth(), sn::SupernovaMCCluster::GetDaughters(), g4n::ParticleListAction::GetList(), evd::MCTrueView::LoadEvent(), evd::SimulationDrawer::MCTruthTrajectoriesAnyD(), sim::operator<<(), sim::ParticleHistory::ParticleHistory(), novaddt::UpMuAna::populateFLSmap(), g4n::ParticleListAction::PostTrackingAction(), g4n::ParticleListAction::PreTrackingAction(), evd::SimulationDrawer::PrintParticleAndOffspring(), cheat::ClusterCheater::produce(), zcl::SMMCluster::produce(), cheat::MCCheater::produce(), and cheat::BackTracker::TrackIDToParticle().

{ return fParticleList.end();    }

const_iterator sim::ParticleNavigator::end ( ) const

inline

Definition at line 139 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.end();    }

ParticleNavigator::size_type sim::ParticleNavigator::erase

(

const key_type &

key

)

Definition at line 286 of file ParticleNavigator.cxx.

References HTMLTools::entry(), and fParticleList.

Referenced by Add(), and Cut().

  {
    iterator entry = fParticleList.find( key );
    delete (*entry).second;
    return fParticleList.erase( key );
  }

int sim::ParticleNavigator::EveId

(

const int

trackID

)

const

Definition at line 341 of file ParticleNavigator.cxx.

References AdoptEveIdCalculator(), and sim::EveIdCalculator::Init().

Referenced by Add(), calib::ParticleCorrections::analyze(), showere::ShowerEnergyAna::analyze(), slid::LIDTraining::analyze(), showere::ShowerEnergyFilterMC::filter(), filter::TruthFilter::produce(), cheat::MCCheater::produce(), and cheat::BackTracker::TrackIDToMotherParticle().

  {
    // If the eve ID calculator has never been initialized, use the
    // default method.
    if ( eveIdCalculator.get() == 0 ){
      AdoptEveIdCalculator( new EveIdCalculator );
    }

    // If the eve ID calculator has changed, or we're looking at a
    // different ParticleNavigator, initialize the calculator.
    static EveIdCalculator* saveEveIdCalculator = 0;
    if ( saveEveIdCalculator != eveIdCalculator.get() ) {
      saveEveIdCalculator = eveIdCalculator.get();
      eveIdCalculator->Init( this );
    }
    if ( eveIdCalculator->ParticleNavigator() != this ){
      eveIdCalculator->Init( this );
    }
    
    // After the "bookkeeping" tests, here's where we actually do the
    // calculation.
    return eveIdCalculator->CalculateEveId( trackID );
  }

iterator sim::ParticleNavigator::find ( const key_type &  key )

inline

Definition at line 149 of file ParticleNavigator.h.

References fParticleList.

Referenced by cheat::TestTrackIds::analyze(), cheat::CheckBackTracking::CheckTrackIdToParticle(), sn::SupernovaMCCluster::GetDaughters(), cheat::BackTracker::MCTruthToParticles(), sim::ParticleHistory::ParticleHistory(), g4n::ParticleListAction::PostTrackingAction(), g4n::ParticleListAction::PreTrackingAction(), evd::SimulationDrawer::PrintParticleAndOffspring(), cheat::ClusterCheater::produce(), and cheat::BackTracker::TrackIDToParticle().

{ return fParticleList.find(key); }

const_iterator sim::ParticleNavigator::find ( const key_type &  key ) const

inline

Definition at line 150 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.find(key); }

void sim::ParticleNavigator::insert

(

sim::Particle *

value

)

These two methods (insert and Add) do the same thing:

• Add the Particle to the list, using the track ID as the key.
• Update the list of primary particles as needed. Note that when you insert a Particle* into a ParticleNavigator, it takes over management of the pointer. Don't delete it yourself!

Definition at line 242 of file ParticleNavigator.cxx.

References fParticleList, fPrimaries, simb::MCParticle::Process(), simb::MCParticle::TrackId(), and trackID.

Referenced by Add(), at(), operator=(), and ParticleNavigator().

  { 
    int trackID = particle->TrackId();
    iterator insertion = fParticleList.lower_bound( trackID );
    if ( insertion == fParticleList.end() ){
      // The best "hint" we can give is that the particle will go at
      // the end of the list.
      fParticleList.insert( insertion, value_type( trackID, particle ) );
    }
    else if ( (*insertion).first == trackID ){
      throw cet::exception("ParticleNavigator") << "sim::ParticleNavigator::insert - ERROR - "
                                                << "track ID=" << trackID 
                                                << " is already in the list";
    }
    else{
      // It turns out that the best hint we can give is one more
      // than the result of lower_bound.
      fParticleList.insert( ++insertion, value_type( trackID, particle ) );
    }

    // If this is a primary particle, add it to the list. Look to see
    // if the process name contains the string rimary - leave the 
    // "p" off cause it might be capitalized, but then again maybe not
    if ( particle->Process().find("rimary") != std::string::npos )
      fPrimaries.insert( trackID );
  }

bool sim::ParticleNavigator::IsPrimary

(

int

trackID

)

const

Definition at line 143 of file ParticleNavigator.cxx.

References fPrimaries.

Referenced by cheat::TestTrackIds::analyze(), mcchk::LeptonAna::analyze(), sim::ParticleHistory::ParticleHistory(), and cvn::ProngClassify().

  {
    return fPrimaries.find( trackID )  !=  fPrimaries.end();
  }

iterator sim::ParticleNavigator::lower_bound ( const key_type &  key )

inline

Definition at line 153 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.lower_bound(key); }

const_iterator sim::ParticleNavigator::lower_bound ( const key_type &  key ) const

inline

Definition at line 154 of file ParticleNavigator.h.

References fParticleList, findDuplicateFiles::key, and operator[]().

{ return fParticleList.lower_bound(key); }

int sim::ParticleNavigator::NumberOfPrimaries

(

)

const

Definition at line 149 of file ParticleNavigator.cxx.

References fPrimaries.

Referenced by mcchk::LeptonAna::analyze(), ncs::NCAna::analyze(), sn::SupernovaMCCluster::BuildInteractionTrackIDMap(), trk::CosmicTrackAna::FillEventMCTruthHistograms(), murem::MuonRemove::FillTruthInfo(), tut::TutFilter::filter(), nuesand::FillNueSandbox::GetECF(), evd::SimulationDrawer::MCTruthLongText(), tut::TutProducer::produce(), murem::MuonRemove::RemoveByEfficiency(), and murem::MuonRemove::RemoveByTruth().

  {
    return fPrimaries.size();
  }

ParticleNavigator sim::ParticleNavigator::operator+ ( const int &  value ) const

inline

Definition at line 124 of file ParticleNavigator.h.

References Add(), and parse_dependency_file_t::list.

    {
      return Add(value);
    }

ParticleNavigator & sim::ParticleNavigator::operator=

(

const ParticleNavigator &

rhs

)

Definition at line 73 of file ParticleNavigator.cxx.

References clear(), HTMLTools::entry(), fParticleList, and insert().

  {
    // Usual test for self-assignment.
    if ( this == &rhs ) return *this;
    
    // Clear any contents that we already possess.
    this->clear();
    
    // Copy each entry in the other ParticleNavigator.
    for ( const_iterator entry = rhs.fParticleList.begin();
          entry != rhs.fParticleList.end(); ++entry ){
      const sim::Particle* original = (*entry).second;
      sim::Particle* copy = new sim::Particle( *original );
      this->insert( copy );
    }
    
    return *this;
  }

ParticleNavigator::mapped_type sim::ParticleNavigator::operator[]

(

const key_type &

key

)

const

Be careful when using operator[] here! It takes the track ID as the argument: sim::ParticleNavigator partList; const sim::Particle* = partList[3]; The above line means the particle with trackID==3, NOT the third particle in the list! Use partList.Particle(3) if you want to get the particles by index number instead of track ID. Note that this only works in a const context. Use the insert() or Add() methods to add a new particle to the list.

Definition at line 330 of file ParticleNavigator.cxx.

References fParticleList, and MECModelEnuComparisons::i.

Referenced by at(), and lower_bound().

  {
    const_iterator i = fParticleList.find(key);
    if(i == fParticleList.end())
      throw cet::exception("ParticleNavigator") << "track id is not in map";
    return (*i).second;
  }

ParticleNavigator::mapped_type sim::ParticleNavigator::operator[]

(

const key_type &

key

)

This non-const version of operator[] does NOT permit you to insert Particles into the list. Use Add() or insert() for that.

Definition at line 320 of file ParticleNavigator.cxx.

References fParticleList, and MECModelEnuComparisons::i.

  {
    const_iterator i = fParticleList.find(key);
    if(i == fParticleList.end())
      throw cet::exception("ParticleNavigator") << "track id is not in map";
    return (*i).second;
  }

ParticleNavigator::mapped_type sim::ParticleNavigator::Particle

(

const size_type

index

)

const

Definition at line 127 of file ParticleNavigator.cxx.

References fParticleList, and MECModelEnuComparisons::i.

Referenced by ncs::GenieTruth::analyze(), murem::MuonRemove::FillTruthInfo(), skim::EvaluatorNumuCCpi::KeepEventSlices(), filter::TruthFilter::produce(), murem::MuonRemove::RemoveByEfficiency(), and murem::MuonRemove::RemoveByTruth().

  {
    const_iterator i = fParticleList.begin();
    std::advance(i,index);
    return (*i).second;
  }

ParticleNavigator::mapped_type sim::ParticleNavigator::Particle

(

const size_type

index

)

Definition at line 135 of file ParticleNavigator.cxx.

References fParticleList, and MECModelEnuComparisons::i.

  {
    iterator i = fParticleList.begin();
    std::advance(i,index);
    return (*i).second;
  }

const sim::Particle * sim::ParticleNavigator::Primary

(

const int

index

)

const

Definition at line 155 of file ParticleNavigator.cxx.

References HTMLTools::entry(), fParticleList, fPrimaries, and trackID.

Referenced by mmc::Validation::analyze(), mcchk::LeptonAna::analyze(), mono::SlowMonopoleAna::analyze(), mono::Monopole::analyze(), ncs::NCAna::analyze(), sn::SupernovaMCCluster::BuildInteractionTrackIDMap(), trk::CosmicTrackAna::FillEventMCTruthHistograms(), murem::MuonRemove::FillTruthInfo(), tut::TutFilter::filter(), mono::EventSelector::filter(), nuesand::FillNueSandbox::GetECF(), evd::SimulationDrawer::MCTruthLongText(), tut::TutProducer::produce(), murem::MuonRemove::RemoveByEfficiency(), and murem::MuonRemove::RemoveByTruth().

  {
    // Advance "index" entries from the beginning of the primary list.
    primaries_const_iterator primary = fPrimaries.begin();
    std::advance( primary, index );
    
    // Get the track ID from that entry in the list.
    int trackID = *primary;
    
    // Find the entry in the particle list with that track ID.
    const_iterator entry = fParticleList.find(trackID);

    // Return the Particle object in that entry.
    return (*entry).second;
  }

sim::Particle * sim::ParticleNavigator::Primary

(

const int

index

)

Definition at line 172 of file ParticleNavigator.cxx.

References HTMLTools::entry(), fParticleList, fPrimaries, and trackID.

  {
    // Advance "index" entries from the beginning of the primary list.
    primaries_const_iterator primary = fPrimaries.begin();
    std::advance( primary, index );

    // Get the track ID from that entry in the list.
    int trackID = *primary;

    // Find the entry in the particle list with that track ID.
    iterator entry = fParticleList.find(trackID);

    // Return the Particle object in that entry.
    return (*entry).second;
  }

reverse_iterator sim::ParticleNavigator::rbegin ( )

inline

Definition at line 140 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.rbegin(); }

const_reverse_iterator sim::ParticleNavigator::rbegin ( ) const

inline

Definition at line 141 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.rbegin(); }

reverse_iterator sim::ParticleNavigator::rend ( )

inline

Definition at line 142 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.rend();   }

const_reverse_iterator sim::ParticleNavigator::rend ( ) const

inline

Definition at line 143 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.rend();   }

size_type sim::ParticleNavigator::size ( ) const

inline

Definition at line 145 of file ParticleNavigator.h.

References fParticleList.

Referenced by mmc::Validation::analyze(), mono::SlowMonopoleAna::analyze(), mono::Monopole::analyze(), ncs::GenieTruth::analyze(), murem::MuonRemove::FillTruthInfo(), mono::EventSelector::filter(), skim::EvaluatorNumuCCpi::KeepEventSlices(), sim::operator<<(), murem::MuonRemove::RemoveByEfficiency(), and murem::MuonRemove::RemoveByTruth().

{ return fParticleList.size();  }

void sim::ParticleNavigator::swap ( ParticleNavigator &  other )

inline

Definition at line 147 of file ParticleNavigator.h.

References fParticleList.

{ fParticleList.swap( other.fParticleList ); }

const ParticleNavigator::key_type & sim::ParticleNavigator::TrackId

(

const size_type

index

)

const

Definition at line 119 of file ParticleNavigator.cxx.

References fParticleList, and MECModelEnuComparisons::i.

Referenced by ncs::GenieTruth::analyze().

  {
    const_iterator i = fParticleList.begin();
    std::advance(i,index);
    return (*i).first;
  }

iterator sim::ParticleNavigator::upper_bound ( const key_type &  key )

inline

Definition at line 151 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.upper_bound(key); }

const_iterator sim::ParticleNavigator::upper_bound ( const key_type &  key ) const

inline

Definition at line 152 of file ParticleNavigator.h.

References fParticleList.

{ return fParticleList.upper_bound(key); }

Friends And Related Function Documentation

ParticleNavigator operator+ ( const int &  value, const ParticleNavigator &  list  )

friend

Definition at line 231 of file ParticleNavigator.cxx.

  {
    return list + value;
  }

std::ostream& operator<< ( std::ostream &  output, const ParticleNavigator &  list  )

friend

Definition at line 294 of file ParticleNavigator.cxx.

Referenced by Add().

  {
    // Determine a field width for the particle number.
    ParticleNavigator::size_type numberOfParticles = list.size();
    int numberOfDigits = (int) std::log10( (double) numberOfParticles ) + 1;

    // A simple header.
    output.width( numberOfDigits );
    output << "#" << ": < ID, particle >" << std::endl; 

    // Write each particle on a separate line.
    ParticleNavigator::size_type nParticle = 0;
    for ( ParticleNavigator::const_iterator particle = list.begin(); 
          particle != list.end(); ++particle, ++nParticle ){
      output.width( numberOfDigits );
      output << nParticle << ": " 
             << "<" << (*particle).first 
             << "," << *((*particle).second) 
             << ">" << std::endl;
    }

    return output;
  }

Member Data Documentation

list_type sim::ParticleNavigator::fParticleList

private

Sorted list of particles in the event.

Definition at line 193 of file ParticleNavigator.h.

Referenced by Add(), begin(), clear(), Cut(), empty(), end(), erase(), find(), insert(), lower_bound(), operator=(), operator[](), Particle(), ParticleNavigator(), Primary(), rbegin(), rend(), size(), swap(), TrackId(), and upper_bound().

primaries_type sim::ParticleNavigator::fPrimaries

private

Sorted list of the track IDs of primary particles.

Definition at line 198 of file ParticleNavigator.h.

Referenced by clear(), insert(), IsPrimary(), NumberOfPrimaries(), and Primary().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-24/Simulation/ParticleNavigator.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-24/Simulation/ParticleNavigator.cxx