sim::EveIdCalculator Class Reference

#include <EveIdCalculator.h>

Inheritance diagram for sim::EveIdCalculator:

Public Member Functions
	EveIdCalculator ()
	Constructor and destructor. More...
virtual	~EveIdCalculator ()
void	Init (const sim::ParticleList *list)
	Initialize this calculator for a particular ParticleList. More...
const sim::ParticleList *	ParticleList () const
int	CalculateEveId (const int trackID)

Protected Member Functions
virtual int	DoCalculateEveId (const int trackID)

Protected Attributes
const sim::ParticleList *	m_particleList

Private Types
typedef std::map< int, int >	m_previousList_t
	The ParticleList associated with the eve ID calculation. More...
typedef m_previousList_t::const_iterator	m_previousList_ptr

Private Attributes
m_previousList_t	m_previousList

Detailed Description

Definition at line 83 of file EveIdCalculator.h.

Member Typedef Documentation

typedef m_previousList_t::const_iterator sim::EveIdCalculator::m_previousList_ptr

private

Definition at line 123 of file EveIdCalculator.h.

typedef std::map< int, int > sim::EveIdCalculator::m_previousList_t

private

The ParticleList associated with the eve ID calculation.

Keep track of the previous eve IDs for the current ParticleList.

Definition at line 122 of file EveIdCalculator.h.

Constructor & Destructor Documentation

sim::EveIdCalculator::EveIdCalculator

(

)

Constructor and destructor.

Definition at line 19 of file EveIdCalculator.cxx.

  {
  }

sim::EveIdCalculator::~EveIdCalculator ( )

virtual

Definition at line 25 of file EveIdCalculator.cxx.

  {
  }

Member Function Documentation

int sim::EveIdCalculator::CalculateEveId

(

const int

trackID

)

The main eve ID calculation method. This is the reason why we use the Template Method for this class: because no matter what the core eve ID calculation is, we want to perform the following an additional task: The eve ID calculation can be lengthy. If the user is going through a LArVoxelList and trying to figuring out the eve ID associated with each voxel, this routine may be called many times. To save on time, keep the results of previous eve ID calculations for the current particle list. Only do the complete eve ID calculation if we haven't done it already for a given track ID.

Definition at line 42 of file EveIdCalculator.cxx.

  {
    // Look to see if the eve ID has been previously calculated for
    // this track.
    m_previousList_ptr search = m_previousList.find( trackID );
    if ( search == m_previousList.end() ){
      // It hasn't been calculated before. Do the full eve ID
      // calculation.
      int eveID = DoCalculateEveId( trackID );
      
      // Save the result of the calculation.
      m_previousList[ trackID ] = eveID;
      
      return eveID;
    }

    // If we get here, we've calculated the eve ID for this track
    // before. Return that result.
    return (*search).second;
  }

int sim::EveIdCalculator::DoCalculateEveId ( const int  trackID )

protectedvirtual

This is the core method to calculate the eve ID. If another class is going to override the default calculation, this the method that must be implemented.

Reimplemented in sim::EmEveIdCalculator.

Definition at line 64 of file EveIdCalculator.cxx.

  {
    // This is the default eve ID calculation method. It gets called
    // if the user doesn't override it with their own method.

    // Almost any eve ID calculation will use this: Get the entire
    // history of the particle and its ancestors in the simulated
    // event.
    ParticleHistory particleHistory( m_particleList, trackID );

    if ( particleHistory.empty() ){
      // Something went wrong; most likely the track ID isn't
      // present in the event.
      return 0;
    }

    // Return the primary particle from the event generator associated
    // with this track ID.
    const simb::MCParticle* particle = particleHistory[0];
    return particle->TrackId();
  }

void sim::EveIdCalculator::Init

(

const sim::ParticleList *

list

)

Initialize this calculator for a particular ParticleList.

Definition at line 31 of file EveIdCalculator.cxx.

  {
    // Save the ParticleList associated with this simulated chain of
    // particles.
    m_particleList = list;

    // Reset the results of previous calculations.
    m_previousList.clear();
  }

const sim::ParticleList* sim::EveIdCalculator::ParticleList ( ) const

inline

Accessor: For which ParticleList does this calculator generate results?

Definition at line 96 of file EveIdCalculator.h.

{ return m_particleList; }

Member Data Documentation

const sim::ParticleList* sim::EveIdCalculator::m_particleList

protected

Definition at line 118 of file EveIdCalculator.h.

m_previousList_t sim::EveIdCalculator::m_previousList

private

Definition at line 124 of file EveIdCalculator.h.

---

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

• nutools/old/ParticleNavigation/EveIdCalculator.h
• nutools/old/ParticleNavigation/EveIdCalculator.cxx