sim::LArVoxelList Class Reference

#include "LArVoxelList.h"

Public Types
typedef std::map< LArVoxelID, LArVoxelData >	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
	LArVoxelList ()
virtual	~LArVoxelList ()
void	Add (const key_type &key, const double &energy)
void	Add (const key_type &key, const double &energy, const int &id)
void	Add (const LArVoxelList &)
LArVoxelList &	operator+= (const LArVoxelList &other)
const LArVoxelList	operator+ (const LArVoxelList &other) const
LArVoxelList &	operator*= (const double &value)
const LArVoxelList	operator* (const double &value) const
void	Cut (const double &)
	Apply an energy cut to the voxels. More...
const key_type &	ID (const size_type) const
double	Energy (const size_type) 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 (LArVoxelList &other)
void	clear ()
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) const
mapped_type &	at (const key_type &key)
const mapped_type &	at (const key_type &key) const
void	insert (const key_type &key, const mapped_type &value)
size_type	erase (const key_type &key)

Private Attributes
list_type	m_voxelList
	A sorted list of <LArVoxelID,double> pairs = (voxel ID, energy) More...

Friends
const LArVoxelList	operator* (const double &value, const LArVoxelList &list)
std::ostream &	operator<< (std::ostream &output, const LArVoxelList &)

Detailed Description

Definition at line 68 of file LArVoxelList.h.

Member Typedef Documentation

typedef list_type::allocator_type sim::LArVoxelList::allocator_type

Definition at line 85 of file LArVoxelList.h.

typedef list_type::const_iterator sim::LArVoxelList::const_iterator

Definition at line 79 of file LArVoxelList.h.

typedef list_type::const_reverse_iterator sim::LArVoxelList::const_reverse_iterator

Definition at line 81 of file LArVoxelList.h.

typedef list_type::difference_type sim::LArVoxelList::difference_type

Definition at line 83 of file LArVoxelList.h.

typedef list_type::iterator sim::LArVoxelList::iterator

Definition at line 78 of file LArVoxelList.h.

typedef list_type::key_compare sim::LArVoxelList::key_compare

Definition at line 84 of file LArVoxelList.h.

typedef list_type::key_type sim::LArVoxelList::key_type

Definition at line 75 of file LArVoxelList.h.

typedef std::map<LArVoxelID, LArVoxelData> sim::LArVoxelList::list_type

Some type definitions to make life easier, and to help "hide" the implementation details. (If you're not familiar with STL, you can ignore these definitions.)

Definition at line 74 of file LArVoxelList.h.

typedef list_type::mapped_type sim::LArVoxelList::mapped_type

Definition at line 76 of file LArVoxelList.h.

typedef list_type::reverse_iterator sim::LArVoxelList::reverse_iterator

Definition at line 80 of file LArVoxelList.h.

typedef list_type::size_type sim::LArVoxelList::size_type

Definition at line 82 of file LArVoxelList.h.

typedef list_type::value_type sim::LArVoxelList::value_type

Definition at line 77 of file LArVoxelList.h.

Constructor & Destructor Documentation

sim::LArVoxelList::LArVoxelList

(

)

Definition at line 19 of file LArVoxelList.cxx.

Referenced by sim::operator*(), operator*(), and operator+().

{}

sim::LArVoxelList::~LArVoxelList ( )

virtual

Definition at line 22 of file LArVoxelList.cxx.

{}

Member Function Documentation

void sim::LArVoxelList::Add ( const key_type &  key, const double &  energy  )

inline

Definition at line 94 of file LArVoxelList.h.

References m_voxelList.

Referenced by Add(), sim::SimListUtils::GetLArVoxelList(), and operator+=().

{ m_voxelList[key].Add(energy); }

void sim::LArVoxelList::Add ( const key_type &  key, const double &  energy, const int &  id  )

inline

Definition at line 95 of file LArVoxelList.h.

References Add(), and m_voxelList.

{ m_voxelList[key].Add(energy,id); }

void sim::LArVoxelList::Add

(

const LArVoxelList &

other

)

Definition at line 25 of file LArVoxelList.cxx.

References m_voxelList.

  {
    // Go through "other" list, adding its voxels to "this" list.
    for ( const_iterator i = other.m_voxelList.begin(); i != m_voxelList.end(); ++i ){
      m_voxelList[ (*i).first ] += (*i).second;
    }
  }

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

inline

Definition at line 155 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.at(key); }

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

