genie::geometry::PathSegmentList Class Reference

Object to be filled with the neutrino path-segments representing geometry volume steps (generally boundary-to-boundary) along with geometry materials. Good for a single starting position and travelling along the direction of the neutrino 4-momentum. More...

#include <PathSegmentList.h>

Public Types
typedef std::list< PathSegment >	PathSegmentV_t
typedef PathSegmentV_t::const_iterator	PathSegVCItr_t
typedef std::map< const TGeoMaterial *, Double_t >	MaterialMap_t
typedef MaterialMap_t::const_iterator	MaterialMapCItr_t

Public Member Functions
	PathSegmentList ()
	PathSegmentList (const PathSegmentList &plist)
	~PathSegmentList ()
void	SetDoCrossCheck (bool doit=true)
void	SetPrintVerbose (bool doit=true)
void	SetAllToZero (void)
void	SetStartInfo (const TVector3 &pos=TVector3(0, 0, 1e37), const TVector3 &dir=TVector3(0, 0, 0))
bool	IsSameStart (const TVector3 &pos, const TVector3 &dir) const
void	AddSegment (const PathSegment &ps)
const TVector3 &	GetDirection () const
const TVector3 &	GetStartPos () const
const PathSegmentV_t &	GetPathSegmentV (void) const
size_t	size (void) const
void	FillMatStepSum (void)
const MaterialMap_t &	GetMatStepSumMap (void) const
void	CrossCheck (double &mxddist, double &mxdstep) const
void	Copy (const PathSegmentList &plist)
PathSegmentList &	operator= (const PathSegmentList &list)
void	Print (ostream &stream) const

Protected Attributes
TVector3	fStartPos
	Record, for future comparison, the path taken.
TVector3	fDirection
	direction (in top vol coords)
PathSegmentV_t	fSegmentList
	Actual list of segments.
MaterialMap_t	fMatStepSum
	Segment list re-evaluated by material for fast lookup of path lengths.
bool	fDoCrossCheck
bool	fPrintVerbose

Friends
ostream &	operator<< (ostream &stream, const PathSegmentList &list)

Detailed Description

Object to be filled with the neutrino path-segments representing geometry volume steps (generally boundary-to-boundary) along with geometry materials. Good for a single starting position and travelling along the direction of the neutrino 4-momentum.

Author

Robert Hatcher rhatc.nosp@m.her@.nosp@m.fnal..nosp@m.gov FNAL

Created:\n May 26, 2009

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 123 of file PathSegmentList.h.

Member Typedef Documentation

MaterialMap_t

typedef std::map<const TGeoMaterial*,Double_t> genie::geometry::PathSegmentList::MaterialMap_t

Definition at line 147 of file PathSegmentList.h.

MaterialMapCItr_t

typedef MaterialMap_t::const_iterator genie::geometry::PathSegmentList::MaterialMapCItr_t

Definition at line 148 of file PathSegmentList.h.

PathSegmentV_t

typedef std::list<PathSegment> genie::geometry::PathSegmentList::PathSegmentV_t

Definition at line 141 of file PathSegmentList.h.

PathSegVCItr_t

typedef PathSegmentV_t::const_iterator genie::geometry::PathSegmentList::PathSegVCItr_t

Definition at line 142 of file PathSegmentList.h.

Constructor & Destructor Documentation

PathSegmentList() [1/2]

PathSegmentList::PathSegmentList

(

void

)

Definition at line 188 of file PathSegmentList.cxx.

  : fDoCrossCheck(false), fPrintVerbose(false)
{
 
}

References fDoCrossCheck, and fPrintVerbose.

Referenced by Copy(), operator=(), and PathSegmentList().

PathSegmentList() [2/2]

PathSegmentList::PathSegmentList

(

const PathSegmentList &

plist

)

Definition at line 194 of file PathSegmentList.cxx.

{
  this->Copy(plist);
}

References Copy(), and PathSegmentList().

~PathSegmentList()

PathSegmentList::~PathSegmentList

(

)

Definition at line 199 of file PathSegmentList.cxx.

{
 
}

Member Function Documentation

AddSegment()

void genie::geometry::PathSegmentList::AddSegment ( const PathSegment & ps )

inline

Definition at line 136 of file PathSegmentList.h.

{ fSegmentList.push_back(ps); }

References fSegmentList.

Referenced by genie::geometry::GeomVolSelectorI::GenerateTrimmedList().

Copy()

void PathSegmentList::Copy

(

const PathSegmentList &

plist

)

Definition at line 245 of file PathSegmentList.cxx.

{
  fSegmentList.clear();
  fMatStepSum.clear();
 
  // copy the segments
  //vector<PathSegment>::const_iterator pl_iter;
  //for (pl_iter = plist.fSegmentList.begin(); pl_iter != plist.fSegmentList.end(); ++pl_iter) {
  //  this->fSegmentList.push_back( *pl_iter );
  //}
 
  // other elements
  fStartPos     = plist.fStartPos;
  fDirection    = plist.fDirection;
  fSegmentList  = plist.fSegmentList;
  fMatStepSum   = plist.fMatStepSum;
  fDoCrossCheck = plist.fDoCrossCheck;
  fPrintVerbose = plist.fPrintVerbose;
}

