truth::MCTruthParticleList Class Reference

#include <MCTruthParticleList.h>

Classes
struct	archived_info_type

Public Types
typedef std::map< int, const simb::MCParticle * >	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
	MCTruthParticleList ()
virtual	~MCTruthParticleList ()
	MCTruthParticleList (const MCTruthParticleList &rhs)=delete
MCTruthParticleList &	operator= (const MCTruthParticleList &rhs)=delete
	MCTruthParticleList (MCTruthParticleList &&rhs)=default
MCTruthParticleList &	operator= (MCTruthParticleList &&rhs)=default
MCTruthParticleList	MakeCopy () const
	Returns a copy of this object. More...
void	Cut (const double &)
const key_type &	TrackId (const size_type) const
mapped_type const &	Particle (const size_type) const
mapped_type	Particle (const size_type)
bool	HasParticle (int trackID) const
	Returns whether we have this particle, live (with full information) More...
bool	KnownParticle (int trackID) const
	Returns whether we have had this particle, archived or live. More...
bool	IsPrimary (int trackID) const
int	NumberOfPrimaries () const
std::vector< const simb::MCParticle * >	GetPrimaries () const
const simb::MCParticle *	Primary (const int) 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 (MCTruthParticleList &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 const &	operator[] (const key_type &key) const
mapped_type	operator[] (const key_type &key)
mapped_type	at (const key_type &key)
mapped_type const &	at (const key_type &key) const
key_type	key (mapped_type const &part) const
	Extracts the key from the specified value. More...
void	insert (const simb::MCParticle *value)
void	Add (const simb::MCParticle *value)
void	Archive (const key_type &key)
	Removes the particle from the list, keeping minimal info of it. More...
void	Archive (const mapped_type &key)
int	GetMotherOf (const key_type &key) const
	This function seeks for the exact key, not its absolute value. More...
void	clear ()
size_type	erase (const key_type &key)
iterator	erase (iterator key)
int	EveId (const int trackID) const
void	AdoptEveIdCalculator (MCTruthEveIdCalculator *) const

Private Types
typedef std::set< int >	primaries_type
typedef std::map< int, archived_info_type >	archive_type
typedef primaries_type::iterator	primaries_iterator
typedef primaries_type::const_iterator	primaries_const_iterator

Private Attributes
list_type	m_MCTruthParticleList
	Sorted list of particles in the event. More...
primaries_type	m_primaries
archive_type	m_archive
	archive of the particles no longer among us More...
std::unique_ptr < MCTruthEveIdCalculator >	m_eveIdCalculator

Friends
std::ostream &	operator<< (std::ostream &output, const MCTruthParticleList &)
std::ostream &	operator<< (std::ostream &output, const MCTruthParticleList::archived_info_type &)

Detailed Description

Definition at line 128 of file MCTruthParticleList.h.

Member Typedef Documentation

typedef list_type::allocator_type truth::MCTruthParticleList::allocator_type

Definition at line 145 of file MCTruthParticleList.h.

typedef std::map<int, archived_info_type> truth::MCTruthParticleList::archive_type

private

Definition at line 173 of file MCTruthParticleList.h.

typedef list_type::const_iterator truth::MCTruthParticleList::const_iterator

Definition at line 139 of file MCTruthParticleList.h.

typedef list_type::const_reverse_iterator truth::MCTruthParticleList::const_reverse_iterator

Definition at line 141 of file MCTruthParticleList.h.

typedef list_type::difference_type truth::MCTruthParticleList::difference_type

Definition at line 143 of file MCTruthParticleList.h.

typedef list_type::iterator truth::MCTruthParticleList::iterator

Definition at line 138 of file MCTruthParticleList.h.

typedef list_type::key_compare truth::MCTruthParticleList::key_compare

Definition at line 144 of file MCTruthParticleList.h.

typedef list_type::key_type truth::MCTruthParticleList::key_type

Definition at line 135 of file MCTruthParticleList.h.

typedef std::map<int,const simb::MCParticle*> truth::MCTruthParticleList::list_type

Definition at line 134 of file MCTruthParticleList.h.

typedef list_type::mapped_type truth::MCTruthParticleList::mapped_type

Definition at line 136 of file MCTruthParticleList.h.

typedef primaries_type::const_iterator truth::MCTruthParticleList::primaries_const_iterator

private

Definition at line 175 of file MCTruthParticleList.h.

typedef primaries_type::iterator truth::MCTruthParticleList::primaries_iterator

private

Definition at line 174 of file MCTruthParticleList.h.

typedef std::set< int > truth::MCTruthParticleList::primaries_type

private

Definition at line 172 of file MCTruthParticleList.h.

typedef list_type::reverse_iterator truth::MCTruthParticleList::reverse_iterator

Definition at line 140 of file MCTruthParticleList.h.

typedef list_type::size_type truth::MCTruthParticleList::size_type

Definition at line 142 of file MCTruthParticleList.h.

typedef list_type::value_type truth::MCTruthParticleList::value_type

Definition at line 137 of file MCTruthParticleList.h.

Constructor & Destructor Documentation

truth::MCTruthParticleList::MCTruthParticleList

(

)

Definition at line 37 of file MCTruthParticleList.cxx.

{
}

truth::MCTruthParticleList::~MCTruthParticleList ( )

virtual

Definition at line 43 of file MCTruthParticleList.cxx.

{
    this->clear();
}

truth::MCTruthParticleList::MCTruthParticleList ( const MCTruthParticleList &  rhs )

delete

truth::MCTruthParticleList::MCTruthParticleList ( MCTruthParticleList &&  rhs )

default

Member Function Documentation

void truth::MCTruthParticleList::Add ( const simb::MCParticle *  value )

inline

Definition at line 325 of file MCTruthParticleList.h.

{ insert(value);                  }

void truth::MCTruthParticleList::AdoptEveIdCalculator

(

MCTruthEveIdCalculator *

calc

)

const

Definition at line 398 of file MCTruthParticleList.cxx.

{
    m_eveIdCalculator.reset(calc);
}

void truth::MCTruthParticleList::Archive

(

const key_type &

key

)

Removes the particle from the list, keeping minimal info of it.

Definition at line 283 of file MCTruthParticleList.cxx.

{
     auto& part = m_MCTruthParticleList.at(key);
     if (part == nullptr) return; // already archived, nothing to do
     
     // create a new archive item with the particle;
     m_archive[key] = archived_info_type(*part);
     
     // dispose of the particle in the list (the cell will still be there
     delete part;
     part = nullptr;
} // MCTruthParticleList::Archive()

void truth::MCTruthParticleList::Archive

(

const mapped_type &

key

)

Definition at line 298 of file MCTruthParticleList.cxx.

{
    Archive(key(part));
}

truth::MCTruthParticleList::mapped_type truth::MCTruthParticleList::at ( const key_type &  key )

inline

Definition at line 340 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.at(std::abs(key)); }

