genie::PathLengthList Class Reference

Object to be filled with the neutrino path-length, for all detector geometry materials, when starting from a position x and travelling along the direction of the neutrino 4-momentum. More...

#include <PathLengthList.h>

Inheritance diagram for genie::PathLengthList:

Collaboration diagram for genie::PathLengthList:

Public Member Functions
	PathLengthList ()
	PathLengthList (const PDGCodeList &pdglist)
	PathLengthList (const PathLengthList &plist)
	PathLengthList (const map< int, double > &plist)
	~PathLengthList ()
void	AddPathLength (int pdgc, double pl)
void	SetPathLength (int pdgc, double pl)
void	SetAllToZero (void)
bool	AreAllZero (void) const
void	ScalePathLength (int pdgc, double scale)
double	PathLength (int pdgc) const
XmlParserStatus_t	LoadFromXml (string filename)
void	SaveAsXml (string filename) const
void	Copy (const PathLengthList &plist)
void	Print (ostream &stream) const
PathLengthList &	operator= (const PathLengthList &list)

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

Detailed Description

Object to be filled with the neutrino path-length, for all detector geometry materials, when starting from a position x and travelling along the direction of the neutrino 4-momentum.

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n May 24, 2005

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 42 of file PathLengthList.h.

Constructor & Destructor Documentation

PathLengthList() [1/4]

PathLengthList::PathLengthList

(

void

)

Definition at line 45 of file PathLengthList.cxx.

                                   :
map<int, double>()
{
 
}

Referenced by Copy(), operator<<, operator=(), and PathLengthList().

PathLengthList() [2/4]

PathLengthList::PathLengthList

(

const PDGCodeList &

pdglist

)

Definition at line 51 of file PathLengthList.cxx.

                                                           :
map<int, double>()
{
  PDGCodeList::const_iterator pdg_iter;
 
  for(pdg_iter = pdg_list.begin(); pdg_iter != pdg_list.end(); ++pdg_iter) {
     int pdgc = *pdg_iter;
     this->insert( map<int, double>::value_type(pdgc, 0.) );
  }
}

PathLengthList() [3/4]

PathLengthList::PathLengthList

(

const PathLengthList &

plist

)

Definition at line 62 of file PathLengthList.cxx.

                                                           :
map<int, double>()
{
  this->Copy(plist);
}

References Copy(), and PathLengthList().

PathLengthList() [4/4]

PathLengthList::PathLengthList

(

const map< int, double > &

plist

)

Definition at line 68 of file PathLengthList.cxx.

                                                            :
map<int, double>()
{
  map<int,double>::const_iterator iter;
 
  for(iter = plist.begin(); iter != plist.end(); ++iter) {
     int    pdgc = iter->first;
     double pl   = iter->second;
     this->insert( map<int, double>::value_type(pdgc, pl) );
  }
}

~PathLengthList()

PathLengthList::~PathLengthList

(

)

Definition at line 80 of file PathLengthList.cxx.

{
 
}

Member Function Documentation

AddPathLength()

void PathLengthList::AddPathLength	(	int	pdgc,
		double	pl )

Definition at line 85 of file PathLengthList.cxx.

{
// Adds pl to the total path length for material with code = pdgc
 
  if (this->count(pdgc) == 1) { (*this)[pdgc] += pl; }
  else {
     LOG("PathL", pWARN)
         << "No material with PDG code = " << pdgc << " in path length list";
  }
}

References LOG, and pWARN.

AreAllZero()

bool PathLengthList::AreAllZero

(

void

)

const

Definition at line 145 of file PathLengthList.cxx.

{
  bool allzero = true;
 
  PathLengthList::const_iterator pl_iter;
 
  for(pl_iter = this->begin(); pl_iter != this->end(); ++pl_iter) {
    double pl = pl_iter->second;
    allzero = allzero && (utils::math::AreEqual(pl,0.));
  }
  return allzero;
}

References genie::utils::math::AreEqual().

Referenced by GetTargetMaterial().

Copy()

void PathLengthList::Copy

(

const PathLengthList &

plist

)

Definition at line 158 of file PathLengthList.cxx.