References fDirection, fDoCrossCheck, fMatStepSum, fPrintVerbose, fSegmentList, fStartPos, and PathSegmentList().

Referenced by operator=(), and PathSegmentList().

CrossCheck()

void PathSegmentList::CrossCheck	(	double &	mxddist,
		double &	mxdstep ) const

Definition at line 266 of file PathSegmentList.cxx.

{
 
  double dstep, ddist;
  mxdstep = 0;
  mxddist = 0;
  PathSegmentList::PathSegVCItr_t sitr = fSegmentList.begin();
  PathSegmentList::PathSegVCItr_t sitr_end = fSegmentList.end();
  for ( ; sitr != sitr_end ; ++sitr ) {
    const PathSegment& ps = *sitr;
    ps.DoCrossCheck(fStartPos,ddist,dstep);
    double addist = TMath::Abs(ddist);
    double adstep = TMath::Abs(dstep);
    if ( addist > mxddist ) mxddist = addist;
    if ( adstep > mxdstep ) mxdstep = adstep;
  }
 
}

References genie::geometry::PathSegment::DoCrossCheck(), fSegmentList, and fStartPos.

FillMatStepSum()

void PathSegmentList::FillMatStepSum

(

void

)

Definition at line 229 of file PathSegmentList.cxx.

{
  fMatStepSum.clear();
 
  PathSegmentList::PathSegVCItr_t sitr = fSegmentList.begin();
  PathSegmentList::PathSegVCItr_t sitr_end = fSegmentList.end();
  for ( ; sitr != sitr_end ; ++sitr ) {
    const PathSegment& ps = *sitr;
    const TGeoMaterial* mat  = ps.fMaterial;
    // use the post-trim limits on how much material is stepped through
    fMatStepSum[mat] += ps.GetSummedStepRange();
  }
 
}

References genie::geometry::PathSegment::fMaterial, fMatStepSum, fSegmentList, and genie::geometry::PathSegment::GetSummedStepRange().

GetDirection()

const TVector3 & genie::geometry::PathSegmentList::GetDirection ( ) const

inline

Definition at line 138 of file PathSegmentList.h.

{ return fDirection; }

References fDirection.

Referenced by genie::geometry::GeomVolSelectorI::GenerateTrimmedList().

GetMatStepSumMap()

const MaterialMap_t & genie::geometry::PathSegmentList::GetMatStepSumMap ( void ) const

inline

Definition at line 151 of file PathSegmentList.h.

{ return fMatStepSum; };

References fMatStepSum.

Referenced by Print().

GetPathSegmentV()

const PathSegmentV_t & genie::geometry::PathSegmentList::GetPathSegmentV ( void ) const

inline

Definition at line 144 of file PathSegmentList.h.

{ return fSegmentList; }

References fSegmentList.

Referenced by genie::geometry::GeomVolSelectorI::GenerateTrimmedList().

GetStartPos()

const TVector3 & genie::geometry::PathSegmentList::GetStartPos ( ) const

inline

Definition at line 139 of file PathSegmentList.h.

{ return fStartPos; }

References fStartPos.

Referenced by genie::geometry::GeomVolSelectorI::GenerateTrimmedList().

IsSameStart()

bool PathSegmentList::IsSameStart	(	const TVector3 &	pos,
		const TVector3 &	dir ) const

Definition at line 223 of file PathSegmentList.cxx.

{
  return ( this->fStartPos == pos && this->fDirection == dir );
}

References dir, fDirection, and fStartPos.

operator=()

PathSegmentList & PathSegmentList::operator=

(

const PathSegmentList &

list

)

Definition at line 442 of file PathSegmentList.cxx.

{
  this->Copy(list);
  return (*this);
}

References Copy(), and PathSegmentList().

Print()

void PathSegmentList::Print

(

ostream &

stream

)

const

Definition at line 286 of file PathSegmentList.cxx.

{
  stream << "\nPathSegmentList [-]" << endl;
  stream << " start " << pathsegutils::Vec3AsString(&fStartPos)
         << " dir " << pathsegutils::Vec3AsString(&fDirection) << endl;
 
  double dstep, ddist, mxdstep = 0, mxddist = 0;
  int k = 0, nseg = 0;
  PathSegmentList::PathSegVCItr_t sitr = fSegmentList.begin();
  PathSegmentList::PathSegVCItr_t sitr_end = fSegmentList.end();
  for ( ; sitr != sitr_end ; ++sitr, ++k ) {
    const PathSegment& ps = *sitr;
    ++nseg;
    stream << " [" << setw(4) << k << "] " << ps;
    if ( fDoCrossCheck ) {
      ps.DoCrossCheck(fStartPos,ddist,dstep);
      double addist = TMath::Abs(ddist);
      double adstep = TMath::Abs(dstep);
      if ( addist > mxddist ) mxddist = addist;
      if ( adstep > mxdstep ) mxdstep = adstep;
      stream << " recalc diff"
             << " dist " << std::setw(12) << ddist
             << " step " << std::setw(12) << dstep;
        }
    stream << std::endl;
  }
  if ( nseg == 0 ) stream << " holds no segments." << std::endl;
 
  if ( fDoCrossCheck )
    stream << "PathSegmentList "
           << " mxddist " << mxddist
           << " mxdstep " << mxdstep
           << std::endl;
 
  if ( fPrintVerbose ) {
    PathSegmentList::MaterialMapCItr_t mitr     = GetMatStepSumMap().begin();
    PathSegmentList::MaterialMapCItr_t mitr_end = GetMatStepSumMap().end();
    // loop over map to get tgt weight for each material (once)
    // steps outside the geometry may have no assigned material
    for ( ; mitr != mitr_end; ++mitr ) {
      const TGeoMaterial* mat = mitr->first;
      double sumsteps         = mitr->second;
      stream << " fMatStepSum[" << mat->GetName() << "] = " << sumsteps << std::endl;
    }
  }
 
}

