sim::LArVoxelData Class Reference

#include "LArVoxelData.h"

Public Types
typedef util::VectorMap< int, double >	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
	LArVoxelData ()
virtual	~LArVoxelData ()
mapped_type	AssignedEnergy () const
mapped_type	UnassignedEnergy () const
mapped_type	Energy () const
size_type	NumberParticles () const
const key_type &	TrackID (const size_type) const
const mapped_type &	Energy (const size_type) const
void	Add (const mapped_type &energy, const key_type &trackID)
void	Add (const mapped_type &energy)
sim::LArVoxelID	VoxelID () const
void	SetVoxelID (sim::LArVoxelID voxID)
void	Add (const LArVoxelData &)
LArVoxelData &	operator+= (const LArVoxelData &other)
const LArVoxelData	operator+ (const LArVoxelData &other) const
LArVoxelData &	operator*= (const double &value)
const LArVoxelData	operator* (const double &value) const
size_type	RemoveTrack (const int &track)
void	RemoveAllTracks ()
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 (LArVoxelData &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
size_type	erase (const key_type &key)
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)

Private Attributes
mapped_type	fenergy
list_type	ftrackEnergy
sim::LArVoxelID	fVoxelID

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

Detailed Description

Definition at line 70 of file LArVoxelData.h.

Member Typedef Documentation

typedef list_type::allocator_type sim::LArVoxelData::allocator_type

Definition at line 87 of file LArVoxelData.h.

typedef list_type::const_iterator sim::LArVoxelData::const_iterator

Definition at line 81 of file LArVoxelData.h.

typedef list_type::const_reverse_iterator sim::LArVoxelData::const_reverse_iterator

Definition at line 83 of file LArVoxelData.h.

typedef list_type::difference_type sim::LArVoxelData::difference_type

Definition at line 85 of file LArVoxelData.h.

typedef list_type::iterator sim::LArVoxelData::iterator

Definition at line 80 of file LArVoxelData.h.

typedef list_type::key_compare sim::LArVoxelData::key_compare

Definition at line 86 of file LArVoxelData.h.

typedef list_type::key_type sim::LArVoxelData::key_type

Definition at line 77 of file LArVoxelData.h.

typedef util::VectorMap<int, double> sim::LArVoxelData::list_type

Definition at line 76 of file LArVoxelData.h.

typedef list_type::mapped_type sim::LArVoxelData::mapped_type

Definition at line 78 of file LArVoxelData.h.

typedef list_type::reverse_iterator sim::LArVoxelData::reverse_iterator

Definition at line 82 of file LArVoxelData.h.

typedef list_type::size_type sim::LArVoxelData::size_type

Definition at line 84 of file LArVoxelData.h.

typedef list_type::value_type sim::LArVoxelData::value_type

Definition at line 79 of file LArVoxelData.h.

Constructor & Destructor Documentation

sim::LArVoxelData::LArVoxelData

(

)

Definition at line 14 of file LArVoxelData.cxx.

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

    : fenergy(0)
  {}

sim::LArVoxelData::~LArVoxelData ( )

virtual

Definition at line 20 of file LArVoxelData.cxx.

{}

Member Function Documentation

void sim::LArVoxelData::Add ( const mapped_type &  energy, const key_type &  trackID  )

inline

Definition at line 230 of file LArVoxelData.h.

References energy, and ftrackEnergy.

Referenced by operator+=().

{ ftrackEnergy[trackID] += energy; }

void sim::LArVoxelData::Add ( const mapped_type &  energy )

inline

Definition at line 233 of file LArVoxelData.h.

References energy, and fenergy.

{ fenergy += energy; } 

void sim::LArVoxelData::Add

(

const LArVoxelData &

other

)

Definition at line 39 of file LArVoxelData.cxx.

References Energy(), fenergy, and RemoveAllTracks().

  {
    // When we add one voxel's data to another, it becomes impossible
    // to keep the particle<->energy assignments anymore; the most
    // likely reason to add two voxels is because we're adding events
    // to make overlays, and so the particles' track numbers change.

    // So if we're adding another LArVoxelData to this one, move all
    // the energies to "unassigned" in the sum.

    this->RemoveAllTracks();
    fenergy += other.Energy();
  }

sim::LArVoxelData::mapped_type sim::LArVoxelData::AssignedEnergy ( ) const

inline

Definition at line 204 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), util::VectorMap< _Key, _Tp, _Compare >::end(), and ftrackEnergy.

{
  return std::accumulate( ftrackEnergy.begin(), ftrackEnergy.end(), 0.0,
                          util::SumSecondFunction<key_type,mapped_type>() );
}

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

