Public Types | Public Member Functions | Private Attributes | Friends | List of all members
simb::MCTrajectory Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/nusimdata/v1_16_04/source/nusimdata/SimulationBase/MCTrajectory.h"

Public Types

typedef std::vector< std::pair< TLorentzVector, TLorentzVector > > list_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 std::vector< std::pair< size_t, unsigned char > > ProcessMap
 

Public Member Functions

 MCTrajectory ()
 
 MCTrajectory (const TLorentzVector &vertex, const TLorentzVector &momentum)
 
const TLorentzVector & Position (const size_type) const
 The accessor methods described above. More...
 
const TLorentzVector & Momentum (const size_type) const
 
double X (const size_type i) const
 
double Y (const size_type i) const
 
double Z (const size_type i) const
 
double T (const size_type i) const
 
double Px (const size_type i) const
 
double Py (const size_type i) const
 
double Pz (const size_type i) const
 
double E (const size_type i) const
 
double TotalLength () 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 (simb::MCTrajectory &other)
 
void clear ()
 
const value_typeoperator[] (const size_type i) const
 
const value_typeat (const size_type i) const
 
void push_back (value_type const &v)
 
void push_back (TLorentzVector const &p, TLorentzVector const &m)
 
void Add (TLorentzVector const &p, TLorentzVector const &m)
 
void Add (TLorentzVector const &p, TLorentzVector const &m, std::string const &process)
 
unsigned char ProcessToKey (std::string const &process) const
 
std::string KeyToProcess (unsigned char const &key) const
 
ProcessMap const & TrajectoryProcesses () const
 
void Sparsify (double margin=.1)
 

Private Attributes

list_type ftrajectory
 The list of trajectory points. More...
 
ProcessMap fTrajectoryProcess
 

Friends

std::ostream & operator<< (std::ostream &output, const MCTrajectory &)
 

Detailed Description

Definition at line 58 of file MCTrajectory.h.

Member Typedef Documentation

typedef list_type::const_iterator simb::MCTrajectory::const_iterator

Definition at line 66 of file MCTrajectory.h.

typedef list_type::const_reverse_iterator simb::MCTrajectory::const_reverse_iterator

Definition at line 68 of file MCTrajectory.h.

typedef list_type::difference_type simb::MCTrajectory::difference_type

Definition at line 70 of file MCTrajectory.h.

typedef list_type::iterator simb::MCTrajectory::iterator

Definition at line 65 of file MCTrajectory.h.

typedef std::vector< std::pair<TLorentzVector, TLorentzVector> > simb::MCTrajectory::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 63 of file MCTrajectory.h.

typedef std::vector< std::pair<size_t, unsigned char> > simb::MCTrajectory::ProcessMap

Definition at line 71 of file MCTrajectory.h.

typedef list_type::reverse_iterator simb::MCTrajectory::reverse_iterator

Definition at line 67 of file MCTrajectory.h.

typedef list_type::size_type simb::MCTrajectory::size_type

Definition at line 69 of file MCTrajectory.h.

typedef list_type::value_type simb::MCTrajectory::value_type

Definition at line 64 of file MCTrajectory.h.

Constructor & Destructor Documentation

simb::MCTrajectory::MCTrajectory ( )

Standard constructor: Start with initial position and momentum of the particle.

Definition at line 24 of file MCTrajectory.cxx.

25  : ftrajectory()
26  {}
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::MCTrajectory ( const TLorentzVector &  vertex,
const TLorentzVector &  momentum 
)

Definition at line 29 of file MCTrajectory.cxx.

References ftrajectory.

31  {
32  ftrajectory.push_back( value_type( position, momentum ) );
33  }
list_type::value_type value_type
Definition: MCTrajectory.h:64
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77

Member Function Documentation

void simb::MCTrajectory::Add ( TLorentzVector const &  p,
TLorentzVector const &  m 
)
void simb::MCTrajectory::Add ( TLorentzVector const &  p,
TLorentzVector const &  m,
std::string const &  process 
)

Definition at line 129 of file MCTrajectory.cxx.

References ftrajectory, fTrajectoryProcess, findDuplicateFiles::key, make_pair(), ProcessToKey(), and push_back().