truth::MCTruthParticleList::mapped_type const & truth::MCTruthParticleList::at ( const key_type &  key ) const

inline

Definition at line 342 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.at(std::abs(key)); }

truth::MCTruthParticleList::iterator truth::MCTruthParticleList::begin ( )

inline

Definition at line 315 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.begin();  }

truth::MCTruthParticleList::const_iterator truth::MCTruthParticleList::begin ( ) const

inline

Definition at line 316 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.begin();  }

void truth::MCTruthParticleList::clear

(

)

Definition at line 311 of file MCTruthParticleList.cxx.

{
    m_MCTruthParticleList.clear();
    m_archive.clear();
    m_primaries.clear();
}

void truth::MCTruthParticleList::Cut

(

const double &

cut

)

Definition at line 66 of file MCTruthParticleList.cxx.

{
    // 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 = m_MCTruthParticleList.begin(); i != m_MCTruthParticleList.end(); ++i )
    {
        const simb::MCParticle* particle = (*i).second;
        if (!particle) continue;
        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 truth::MCTruthParticleList::empty ( ) const

inline

Definition at line 324 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.empty();  }

truth::MCTruthParticleList::iterator truth::MCTruthParticleList::end ( )

inline

Definition at line 317 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.end();    }

truth::MCTruthParticleList::const_iterator truth::MCTruthParticleList::end ( ) const

inline

Definition at line 318 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.end();    }

MCTruthParticleList::size_type truth::MCTruthParticleList::erase

(

const key_type &

key

)

Definition at line 326 of file MCTruthParticleList.cxx.

{
    iterator entry = m_MCTruthParticleList.find( abs(key) );
    if (entry == m_MCTruthParticleList.end()) return 0;
    erase(entry);
    return 1;
}

MCTruthParticleList::iterator truth::MCTruthParticleList::erase

(

iterator

key

)

Definition at line 320 of file MCTruthParticleList.cxx.

{
    delete position->second;
    return m_MCTruthParticleList.erase( position );
}

int truth::MCTruthParticleList::EveId

(

const int

trackID

)

const

Definition at line 371 of file MCTruthParticleList.cxx.

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

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

truth::MCTruthParticleList::iterator truth::MCTruthParticleList::find ( const key_type &  key )

inline

Definition at line 328 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.find(abs(key));        }