inline

Definition at line 286 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::at(), and ftrackEnergy.

{ return ftrackEnergy.at(key); }           

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

inline

Definition at line 288 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::at(), and ftrackEnergy.

{ return ftrackEnergy.at(key); }           

sim::LArVoxelData::iterator sim::LArVoxelData::begin ( )

inline

Definition at line 248 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), and ftrackEnergy.

Referenced by sim::operator<<().

{ return ftrackEnergy.begin();  }

sim::LArVoxelData::const_iterator sim::LArVoxelData::begin ( ) const

inline

Definition at line 249 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), and ftrackEnergy.

{ return ftrackEnergy.begin();  }                          

void sim::LArVoxelData::clear ( void  )

inline

Definition at line 266 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::clear(), fenergy, and ftrackEnergy.

{ fenergy = 0.; ftrackEnergy.clear(); } 

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

inline

Definition at line 258 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::empty(), and ftrackEnergy.

{ return ftrackEnergy.empty();  }                          

sim::LArVoxelData::iterator sim::LArVoxelData::end ( void  )

inline

Definition at line 250 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::end(), and ftrackEnergy.

Referenced by operator*=(), and sim::operator<<().

{ return ftrackEnergy.end();    }                          

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

inline

Definition at line 251 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::end(), and ftrackEnergy.

{ return ftrackEnergy.end();    }                          

sim::LArVoxelData::mapped_type sim::LArVoxelData::Energy ( ) const

inline

Definition at line 209 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), util::VectorMap< _Key, _Tp, _Compare >::end(), fenergy, and ftrackEnergy.

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

{
  return std::accumulate( ftrackEnergy.begin(), ftrackEnergy.end(), fenergy,
                          util::SumSecondFunction<key_type,mapped_type>() );
}

const LArVoxelData::mapped_type & sim::LArVoxelData::Energy

(

const size_type

index

)

const

Definition at line 31 of file LArVoxelData.cxx.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), and ftrackEnergy.

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

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

inline

Definition at line 279 of file LArVoxelData.h.

References RemoveTrack().

{ return this->RemoveTrack(key);        }

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

inline

Definition at line 267 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::find(), and ftrackEnergy.

{ return ftrackEnergy.find(key);        }

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

inline

Definition at line 269 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::find(), and ftrackEnergy.

{ return ftrackEnergy.find(key);        }

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

inline

Definition at line 290 of file LArVoxelData.h.

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

{ ftrackEnergy[key] = value; }    

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

inline

Definition at line 275 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::lower_bound().

{ return ftrackEnergy.lower_bound(key); }

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

inline

Definition at line 277 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::lower_bound().

{ return ftrackEnergy.lower_bound(key); }

sim::LArVoxelData::size_type sim::LArVoxelData::NumberParticles ( ) const

inline

Definition at line 202 of file LArVoxelData.h.

References size().

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

{ return size();    }

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

inline

Definition at line 244 of file LArVoxelData.h.

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

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

LArVoxelData & sim::LArVoxelData::operator*=

(

const double &

value

)

Definition at line 54 of file LArVoxelData.cxx.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), end(), util::VectorMap< _Key, _Tp, _Compare >::end(), fenergy, ftrackEnergy, and fhicl::detail::atom::value().

  {
    // Multiply all energies by the value.
    for ( iterator i = ftrackEnergy.begin(), end = ftrackEnergy.end(); i != end; ++i )
      {
        (*i).second *= value;
      }
    fenergy *= value;

    return (*this);
  }

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

inline

Definition at line 240 of file LArVoxelData.h.

References LArVoxelData(), and fhicl::other.

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

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

inline

Definition at line 235 of file LArVoxelData.h.

References Add().

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

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

inline

Definition at line 282 of file LArVoxelData.h.

References ftrackEnergy.

{ return ftrackEnergy[key];    }           

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

inline

Definition at line 284 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::at(), and ftrackEnergy.

{ return ftrackEnergy.at(key); }           

sim::LArVoxelData::reverse_iterator sim::LArVoxelData::rbegin ( )

inline

Definition at line 252 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::rbegin().

{ return ftrackEnergy.rbegin(); }                          

sim::LArVoxelData::const_reverse_iterator sim::LArVoxelData::rbegin ( ) const

inline

Definition at line 253 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::rbegin().

{ return ftrackEnergy.rbegin(); }                          

void sim::LArVoxelData::RemoveAllTracks ( )

inline

Definition at line 225 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::clear(), Energy(), fenergy, and ftrackEnergy.

Referenced by Add().