132  {
133  // add the the momentum and position, then get the location of the added
134  // bits to store the process
135  this->push_back(p, m);
136 
137  size_t insertLoc = ftrajectory.size() - 1;
138 
139  auto key = this->ProcessToKey(process);
140 
141  // only add a process to the list if it is defined, ie one of the values
142  // allowed in the ProcessToKey() method
143  if(key > 0)
144  fTrajectoryProcess.push_back(std::make_pair(insertLoc, key));
145 
146  return;
147  }
void push_back(value_type const &v)
const char * p
Definition: xmltok.h:285
std::pair< Spectrum *, CheatDecomp * > make_pair(SpectrumLoaderBase &loader_data, SpectrumLoaderBase &loader_mc, HistAxis *axis, Cut *cut, const SystShifts &shift, const Var &wei)
Definition: DataMCLoad.C:336
unsigned char ProcessToKey(std::string const &process) const
ProcessMap fTrajectoryProcess
Definition: MCTrajectory.h:78
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
const simb::MCTrajectory::value_type & simb::MCTrajectory::at ( const size_type  i) const
inline

Definition at line 174 of file MCTrajectory.h.

References Add(), ftrajectory, m, push_back(), and registry_explorer::v.

Referenced by Sparsify().

175  { return ftrajectory.at(i); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::iterator simb::MCTrajectory::begin ( )
inline

Standard STL methods, to make this class look like an STL map. Again, if you don't know STL, you can just ignore these methods.

Definition at line 157 of file MCTrajectory.h.

References ftrajectory.

Referenced by simb::operator<<(), and vf::TrackEva::Tracklength().

157 { return ftrajectory.begin(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::const_iterator simb::MCTrajectory::begin ( ) const
inline

Definition at line 158 of file MCTrajectory.h.

References ftrajectory.

158 { return ftrajectory.begin(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
void simb::MCTrajectory::clear ( )
inline

Definition at line 167 of file MCTrajectory.h.

References ftrajectory.

167 { ftrajectory.clear(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
double simb::MCTrajectory::E ( const size_type  i) const
inline

Definition at line 155 of file MCTrajectory.h.

References Momentum().

155 { return Momentum(i).E(); }
const TLorentzVector & Momentum(const size_type) const
bool simb::MCTrajectory::empty ( ) const
inline

Definition at line 166 of file MCTrajectory.h.

References ftrajectory.

166 { return ftrajectory.empty(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::iterator simb::MCTrajectory::end ( )
inline

Definition at line 159 of file MCTrajectory.h.

References ftrajectory.

Referenced by simb::operator<<(), and vf::TrackEva::Tracklength().

159 { return ftrajectory.end(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::const_iterator simb::MCTrajectory::end ( ) const
inline

Definition at line 160 of file MCTrajectory.h.

References ftrajectory.

160 { return ftrajectory.end(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
std::string simb::MCTrajectory::KeyToProcess ( unsigned char const &  key) const

Definition at line 113 of file MCTrajectory.cxx.

References launch_batch_jobs::process, and string.

114  {
115  std::string process("Unknown");
116 
117  if (key == 1) process = "hadElastic";
118  else if(key == 2) process = "pi-Inelastic";
119  else if(key == 3) process = "pi+Inelastic";
120  else if(key == 4) process = "kaon-Inelastic";
121  else if(key == 5) process = "kaon+Inelastic";
122  else if(key == 6) process = "protonInelastic";
123  else if(key == 7) process = "neutronInelastic";
124 
125  return process;
126  }
enum BeamMode string
const TLorentzVector & simb::MCTrajectory::Momentum ( const size_type  index) const

Definition at line 44 of file MCTrajectory.cxx.

References ftrajectory, and MECModelEnuComparisons::i.

Referenced by caf::AddCosmicTruthToVec(), g4n::G4Alg::CollectFLSHitsAndParticles(), E(), simb::MCParticle::Momentum(), Px(), Py(), and Pz().

45  {
46  const_iterator i = ftrajectory.begin();
47  std::advance(i,index);
48  return (*i).second;
49  }
list_type::const_iterator const_iterator
Definition: MCTrajectory.h:66
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
const simb::MCTrajectory::value_type & simb::MCTrajectory::operator[] ( const size_type  i) const
inline

Definition at line 171 of file MCTrajectory.h.

References ftrajectory, and MECModelEnuComparisons::i.

172  { return ftrajectory[i]; }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
const TLorentzVector & simb::MCTrajectory::Position ( const size_type  index) const

The accessor methods described above.

Definition at line 36 of file MCTrajectory.cxx.

References ftrajectory, and MECModelEnuComparisons::i.

Referenced by caf::AddCosmicTruthToVec(), earms::ElasticArmsValidate::analyze(), g4n::G4Alg::CollectFLSHitsAndParticles(), simb::MCParticle::Position(), T(), TotalLength(), X(), Y(), and Z().

37  {
38  const_iterator i = ftrajectory.begin();
39  std::advance(i,index);
40  return (*i).first;
41  }
list_type::const_iterator const_iterator
Definition: MCTrajectory.h:66
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
unsigned char simb::MCTrajectory::ProcessToKey ( std::string const &  process) const

Definition at line 97 of file MCTrajectory.cxx.

References findDuplicateFiles::key.

Referenced by Add().

98  {
99  unsigned char key = 0;
100 
101  if (process.compare("hadElastic") == 0) key = 1;
102  else if(process.compare("pi-Inelastic") == 0) key = 2;
103  else if(process.compare("pi+Inelastic") == 0) key = 3;
104  else if(process.compare("kaon-Inelastic") == 0) key = 4;
105  else if(process.compare("kaon+Inelastic") == 0) key = 5;
106  else if(process.compare("protonInelastic") == 0) key = 6;
107  else if(process.compare("neutronInelastic") == 0) key = 7;
108 
109  return key;
110  }
void simb::MCTrajectory::push_back ( value_type const &  v)

The only "set" methods for this class; once you've added a trajectory point, you can't take it back.

Referenced by Add(), at(), and g4n::G4Alg::CollectFLSHitsAndParticles().

void simb::MCTrajectory::push_back ( TLorentzVector const &  p,
TLorentzVector const &  m 
)
double simb::MCTrajectory::Px ( const size_type  i) const
inline

Definition at line 152 of file MCTrajectory.h.

References Momentum().

152 { return Momentum(i).Px(); }
const TLorentzVector & Momentum(const size_type) const
double simb::MCTrajectory::Py ( const size_type  i) const
inline

Definition at line 153 of file MCTrajectory.h.

References Momentum().

153 { return Momentum(i).Py(); }
const TLorentzVector & Momentum(const size_type) const
double simb::MCTrajectory::Pz ( const size_type  i) const
inline

Definition at line 154 of file MCTrajectory.h.

References Momentum().

154 { return Momentum(i).Pz(); }
const TLorentzVector & Momentum(const size_type) const
simb::MCTrajectory::reverse_iterator simb::MCTrajectory::rbegin ( )
inline

Definition at line 161 of file MCTrajectory.h.

References ftrajectory.

Referenced by Sparsify().

161 { return ftrajectory.rbegin(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::const_reverse_iterator simb::MCTrajectory::rbegin ( ) const
inline

Definition at line 162 of file MCTrajectory.h.

References ftrajectory.

162 { return ftrajectory.rbegin(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::reverse_iterator simb::MCTrajectory::rend ( )
inline

Definition at line 163 of file MCTrajectory.h.

References ftrajectory.

163 { return ftrajectory.rend(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::const_reverse_iterator simb::MCTrajectory::rend ( ) const
inline

Definition at line 164 of file MCTrajectory.h.

References ftrajectory.

164 { return ftrajectory.rend(); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
simb::MCTrajectory::size_type simb::MCTrajectory::size ( ) const
inline
void simb::MCTrajectory::Sparsify ( double  margin = .1)

Remove points from trajectory. Straight line interpolation between the remaining points will pass no further than margin from removed points.

Definition at line 150 of file MCTrajectory.cxx.

References at(), dir, ftrajectory, fTrajectoryProcess, MECModelEnuComparisons::i, compare_h5_caf::idx, Mag2(), make_pair(), rbegin(), size(), std::swap(), and Unit().

Referenced by simb::MCParticle::SparsifyTrajectory().

151  {
152  // This is a divide-and-conquer algorithm. If the straight line between two
153  // points is close enough to all the intermediate points, then just keep
154  // the endpoints. Otherwise, divide the range in two and try again.
155 
156  // We keep the ranges that need checking in "toCheck". If a range is good
157  // as-is, we put just the starting point in "done". The end-point will be
158  // taken care of by the next range.
159 
160  // Need at least three points to think of removing one
161  if(size() <= 2) return;
162 
163  // Deal in terms of distance-squared to save some sqrts
164  margin *= margin;
165 
166  // Deque because we add things still to check on the end, and pop things
167  // we've checked from the front.
168  std::deque<std::pair<int, int> > toCheck;
169  // Start off by trying to replace the whole trajectory with just the
170  // endpoints.
171  toCheck.push_back(std::make_pair(0, size()-1));
172 
173  // use a std::set to keep track of which indices of points we want to
174  // keep because the set does not allow duplicates and it keeps items in
175  // order
176  std::set<int> done;
177 
178  while(!toCheck.empty()){
179  const int loIdx = toCheck.front().first;
180  const int hiIdx = toCheck.front().second;
181  toCheck.pop_front();
182 
183  // Should never have been given a degenerate range
184  if(hiIdx < loIdx+2)
185  throw cet::exception("MCTrajectory") << "Degnerate range in Sparsify method";
186 
187  const TVector3 loVec = at(loIdx).first.Vect();
188  const TVector3 hiVec = at(hiIdx).first.Vect();
189 
190  const TVector3 dir = (hiVec-loVec).Unit();
191 
192  // Are all the points in between close enough?
193  bool ok = true;
194  for(int i = loIdx+1; i < hiIdx; ++i){
195  const TVector3 toHere = at(i).first.Vect()-loVec;
196  // Perpendicular distance^2 from the line joining loVec to hiVec
197  const double impact = (toHere-dir.Dot(toHere)*dir).Mag2();
198  if(impact > margin){ok = false; break;}
199  }
200 
201  if(ok){
202  // These points adequately represent this range
203  done.insert(loIdx);
204  }
205  else{
206  // Split in half
207  const int midIdx = (loIdx+hiIdx)/2;
208  // Should never have a range this small
209  if(midIdx == loIdx)
210  throw cet::exception("MCTrajectory") << "Midpoint in sparsification is same as lowpoint";
211  if(midIdx == hiIdx)
212  throw cet::exception("MCTrajectory") << "Midpoint in sparsification is same as hipoint";
213 
214  // The range can be small enough that upon splitting, the new ranges
215  // are degenerate, and should just be written out straight away. Check
216  // for those cases.
217 
218  if(midIdx == loIdx+1){
219  done.insert(loIdx);
220  }
221  else{
222  toCheck.push_back(std::make_pair(loIdx, midIdx));
223  }
224 
225  if(midIdx == hiIdx-1){
226  done.insert(midIdx);
227  }
228  else{
229  toCheck.push_back(std::make_pair(midIdx, hiIdx));
230  }
231  }
232  } // end while
233 
234  // now make sure we have not left out any of the indices where interesting
235  // processes were recorded
236  std::map< size_t, unsigned char> processMap;
237  for(auto itr : fTrajectoryProcess){
238  done.insert(itr.first);
239  processMap[itr.first] = itr.second;
240  }
241 
242  // Look up the trajectory points at the stored indices, write them to a new
243  // trajectory
244  const unsigned int I = done.size();
245  list_type newTraj;
246  newTraj.reserve(I+1);
247 
248  // make a new process map as well based on these points
249  ProcessMap newProcMap;
250 
251  for(auto idx : done){
252  newTraj.push_back(at(idx));
253  if(processMap.count(idx) > 0){
254  newProcMap.push_back(std::make_pair(newTraj.size() - 1,
255  processMap.find(idx)->second)
256  );
257  }
258  }
259 
260  // Remember to add the very last point in if it hasn't already been added
261  if(done.count(ftrajectory.size() - 1) < 1) newTraj.push_back(*rbegin());
262 
263  // Replace trajectory and fTrajectoryProcess with new versions
264  std::swap(ftrajectory, newTraj );
265  std::swap(fTrajectoryProcess, newProcMap);
266 
267  return;
268  }
reverse_iterator rbegin()
Definition: MCTrajectory.h:161
const value_type & at(const size_type i) const
Definition: MCTrajectory.h:174
::xsd::cxx::tree::exception< char > exception
Definition: Database.h:225
std::vector< std::pair< TLorentzVector, TLorentzVector > > list_type
Definition: MCTrajectory.h:63
std::pair< Spectrum *, CheatDecomp * > make_pair(SpectrumLoaderBase &loader_data, SpectrumLoaderBase &loader_mc, HistAxis *axis, Cut *cut, const SystShifts &shift, const Var &wei)
Definition: DataMCLoad.C:336
void swap(art::HLTGlobalStatus &lhs, art::HLTGlobalStatus &rhs)
ProcessMap fTrajectoryProcess
Definition: MCTrajectory.h:78
TVector3 Unit() const
std::vector< std::pair< size_t, unsigned char > > ProcessMap
Definition: MCTrajectory.h:71
float Mag2() const
size_type size() const
Definition: MCTrajectory.h:165
TDirectory * dir
Definition: macro.C:5
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
void simb::MCTrajectory::swap ( simb::MCTrajectory other)
inline

Definition at line 168 of file MCTrajectory.h.

References ftrajectory.

169  { ftrajectory.swap( other.ftrajectory ); }
list_type ftrajectory
The list of trajectory points.
Definition: MCTrajectory.h:77
double simb::MCTrajectory::T ( const size_type  i) const
inline

Definition at line 151 of file MCTrajectory.h.

References Position().

151 { return Position(i).T(); }
const TLorentzVector & Position(const size_type) const
The accessor methods described above.
double simb::MCTrajectory::TotalLength ( ) const

Definition at line 52 of file MCTrajectory.cxx.

References dist, getGoodRuns4SAM::n, Position(), size(), and Vect().

53  {
54  const int N = size();
55  if(N < 2) return 0;
56 
57  // We take the sum of the straight lines between the trajectory points
58  double dist = 0;
59  for(int n = 0; n < N-1; ++n){
60  dist += (Position(n+1)-Position(n)).Vect().Mag();
61  }
62 
63  return dist;
64  }
double dist
Definition: runWimpSim.h:113
const TLorentzVector & Position(const size_type) const
The accessor methods described above.
size_type size() const
Definition: MCTrajectory.h:165
TVector3 Vect() const
simb::MCTrajectory::ProcessMap const & simb::MCTrajectory::TrajectoryProcesses ( ) const
inline

Definition at line 187 of file MCTrajectory.h.

References fTrajectoryProcess.

187 { return fTrajectoryProcess; }
ProcessMap fTrajectoryProcess
Definition: MCTrajectory.h:78
double simb::MCTrajectory::X ( const size_type  i) const
inline

Definition at line 148 of file MCTrajectory.h.

References Position().

148 { return Position(i).X(); }
const TLorentzVector & Position(const size_type) const
The accessor methods described above.
double simb::MCTrajectory::Y ( const size_type  i) const
inline

Definition at line 149 of file MCTrajectory.h.

References Position().

149 { return Position(i).Y(); }
const TLorentzVector & Position(const size_type) const
The accessor methods described above.
double simb::MCTrajectory::Z ( const size_type  i) const
inline

Definition at line 150 of file MCTrajectory.h.

References Position().

150 { return Position(i).Z(); }
const TLorentzVector & Position(const size_type) const
The accessor methods described above.

Friends And Related Function Documentation

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

Definition at line 67 of file MCTrajectory.cxx.

68  {
69  // Determine a field width for the voxel number.
70  MCTrajectory::size_type numberOfTrajectories = list.size();
71  int numberOfDigits = (int) std::log10( (double) numberOfTrajectories ) + 1;
72 
73  // A simple header.
74  output.width( numberOfDigits );
75  output << "#" << ": < position (x,y,z,t), momentum (Px,Py,Pz,E) >" << std::endl;
76 
77  // Write each trajectory point on a separate line.
78  MCTrajectory::size_type nTrajectory = 0;
79  for ( MCTrajectory::const_iterator trajectory = list.begin(); trajectory != list.end(); ++trajectory, ++nTrajectory ){
80  output.width( numberOfDigits );
81  output << nTrajectory << ": "
82  << "< (" << (*trajectory).first.X()
83  << "," << (*trajectory).first.Y()
84  << "," << (*trajectory).first.Z()
85  << "," << (*trajectory).first.T()
86  << ") , (" << (*trajectory).second.Px()
87  << "," << (*trajectory).second.Py()
88  << "," << (*trajectory).second.Pz()
89  << "," << (*trajectory).second.E()
90  << ") >" << std::endl;
91  }
92 
93  return output;
94  }
ofstream output
list_type::size_type size_type
Definition: MCTrajectory.h:69
list_type::const_iterator const_iterator
Definition: MCTrajectory.h:66
T log10(T number)
Definition: d0nt_math.hpp:120

Member Data Documentation

list_type simb::MCTrajectory::ftrajectory
private

The list of trajectory points.

Definition at line 77 of file MCTrajectory.h.

Referenced by Add(), at(), begin(), clear(), empty(), end(), MCTrajectory(), Momentum(), operator[](), Position(), rbegin(), rend(), size(), Sparsify(), and swap().

ProcessMap simb::MCTrajectory::fTrajectoryProcess
private

map of the scattering process to index in ftrajectory for a given point

Definition at line 78 of file MCTrajectory.h.

Referenced by Add(), Sparsify(), and TrajectoryProcesses().


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