truth::MCTruthParticleList::const_iterator truth::MCTruthParticleList::find ( const key_type &  key ) const

inline

Definition at line 330 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.find(abs(key));        }

int truth::MCTruthParticleList::GetMotherOf

(

const key_type &

key

)

const

This function seeks for the exact key, not its absolute value.

Definition at line 304 of file MCTruthParticleList.cxx.

{
     auto part = m_MCTruthParticleList.at(key);
     return part? part->Mother(): m_archive.at(key).Mother();
} // MCTruthParticleList::GetMotherOf()

std::vector< const simb::MCParticle * > truth::MCTruthParticleList::GetPrimaries

(

)

const

Definition at line 145 of file MCTruthParticleList.cxx.

{
    std::vector<const simb::MCParticle*> primaries;
    primaries.reserve(m_primaries.size());
    // for each particle, check if its track ID is in the primaries list
    // iPartPair is std::pair<const int, simb::MCParticle*>
    for (auto& iPartPair: m_MCTruthParticleList)
    {
        if (m_primaries.count(iPartPair.first))
            primaries.push_back(iPartPair.second);
    } // for
    if (primaries.size() != m_primaries.size())
    {
        throw cet::exception("MCTruthParticleList")
            << "sim::MCTruthParticleList::GetPrimaries() collected " << primaries.size()
            << " primaries, not " << m_primaries.size() << " as expected\n";
    }
    
    return primaries;
} // MCTruthParticleList::GetPrimaries()

bool truth::MCTruthParticleList::HasParticle ( int  trackID ) const

inline

Returns whether we have this particle, live (with full information)

Definition at line 221 of file MCTruthParticleList.h.

    {
        auto iParticle = find(trackID);
        return (iParticle != end()) && (iParticle->second != nullptr);
    }

void truth::MCTruthParticleList::insert

(

const simb::MCParticle *

value

)

Definition at line 259 of file MCTruthParticleList.cxx.

{
    int trackID = key(particle);
    iterator insertion = m_MCTruthParticleList.lower_bound( trackID );
    if ( insertion == m_MCTruthParticleList.end() )
    {
        // The best "hint" we can give is that the particle will go at
        // the end of the list.
        m_MCTruthParticleList.insert( insertion, value_type( trackID, particle ) );
    }
    else if ( (*insertion).first != trackID ){
        // It turns out that the best hint we can give is one more
        // than the result of lower_bound.
        m_MCTruthParticleList.insert( ++insertion, value_type( trackID, particle ) );
    }

    // If this is a primary particle, add it to the list.  use 
    // rimary as the process string to look for as the P may or may not
    // be capitalized
    if ( particle->Process().find("rimary") != std::string::npos )
      m_primaries.insert( trackID );
}

bool truth::MCTruthParticleList::IsPrimary

(

int

trackID

)

const

Definition at line 116 of file MCTruthParticleList.cxx.

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

truth::MCTruthParticleList::key_type truth::MCTruthParticleList::key ( mapped_type const &  part ) const

inline

Extracts the key from the specified value.

Definition at line 348 of file MCTruthParticleList.h.

{ return part->TrackId(); }

bool truth::MCTruthParticleList::KnownParticle ( int  trackID ) const

inline

Returns whether we have had this particle, archived or live.

Definition at line 228 of file MCTruthParticleList.h.

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

truth::MCTruthParticleList::iterator truth::MCTruthParticleList::lower_bound ( const key_type &  key )

inline

Definition at line 336 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.lower_bound(abs(key)); }

truth::MCTruthParticleList::const_iterator truth::MCTruthParticleList::lower_bound ( const key_type &  key ) const

inline

Definition at line 338 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.lower_bound(abs(key)); }

MCTruthParticleList truth::MCTruthParticleList::MakeCopy

(

)

const

Returns a copy of this object.

Definition at line 51 of file MCTruthParticleList.cxx.

{
    MCTruthParticleList list;

    // Copy each entry in the other MCTruthParticleList.
    for (std::pair<int, const simb::MCParticle*> const& partInfo: m_MCTruthParticleList)
        list.insert(partInfo.second? new simb::MCParticle(*(partInfo.second)): nullptr);
    
    list.m_archive = m_archive;
    
    return list;
} // MCTruthParticleList::MakeCopy()

int truth::MCTruthParticleList::NumberOfPrimaries

(

)

const

Definition at line 122 of file MCTruthParticleList.cxx.

{
    return m_primaries.size();
}

MCTruthParticleList& truth::MCTruthParticleList::operator= ( const MCTruthParticleList &  rhs )

delete

MCTruthParticleList& truth::MCTruthParticleList::operator= ( MCTruthParticleList &&  rhs )

default