References genie::geometry::PathSegment::DoCrossCheck(), fDirection, fDoCrossCheck, fPrintVerbose, fSegmentList, fStartPos, GetMatStepSumMap(), and genie::pathsegutils::Vec3AsString().

Referenced by operator<<.

SetAllToZero()

void PathSegmentList::SetAllToZero

(

void

)

Definition at line 205 of file PathSegmentList.cxx.

{
  LOG("PathS", pDEBUG) << "SetAllToZero called";
 
  this->fStartPos.SetXYZ(0,0,1e37); // clear cache of position/direction
  this->fDirection.SetXYZ(0,0,0);   //
  this->fSegmentList.clear();       // clear the vector
  this->fMatStepSum.clear();        // clear the re-factorized info
}

References fDirection, fMatStepSum, fSegmentList, fStartPos, LOG, and pDEBUG.

SetDoCrossCheck()

void genie::geometry::PathSegmentList::SetDoCrossCheck ( bool doit = true )

inline

Definition at line 130 of file PathSegmentList.h.

{ fDoCrossCheck = doit; }

References fDoCrossCheck.

SetPrintVerbose()

void genie::geometry::PathSegmentList::SetPrintVerbose ( bool doit = true )

inline

Definition at line 131 of file PathSegmentList.h.

{ fPrintVerbose = doit; }

References fPrintVerbose.

SetStartInfo()

void PathSegmentList::SetStartInfo	(	const TVector3 &	pos = TVector3(0,0,1e37),
		const TVector3 &	dir = TVector3(0,0,0) )

Definition at line 216 of file PathSegmentList.cxx.

{
  this->fStartPos  = pos;
  this->fDirection = dir;
}

References dir, fDirection, and fStartPos.

Referenced by genie::geometry::GeomVolSelectorI::GenerateTrimmedList().

size()

size_t genie::geometry::PathSegmentList::size ( void ) const

inline

Definition at line 145 of file PathSegmentList.h.

{ return fSegmentList.size(); }

References fSegmentList.

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream & stream, const PathSegmentList & list )

friend

Definition at line 51 of file PathSegmentList.cxx.

 {
   list.Print(stream);
   return stream;
 }

References Print().

Member Data Documentation

fDirection

TVector3 genie::geometry::PathSegmentList::fDirection

protected

direction (in top vol coords)

Definition at line 170 of file PathSegmentList.h.

Referenced by Copy(), GetDirection(), IsSameStart(), Print(), SetAllToZero(), and SetStartInfo().

fDoCrossCheck

bool genie::geometry::PathSegmentList::fDoCrossCheck

protected

Definition at line 178 of file PathSegmentList.h.

Referenced by Copy(), PathSegmentList(), Print(), and SetDoCrossCheck().

fMatStepSum

MaterialMap_t genie::geometry::PathSegmentList::fMatStepSum

protected

Segment list re-evaluated by material for fast lookup of path lengths.

Definition at line 176 of file PathSegmentList.h.

Referenced by Copy(), FillMatStepSum(), GetMatStepSumMap(), and SetAllToZero().

fPrintVerbose

bool genie::geometry::PathSegmentList::fPrintVerbose

protected

Definition at line 179 of file PathSegmentList.h.

Referenced by Copy(), PathSegmentList(), Print(), and SetPrintVerbose().

fSegmentList

PathSegmentV_t genie::geometry::PathSegmentList::fSegmentList

protected

Actual list of segments.

Definition at line 173 of file PathSegmentList.h.

Referenced by AddSegment(), Copy(), CrossCheck(), FillMatStepSum(), GetPathSegmentV(), Print(), SetAllToZero(), and size().

fStartPos

TVector3 genie::geometry::PathSegmentList::fStartPos

protected

Record, for future comparison, the path taken.

starting position (in top vol coords)

Definition at line 169 of file PathSegmentList.h.

Referenced by Copy(), CrossCheck(), GetStartPos(), IsSameStart(), Print(), SetAllToZero(), and SetStartInfo().

---

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

• PathSegmentList.h
• PathSegmentList.cxx