{
  this->clear();
  PathLengthList::const_iterator pl_iter;
  for(pl_iter = plist.begin(); pl_iter != plist.end(); ++pl_iter) {
    int    pdgc = pl_iter->first;
    double pl   = pl_iter->second;
    this->insert( map<int, double>::value_type(pdgc, pl) );
  }
}

References clear, and PathLengthList().

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

LoadFromXml()

XmlParserStatus_t PathLengthList::LoadFromXml

(

string

filename

)

Definition at line 196 of file PathLengthList.cxx.

{
  this->clear();
  PDGLibrary * pdglib = PDGLibrary::Instance();
 
  LOG("PathL", pINFO)
               << "Loading PathLengthList from XML file: " << filename;
 
  xmlDocPtr xml_doc = xmlParseFile(filename.c_str() );
 
  if(xml_doc==NULL) {
    LOG("PathL", pERROR)
           << "XML file could not be parsed! [filename: " << filename << "]";
    return kXmlNotParsed;
  }
 
  xmlNodePtr xmlCur = xmlDocGetRootElement(xml_doc);
 
  if(xmlCur==NULL) {
    LOG("PathL", pERROR)
        << "XML doc. has null root element! [filename: " << filename << "]";
    return kXmlEmpty;
  }
 
  if( xmlStrcmp(xmlCur->name, (const xmlChar *) "path_length_list") ) {
    LOG("PathL", pERROR)
     << "XML doc. has invalid root element! [filename: " << filename << "]";
    return kXmlInvalidRoot;
  }
 
  LOG("PathL", pINFO) << "XML file was successfully parsed";
 
  xmlCur = xmlCur->xmlChildrenNode; // <path_length>'s
 
  // loop over all xml tree nodes that are children of the root node
  while (xmlCur != NULL) {
 
    // enter everytime you find a <path_length> tag
    if( (!xmlStrcmp(xmlCur->name, (const xmlChar *) "path_length")) ) {
 
       xmlNodePtr xmlPlVal = xmlCur->xmlChildrenNode;
 
       string spdgc = utils::str::TrimSpaces(
                         utils::xml::GetAttribute(xmlCur, "pdgc"));
 
       string spl = utils::xml::TrimSpacesClean(
                           xmlNodeListGetString(xml_doc, xmlPlVal, 1));
 
       LOG("PathL", pDEBUG) << "pdgc = " << spdgc << " --> pl = " << spl;
 
       int    pdgc = atoi( spdgc.c_str() );
       double pl   = atof( spl.c_str()   );
 
       TParticlePDG * p = pdglib->Find(pdgc);
       if(!p) {
         LOG("PathL", pERROR)
            << "No particle with pdgc " << pdgc
                             << " found. Will not load its path length";
       } else
            this->insert( map<int, double>::value_type(pdgc, pl) );
 
       xmlFree(xmlPlVal);
    }
       xmlCur = xmlCur->next;
  } // [end of] loop over tags within root elements
 
  xmlFree(xmlCur);
  return kXmlOK;
}

References clear, genie::PDGLibrary::Find(), genie::utils::xml::GetAttribute(), genie::PDGLibrary::Instance(), genie::kXmlEmpty, genie::kXmlInvalidRoot, genie::kXmlNotParsed, genie::kXmlOK, LOG, pDEBUG, pERROR, pINFO, genie::utils::str::TrimSpaces(), and genie::utils::xml::TrimSpacesClean().

operator=()

PathLengthList & PathLengthList::operator=

(

const PathLengthList &

list

)

Definition at line 309 of file PathLengthList.cxx.

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

References Copy(), and PathLengthList().

PathLength()

double PathLengthList::PathLength

(

int

pdgc

)

const

Definition at line 121 of file PathLengthList.cxx.

{
// Gets the total path length for material with code = pdgc to be pl
 
  if ( this->count(pdgc) == 1 ) {
     map<int, double>::const_iterator pl_iter = this->find(pdgc);
     return pl_iter->second;
  } else {
     LOG("PathL", pWARN)
         << "No material with PDG code = " << pdgc << " in path length list";
  }
  return 0;
}

References LOG, and pWARN.

Referenced by GetTargetMaterial().

Print()

void PathLengthList::Print

(

ostream &

stream

)

const

Definition at line 169 of file PathLengthList.cxx.