inline

Definition at line 156 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.at(key); }

iterator sim::LArVoxelList::begin ( )

inline

Definition at line 131 of file LArVoxelList.h.

References m_voxelList.

Referenced by evd::SimulationDrawer::MCTruth3D(), evd::SimulationDrawer::MCTruthOrtho(), and sim::operator<<().

{ return m_voxelList.begin(); }

const_iterator sim::LArVoxelList::begin ( ) const

inline

Definition at line 132 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.begin(); }

void sim::LArVoxelList::clear ( void  )

inline

Definition at line 143 of file LArVoxelList.h.

References m_voxelList.

{ m_voxelList.clear(); }

void sim::LArVoxelList::Cut

(

const double &

cut

)

Apply an energy cut to the voxels.

Definition at line 53 of file LArVoxelList.cxx.

References m_voxelList.

Referenced by operator*().

  {
    // The safest way to do this is to create a list of voxel IDs that
    // fail the cut, then delete those IDs.

    // Define a list of IDs.
    typedef std::vector< key_type > keyList_type;
    keyList_type keyList;

    // Add each ID that fails the cut to the list.
    for ( const_iterator i = m_voxelList.begin(); i != m_voxelList.end(); ++i ){
      if ( (*i).second.Energy() < cut ) { 
        keyList.push_back( (*i).first ); 
      }
    }

    // Go through the list, deleting the voxels that are on the list.
    for ( keyList_type::const_iterator i = keyList.begin(); i != keyList.end(); ++i ){
      m_voxelList.erase( (*i) );
    }
  }

bool sim::LArVoxelList::empty ( void  ) const

inline

Definition at line 141 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.empty(); }

iterator sim::LArVoxelList::end ( void  )

inline

Definition at line 133 of file LArVoxelList.h.

References m_voxelList.

Referenced by evd::SimulationDrawer::MCTruth3D(), evd::SimulationDrawer::MCTruthOrtho(), and sim::operator<<().

{ return m_voxelList.end(); }

const_iterator sim::LArVoxelList::end ( void  ) const

inline

Definition at line 134 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.end(); }

double sim::LArVoxelList::Energy

(

const size_type

index

)

const

Definition at line 84 of file LArVoxelList.cxx.

References m_voxelList.

Referenced by operator*().

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

size_type sim::LArVoxelList::erase ( const key_type &  key )

inline

Definition at line 164 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.erase(key); }

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

inline

Definition at line 145 of file LArVoxelList.h.

References m_voxelList.

Referenced by sim::SimListUtils::GetLArVoxelList().

{ return m_voxelList.find(key); }

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

inline

Definition at line 146 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.find(key); }

const LArVoxelList::key_type & sim::LArVoxelList::ID

(

const size_type

index

)

const

Definition at line 76 of file LArVoxelList.cxx.

References m_voxelList.

Referenced by operator*().

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

void sim::LArVoxelList::insert ( const key_type &  key, const mapped_type &  value  )

inline

Definition at line 162 of file LArVoxelList.h.

References m_voxelList, and fhicl::detail::atom::value().

{ m_voxelList[key] = value; }

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

inline

Definition at line 149 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.lower_bound(key); }

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

inline

Definition at line 150 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.lower_bound(key); }

const LArVoxelList sim::LArVoxelList::operator* ( const double &  value ) const

inline

Definition at line 111 of file LArVoxelList.h.