truth::MCTruthParticleList::mapped_type const & truth::MCTruthParticleList::operator[] ( const key_type &  key ) const

inline

Definition at line 346 of file MCTruthParticleList.h.

{ return at(key); }

truth::MCTruthParticleList::mapped_type truth::MCTruthParticleList::operator[] ( const key_type &  key )

inline

Definition at line 344 of file MCTruthParticleList.h.

{ return at(key); }

MCTruthParticleList::mapped_type const & truth::MCTruthParticleList::Particle

(

const size_type

index

)

const

Definition at line 98 of file MCTruthParticleList.cxx.

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

MCTruthParticleList::mapped_type truth::MCTruthParticleList::Particle

(

const size_type

index

)

Definition at line 107 of file MCTruthParticleList.cxx.

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

const simb::MCParticle * truth::MCTruthParticleList::Primary

(

const int

index

)

const

Definition at line 128 of file MCTruthParticleList.cxx.

{
    // Advance "index" entries from the beginning of the primary list.
    primaries_const_iterator primary = m_primaries.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 = m_MCTruthParticleList.find(trackID);

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

truth::MCTruthParticleList::reverse_iterator truth::MCTruthParticleList::rbegin ( )

inline

Definition at line 319 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.rbegin(); }

truth::MCTruthParticleList::const_reverse_iterator truth::MCTruthParticleList::rbegin ( ) const

inline

Definition at line 320 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.rbegin(); }

truth::MCTruthParticleList::reverse_iterator truth::MCTruthParticleList::rend ( )

inline

Definition at line 321 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.rend();   }

truth::MCTruthParticleList::const_reverse_iterator truth::MCTruthParticleList::rend ( ) const

inline

Definition at line 322 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.rend();   }

truth::MCTruthParticleList::size_type truth::MCTruthParticleList::size ( ) const

inline

Definition at line 323 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.size();   }

void truth::MCTruthParticleList::swap ( truth::MCTruthParticleList &  other )

inline

Definition at line 326 of file MCTruthParticleList.h.

{ m_MCTruthParticleList.swap( other.m_MCTruthParticleList ); m_archive.swap( other.m_archive ); m_primaries.swap( other.m_primaries); }

const MCTruthParticleList::key_type & truth::MCTruthParticleList::TrackId

(

const size_type

index

)

const

Definition at line 90 of file MCTruthParticleList.cxx.

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

truth::MCTruthParticleList::iterator truth::MCTruthParticleList::upper_bound ( const key_type &  key )

inline

Definition at line 332 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.upper_bound(abs(key)); }

truth::MCTruthParticleList::const_iterator truth::MCTruthParticleList::upper_bound ( const key_type &  key ) const

inline

Definition at line 334 of file MCTruthParticleList.h.

{ return m_MCTruthParticleList.upper_bound(abs(key)); }

Friends And Related Function Documentation

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

friend

Definition at line 336 of file MCTruthParticleList.cxx.

{
    // Determine a field width for the particle number.
    MCTruthParticleList::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.
    MCTruthParticleList::size_type nParticle = 0;
    for ( MCTruthParticleList::const_iterator particle = list.begin(); 
          particle != list.end(); ++particle, ++nParticle )
    {
        output.width( numberOfDigits );
        output << nParticle << ": "
               << "<" << (*particle).first << ",";
        if (particle->second)
            output << *(particle->second);
        else {
            auto iArch = list.m_archive.find(particle->first);
            if (iArch == list.m_archive.end())
                output << "lost [INTERNAL ERROR!]";
            else
                output << "(archived) " << iArch->second;
        }
        output << ">" << std::endl;
    }

    return output;
}

std::ostream& operator<< ( std::ostream &  output, const MCTruthParticleList::archived_info_type &  info  )

friend

Definition at line 405 of file MCTruthParticleList.cxx.

{
    output << "Mother ID=" << info.Mother() << std::endl;
    return output;
}

Member Data Documentation

archive_type truth::MCTruthParticleList::m_archive

private

archive of the particles no longer among us

Definition at line 180 of file MCTruthParticleList.h.

std::unique_ptr<MCTruthEveIdCalculator> truth::MCTruthParticleList::m_eveIdCalculator

mutableprivate

Definition at line 186 of file MCTruthParticleList.h.

list_type truth::MCTruthParticleList::m_MCTruthParticleList

private

Sorted list of particles in the event.

Definition at line 177 of file MCTruthParticleList.h.

primaries_type truth::MCTruthParticleList::m_primaries

private

Sorted list of the track IDs of primary particles.

Definition at line 178 of file MCTruthParticleList.h.

---

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

• MCTruthParticleList.h
• MCTruthParticleList.cxx