{
  stream << "\n[-]" << endl;
 
  PDGLibrary * pdglib = PDGLibrary::Instance();
 
  PathLengthList::const_iterator pl_iter;
  size_t nc = this->size();
 
  for(pl_iter = this->begin(); pl_iter != this->end(); ++pl_iter) {
 
    int    pdgc = pl_iter->first;
    double pl   = pl_iter->second; // path length
 
    TParticlePDG * p = pdglib->Find(pdgc);
 
    if(!p) {
      stream << " |---o ** ERR: no particle with PDG code: " << pdgc;
    } else {
      string name = p->GetName();
      stream << " |---o code: " << pdgc << " [" << setfill(' ')
         << setw(5) << name << "] " << "-----> path-length = " << pl;
    }
    if( (--nc) > 0) stream << endl;
  }
}

References genie::PDGLibrary::Find(), and genie::PDGLibrary::Instance().

Referenced by operator<<.

SaveAsXml()

void PathLengthList::SaveAsXml

(

string

filename

)

const

Save path length list to XML file

Definition at line 266 of file PathLengthList.cxx.

{
//! Save path length list to XML file
 
  LOG("PathL", pINFO)
          << "Saving PathLengthList as XML in file: " << filename;
 
  PDGLibrary * pdglib = PDGLibrary::Instance();
 
  ofstream outxml(filename.c_str());
  if(!outxml.is_open()) {
    LOG("PathL", pERROR) << "Couldn't create file = " << filename;
    return;
  }
  outxml << "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>";
  outxml << endl << endl;
  outxml << "<!-- generated by PathLengthList::SaveAsXml() -->";
  outxml << endl << endl;
 
  outxml << "<path_length_list>" << endl << endl;
 
  PathLengthList::const_iterator pl_iter;
 
  for(pl_iter = this->begin(); pl_iter != this->end(); ++pl_iter) {
 
    int    pdgc = pl_iter->first;
    double pl   = pl_iter->second; // path length
 
    TParticlePDG * p = pdglib->Find(pdgc);
 
    outxml << "   <path_length pdgc=\"" << pdgc << "\"> "
           << setfill(' ') << setw(10) << pl << " </path_length>";
    if ( p ) outxml << " <!-- [" << setfill(' ')
                    << setw(5) << p->GetName() << "] -->";
    outxml << endl;
  }
  outxml << endl << "</path_length_list>";
  outxml << endl;
 
  outxml.close();
 
}

References genie::PDGLibrary::Find(), genie::PDGLibrary::Instance(), LOG, pERROR, and pINFO.

Referenced by main().

ScalePathLength()

void PathLengthList::ScalePathLength	(	int	pdgc,
		double	scale )

Definition at line 107 of file PathLengthList.cxx.

{
// Scales pl for material with code = pdgc with the input scale factor
 
  if (this->count(pdgc) == 1) {
     double pl = (*this)[pdgc];
     pl *= scale;
     (*this)[pdgc] = pl;
  } else {
     LOG("PathL", pWARN)
         << "No material with PDG code = " << pdgc << " in path length list";
  }
}

References LOG, and pWARN.

Referenced by genie::geometry::ROOTGeomAnalyzer::Local2SI().

SetAllToZero()

void PathLengthList::SetAllToZero

(

void

)

Definition at line 135 of file PathLengthList.cxx.

{
  PathLengthList::const_iterator pl_iter;
 
  for(pl_iter = this->begin(); pl_iter != this->end(); ++pl_iter) {
    int pdgc = pl_iter->first;
    (*this)[pdgc] = 0.;
  }
}

SetPathLength()

void PathLengthList::SetPathLength	(	int	pdgc,
		double	pl )

Definition at line 96 of file PathLengthList.cxx.

{
// Sets the total path length for material with code = pdgc to be pl
 
  if (this->count(pdgc) == 1) { (*this)[pdgc] = pl; }
  else {
     LOG("PathL", pWARN)
         << "No material with PDG code = " << pdgc << " in path length list";
  }
}

References LOG, and pWARN.

Friends And Related Symbol Documentation

operator<<

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

friend

Definition at line 38 of file PathLengthList.cxx.

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

References PathLengthList(), and Print().

---

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

• PathLengthList.h
• PathLengthList.cxx