References Cut(), Energy(), ID(), LArVoxelList(), operator<<, and fhicl::detail::atom::value().

    {
      return LArVoxelList(*this) *= value;
    }

LArVoxelList & sim::LArVoxelList::operator*=

(

const double &

value

)

Definition at line 34 of file LArVoxelList.cxx.

References m_voxelList, and fhicl::detail::atom::value().

Referenced by operator+().

  {
    // Multiply each voxel energy by the value.
    for ( iterator i = m_voxelList.begin(); i != m_voxelList.end(); ++i ){
      (*i).second *= value;
    }
    return (*this);
  }

const LArVoxelList sim::LArVoxelList::operator+ ( const LArVoxelList &  other ) const

inline

Definition at line 105 of file LArVoxelList.h.

References LArVoxelList(), operator*=(), fhicl::other, and fhicl::detail::atom::value().

    {
      return LArVoxelList(*this) += other;
    }

LArVoxelList& sim::LArVoxelList::operator+= ( const LArVoxelList &  other )

inline

Definition at line 100 of file LArVoxelList.h.

References Add().

    { 
      this->Add(other); 
      return *this; 
    }

mapped_type& sim::LArVoxelList::operator[] ( const key_type &  key )

inline

Definition at line 152 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList[key]; }

const mapped_type& sim::LArVoxelList::operator[] ( const key_type &  key ) const

inline

Definition at line 154 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.at(key); }

reverse_iterator sim::LArVoxelList::rbegin ( )

inline

Definition at line 135 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.rbegin(); }

const_reverse_iterator sim::LArVoxelList::rbegin ( ) const

inline

Definition at line 136 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.rbegin(); }

reverse_iterator sim::LArVoxelList::rend ( )

inline

Definition at line 137 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.rend(); }

const_reverse_iterator sim::LArVoxelList::rend ( ) const

inline

Definition at line 138 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.rend(); }

size_type sim::LArVoxelList::size ( void  ) const

inline

Definition at line 140 of file LArVoxelList.h.

References m_voxelList.

Referenced by evd::SimulationDrawer::MCTruth3D(), evd::SimulationDrawer::MCTruthOrtho(), and sim::operator<<().

{ return m_voxelList.size(); }

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

inline

Definition at line 142 of file LArVoxelList.h.

References m_voxelList.

{ m_voxelList.swap( other.m_voxelList ); }

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

inline

Definition at line 147 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.upper_bound(key); }

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

inline

Definition at line 148 of file LArVoxelList.h.

References m_voxelList.

{ return m_voxelList.upper_bound(key); }

Friends And Related Function Documentation

const LArVoxelList operator* ( const double &  value, const LArVoxelList &  list  )

friend

Just in case: define the result of "scalar * LArVoxelList" to be the same as "LArVoxelList * scalar".

Definition at line 46 of file LArVoxelList.cxx.

  {
    return LArVoxelList(list) *= value;
  }

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

friend

Definition at line 92 of file LArVoxelList.cxx.

Referenced by operator*().

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

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

    // Write each voxel on a separate line.
    LArVoxelList::size_type nVoxel = 0;
    for ( LArVoxelList::const_iterator voxel = list.begin(); voxel != list.end(); ++voxel, ++nVoxel ){
      output.width( numberOfDigits );
      output << nVoxel << ": " 
             << "< " << (*voxel).first 
             << ", " << (*voxel).second 
             << " >\n";
    }
    
    return output;
  }

Member Data Documentation

list_type sim::LArVoxelList::m_voxelList

private

A sorted list of <LArVoxelID,double> pairs = (voxel ID, energy)

Definition at line 167 of file LArVoxelList.h.

Referenced by Add(), at(), begin(), clear(), Cut(), empty(), end(), Energy(), erase(), find(), ID(), insert(), lower_bound(), operator*=(), operator[](), rbegin(), rend(), size(), swap(), and upper_bound().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/Simulation/LArVoxelList.h
• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/Simulation/LArVoxelList.cxx