{
  fenergy = this->Energy();
  ftrackEnergy.clear();
}

sim::LArVoxelData::size_type sim::LArVoxelData::RemoveTrack ( const int &  track )

inline

Definition at line 214 of file LArVoxelData.h.

References util::VectorMap< _Key, _Tp, _Compare >::end(), util::VectorMap< _Key, _Tp, _Compare >::erase(), fenergy, util::VectorMap< _Key, _Tp, _Compare >::find(), and ftrackEnergy.

Referenced by erase().

{
  iterator search = ftrackEnergy.find( track );
  if ( search != ftrackEnergy.end() )
    {
      fenergy += (*search).second;
      ftrackEnergy.erase( search );
      return 1;
    }
  else return 0;
}

sim::LArVoxelData::reverse_iterator sim::LArVoxelData::rend ( )

inline

Definition at line 254 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::rend().

{ return ftrackEnergy.rend();   }                          

sim::LArVoxelData::const_reverse_iterator sim::LArVoxelData::rend ( ) const

inline

Definition at line 255 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::rend().

{ return ftrackEnergy.rend();   }                          

void sim::LArVoxelData::SetVoxelID ( sim::LArVoxelID  voxID )

inline

Definition at line 200 of file LArVoxelData.h.

References fVoxelID.

{ fVoxelID = voxID; }

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

inline

Definition at line 257 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::size().

Referenced by NumberParticles().

{ return ftrackEnergy.size();   }                          

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

inline

Definition at line 259 of file LArVoxelData.h.

References fenergy, ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::swap().

{                                                                                                  
  ftrackEnergy.swap( other.ftrackEnergy );                                                         
  double temp = fenergy;                                                                           
  fenergy = other.fenergy;                                                                         
  other.fenergy = temp;                                                                    
}                                                                                                  

const LArVoxelData::key_type & sim::LArVoxelData::TrackID

(

const size_type

index

)

const

Definition at line 23 of file LArVoxelData.cxx.

References util::VectorMap< _Key, _Tp, _Compare >::begin(), and ftrackEnergy.

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

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

sim::LArVoxelData::mapped_type sim::LArVoxelData::UnassignedEnergy ( ) const

inline

Definition at line 203 of file LArVoxelData.h.

References fenergy.

Referenced by sim::operator<<().

{ return fenergy;   }

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

inline

Definition at line 271 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::upper_bound().

{ return ftrackEnergy.upper_bound(key); }

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

inline

Definition at line 273 of file LArVoxelData.h.

References ftrackEnergy, and util::VectorMap< _Key, _Tp, _Compare >::upper_bound().

{ return ftrackEnergy.upper_bound(key); }

sim::LArVoxelID sim::LArVoxelData::VoxelID ( ) const

inline

Definition at line 201 of file LArVoxelData.h.

References fVoxelID.

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

{ return fVoxelID;  }

Friends And Related Function Documentation

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

friend

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

Definition at line 69 of file LArVoxelData.cxx.

  {
    return LArVoxelData(data) *= value;
  }

std::ostream& operator<< ( std::ostream &  output, const LArVoxelData &  data  )

friend

Definition at line 75 of file LArVoxelData.cxx.

  {
    output << "Voxel: " << data.VoxelID() << std::endl;

    double unassigned = data.UnassignedEnergy();
    // Display the total energy then the breakdown of
    // the sum.
    output << data.Energy() << " = <ID,E>=";
    for ( LArVoxelData::const_iterator i = data.begin(); i != data.end(); ++i){
      if ( i != data.begin() )
        output << ",";
      
      output << "<" << (*i).first << "," << (*i).second << ">";
    }
    if( unassigned > 0 )
      output << ",<*," << unassigned << ">";

    return output;
  }

Member Data Documentation

mapped_type sim::LArVoxelData::fenergy

private

Definition at line 96 of file LArVoxelData.h.

Referenced by Add(), clear(), Energy(), operator*=(), RemoveAllTracks(), RemoveTrack(), swap(), and UnassignedEnergy().

list_type sim::LArVoxelData::ftrackEnergy

private

Definition at line 101 of file LArVoxelData.h.

Referenced by Add(), AssignedEnergy(), at(), begin(), clear(), empty(), end(), Energy(), find(), insert(), lower_bound(), operator*=(), operator[](), rbegin(), RemoveAllTracks(), RemoveTrack(), rend(), size(), swap(), TrackID(), and upper_bound().

sim::LArVoxelID sim::LArVoxelData::fVoxelID

private

Definition at line 103 of file LArVoxelData.h.

Referenced by SetVoxelID(), and VoxelID().

---

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

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