G4EMDataSet Class Reference

#include <G4EMDataSet.hh>

Inheritance diagram for G4EMDataSet:

Collaboration diagram for G4EMDataSet:

Public Member Functions
	G4EMDataSet (G4int argZ, G4VDataSetAlgorithm *algo, G4double xUnit=CLHEP::MeV, G4double yUnit=CLHEP::barn, G4bool random=false)
	G4EMDataSet (G4int argZ, G4DataVector *xData, G4DataVector *data, G4VDataSetAlgorithm *algo, G4double xUnit=CLHEP::MeV, G4double yUnit=CLHEP::barn, G4bool random=false)
	G4EMDataSet (G4int argZ, G4DataVector *xData, G4DataVector *data, G4DataVector *xLogData, G4DataVector *Logdata, G4VDataSetAlgorithm *algo, G4double xUnit=CLHEP::MeV, G4double yUnit=CLHEP::barn, G4bool random=false)
virtual	~G4EMDataSet ()
virtual G4double	FindValue (G4double x, G4int componentId=0) const
virtual void	PrintData (void) const
virtual const G4VEMDataSet *	GetComponent (G4int) const
virtual void	AddComponent (G4VEMDataSet *)
virtual size_t	NumberOfComponents (void) const
virtual const G4DataVector &	GetEnergies (G4int) const
virtual const G4DataVector &	GetData (G4int) const
virtual const G4DataVector &	GetLogEnergies (G4int) const
virtual const G4DataVector &	GetLogData (G4int) const
virtual void	SetEnergiesData (G4DataVector *xData, G4DataVector *data, G4int componentId)
virtual void	SetLogEnergiesData (G4DataVector *xData, G4DataVector *data, G4DataVector *xLogData, G4DataVector *Logdata, G4int componentId)
virtual G4bool	LoadData (const G4String &fileName)
virtual G4bool	LoadNonLogData (const G4String &fileName)
virtual G4bool	SaveData (const G4String &fileName) const
virtual G4double	RandomSelect (G4int componentId=0) const
Public Member Functions inherited from G4VEMDataSet
	G4VEMDataSet ()
virtual	~G4VEMDataSet ()

Private Member Functions
size_t	FindLowerBound (G4double energy) const
size_t	FindLowerBound (G4double x, G4DataVector *values) const
G4double	IntegrationFunction (G4double x)
virtual void	BuildPdf ()
G4String	FullFileName (const G4String &fileName) const
	G4EMDataSet ()
	G4EMDataSet (const G4EMDataSet &copy)
G4EMDataSet &	operator= (const G4EMDataSet &right)

Private Attributes
G4int	z
G4DataVector *	energies
G4DataVector *	data
G4DataVector *	log_energies
G4DataVector *	log_data
G4VDataSetAlgorithm *	algorithm
G4double	unitEnergies
G4double	unitData
G4DataVector *	pdf
G4bool	randomSet

Detailed Description

Definition at line 58 of file G4EMDataSet.hh.

Constructor & Destructor Documentation

G4EMDataSet() [1/5]

G4EMDataSet::G4EMDataSet	(	G4int	argZ,
		G4VDataSetAlgorithm *	algo,
		G4double	xUnit = CLHEP::MeV,
		G4double	yUnit = CLHEP::barn,
		G4bool	random = false
	)

Definition at line 62 of file G4EMDataSet.cc.

                           : 
  z(Z),
  energies(0),
  data(0),
  log_energies(0),
  log_data(0),
  algorithm(algo),
  unitEnergies(xUnit),
  unitData(yUnit),
  pdf(0),
  randomSet(random)
{
  if (algorithm == 0) {
    G4Exception("G4EMDataSet::G4EMDataSet",
            "em1012",FatalException,"interpolation == 0");
  } else if (randomSet) { BuildPdf(); }
}

Here is the call graph for this function:

G4EMDataSet() [2/5]

G4EMDataSet::G4EMDataSet	(	G4int	argZ,
		G4DataVector *	xData,
		G4DataVector *	data,
		G4VDataSetAlgorithm *	algo,
		G4double	xUnit = CLHEP::MeV,
		G4double	yUnit = CLHEP::barn,
		G4bool	random = false
	)

Definition at line 84 of file G4EMDataSet.cc.

                           :
  z(argZ),
  energies(dataX),
  data(dataY),
  log_energies(0),
  log_data(0),
  algorithm(algo),
  unitEnergies(xUnit),
  unitData(yUnit),
  pdf(0),
  randomSet(random)
{
  if (!algorithm || !energies || !data) {
    G4Exception("G4EMDataSet::G4EMDataSet",
            "em1012",FatalException,"interpolation == 0");
  } else {
    if (energies->size() != data->size()) { 
      G4Exception("G4EMDataSet::G4EMDataSet",
          "em1012",FatalException,"different size for energies and data");
    } else if (randomSet) {
      BuildPdf();
    }
  }
}

Here is the call graph for this function:

G4EMDataSet() [3/5]

G4EMDataSet::G4EMDataSet	(	G4int	argZ,
		G4DataVector *	xData,
		G4DataVector *	data,
		G4DataVector *	xLogData,
		G4DataVector *	Logdata,
		G4VDataSetAlgorithm *	algo,
		G4double	xUnit = CLHEP::MeV,
		G4double	yUnit = CLHEP::barn,
		G4bool	random = false
	)

Definition at line 115 of file G4EMDataSet.cc.

                           :
  z(argZ),
  energies(dataX),
  data(dataY),
  log_energies(dataLogX),
  log_data(dataLogY),
  algorithm(algo),
  unitEnergies(xUnit),
  unitData(yUnit),
  pdf(0),
  randomSet(random)
{
  if (!algorithm || !energies || !data || !log_energies || !log_data) {
    G4Exception("G4EMDataSet::G4EMDataSet",
            "em1012",FatalException,"interpolation == 0");
  } else {
    if ((energies->size() != data->size()) ||
    (energies->size() != log_energies->size()) ||
    (energies->size() != log_data->size())) { 
      G4Exception("G4EMDataSet::G4EMDataSet",
          "em1012",FatalException,"different size for energies and data");
    } else if (randomSet) {
      BuildPdf();
    }
  }
}

Here is the call graph for this function:

~G4EMDataSet()

G4EMDataSet::~G4EMDataSet ( )

virtual

Definition at line 150 of file G4EMDataSet.cc.

{ 
  delete algorithm;
  delete energies; 
  delete data; 
  delete pdf; 
  delete log_energies; 
  delete log_data; 
}

G4EMDataSet() [4/5]

G4EMDataSet::G4EMDataSet ( )

private

Here is the caller graph for this function:

G4EMDataSet() [5/5]

G4EMDataSet::G4EMDataSet ( const G4EMDataSet &  copy )

private

Member Function Documentation

AddComponent()

virtual void G4EMDataSet::AddComponent ( G4VEMDataSet *  )

inlinevirtual

Implements G4VEMDataSet.

Definition at line 93 of file G4EMDataSet.hh.

{}

BuildPdf()

void G4EMDataSet::BuildPdf ( )

privatevirtual

Definition at line 482 of file G4EMDataSet.cc.

{
  pdf = new G4DataVector;
  G4Integrator <G4EMDataSet, G4double(G4EMDataSet::*)(G4double)> integrator;

  G4int nData = data->size();
  pdf->push_back(0.);

  // Integrate the data distribution 
  G4int i;
  G4double totalSum = 0.;
  for (i=1; i<nData; i++)
    {
      G4double xLow = (*energies)[i-1];
      G4double xHigh = (*energies)[i];
      G4double sum = integrator.Legendre96(this, &G4EMDataSet::IntegrationFunction, xLow, xHigh);
      totalSum = totalSum + sum;
      pdf->push_back(totalSum);
    }

  // Normalize to the last bin
  G4double tot = 0.;
  if (totalSum > 0.) tot = 1. / totalSum;
  for (i=1;  i<nData; i++)
    {
      (*pdf)[i] = (*pdf)[i] * tot;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

FindLowerBound() [1/2]

size_t G4EMDataSet::FindLowerBound ( G4double  energy ) const

private

Definition at line 432 of file G4EMDataSet.cc.

{
  size_t lowerBound = 0;
  size_t upperBound(energies->size() - 1);
  
  while (lowerBound <= upperBound) 
    {
      size_t midBin((lowerBound + upperBound) / 2);

      if (x < (*energies)[midBin]) upperBound = midBin - 1;
      else lowerBound = midBin + 1;
    }
  
  return upperBound;
}

Here is the caller graph for this function:

FindLowerBound() [2/2]

size_t G4EMDataSet::FindLowerBound ( G4double  x, G4DataVector *  values  ) const

private

Definition at line 449 of file G4EMDataSet.cc.

{
  size_t lowerBound = 0;;
  size_t upperBound(values->size() - 1);
  
  while (lowerBound <= upperBound) 
    {
      size_t midBin((lowerBound + upperBound) / 2);

      if (x < (*values)[midBin]) upperBound = midBin - 1;
      else lowerBound = midBin + 1;
    }
  
  return upperBound;
}

FindValue()

G4double G4EMDataSet::FindValue ( G4double  x, G4int  componentId = 0  ) const

virtual

Implements G4VEMDataSet.

Definition at line 160 of file G4EMDataSet.cc.

{
  if (energy <= (*energies)[0]) {
    return (*data)[0];
  }
  size_t i = energies->size()-1;
  if (energy >= (*energies)[i]) { return (*data)[i]; }

  //Nicolas A. Karakatsanis: Check if the logarithmic data have been loaded to decide
  //                         which Interpolation-Calculation method will be applied
  if (log_energies != 0) 
   {
     return algorithm->Calculate(energy, FindLowerBound(energy), *energies, *data, *log_energies, *log_data);
   }

  return algorithm->Calculate(energy, FindLowerBound(energy), *energies, *data);
}

Here is the call graph for this function:

FullFileName()

G4String G4EMDataSet::FullFileName ( const G4String &  fileName ) const

private

Definition at line 466 of file G4EMDataSet.cc.

{
  char* path = getenv("G4LEDATA");
  if (!path) {
     G4Exception("G4EMDataSet::FullFileName",
            "em0006",FatalException,"G4LEDATA environment variable not set");
    return "";
  }
  std::ostringstream fullFileName;
  fullFileName << path << '/' << name << z << ".dat";
                      
  return G4String(fullFileName.str().c_str());
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetComponent()

virtual const G4VEMDataSet* G4EMDataSet::GetComponent ( G4int  ) const

inlinevirtual

Implements G4VEMDataSet.

Definition at line 91 of file G4EMDataSet.hh.

{ return 0; }

GetData()

virtual const G4DataVector& G4EMDataSet::GetData ( G4int  ) const

inlinevirtual

Implements G4VEMDataSet.

Definition at line 98 of file G4EMDataSet.hh.

{ return *data; }

GetEnergies()

virtual const G4DataVector& G4EMDataSet::GetEnergies ( G4int  ) const

inlinevirtual

Implements G4VEMDataSet.

Definition at line 97 of file G4EMDataSet.hh.

{ return *energies; }

GetLogData()

virtual const G4DataVector& G4EMDataSet::GetLogData ( G4int  ) const

inlinevirtual

Implements G4VEMDataSet.

Definition at line 100 of file G4EMDataSet.hh.

{ return *log_data; }

Here is the call graph for this function:

GetLogEnergies()

virtual const G4DataVector& G4EMDataSet::GetLogEnergies ( G4int  ) const

inlinevirtual

Implements G4VEMDataSet.

Definition at line 99 of file G4EMDataSet.hh.

{ return *log_energies; }

IntegrationFunction()

G4double G4EMDataSet::IntegrationFunction ( G4double  x )

private

Definition at line 540 of file G4EMDataSet.cc.

{
  // This function is needed by G4Integrator to calculate the integral of the data distribution

  G4double y = 0;

 // Locate the random value in the X vector based on the PDF
  size_t bin = FindLowerBound(x);

  // Interpolate to calculate the X value: 
  // linear interpolation in the first bin (to avoid problem with 0),
  // interpolation with associated algorithm in other bins

  G4LinInterpolation linearAlgo;
  
  if (bin == 0) y = linearAlgo.Calculate(x, bin, *energies, *data);
  else y = algorithm->Calculate(x, bin, *energies, *data);
 
  return y;
}

Here is the call graph for this function:

Here is the caller graph for this function:

LoadData()

G4bool G4EMDataSet::LoadData ( const G4String &  fileName )

virtual

Implements G4VEMDataSet.

Definition at line 248 of file G4EMDataSet.cc.

{
 // The file is organized into four columns:
 // 1st column contains the values of energy
 // 2nd column contains the corresponding data value
 // The file terminates with the pattern: -1   -1
 //                                       -2   -2

  G4String fullFileName(FullFileName(fileName));
  std::ifstream in(fullFileName);

  if (!in.is_open())
    {
      G4String message("data file \"");
      message += fullFileName;
      message += "\" not found";
      G4Exception("G4EMDataSet::LoadData",
            "em1012",FatalException,message);
      return false;
    }

  delete energies;
  delete data;   
  delete log_energies;
  delete log_data;   
  energies = new G4DataVector;
  data = new G4DataVector;
  log_energies = new G4DataVector;
  log_data = new G4DataVector;

  G4double a, b;
  //G4int k = 0;
  //G4int nColumns = 2;

  do
    {
      in >> a >> b;
  
      if (a != -1 && a != -2)
    {
      if (a==0.) { a=1e-300; }
      if (b==0.) { b=1e-300; }
          a *= unitEnergies;
          b *= unitData;
      energies->push_back(a);
      log_energies->push_back(std::log10(a));
      data->push_back(b);
      log_data->push_back(std::log10(b));
    }
    }
  while (a != -2);

  if (randomSet) { BuildPdf(); }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

LoadNonLogData()

G4bool G4EMDataSet::LoadNonLogData ( const G4String &  fileName )

virtual

Implements G4VEMDataSet.

Definition at line 306 of file G4EMDataSet.cc.

{
 // The file is organized into four columns:
 // 1st column contains the values of energy
 // 2nd column contains the corresponding data value
 // The file terminates with the pattern: -1   -1
 //                                       -2   -2

  G4String fullFileName(FullFileName(fileName));
  std::ifstream in(fullFileName);
  if (!in.is_open())
    {
      G4String message("data file \"");
      message += fullFileName;
      message += "\" not found";
      G4Exception("G4EMDataSet::LoadNonLogData",
            "em1012",FatalException,message);
    }

  G4DataVector* argEnergies=new G4DataVector;
  G4DataVector* argData=new G4DataVector;

  G4double a;
  G4int k = 0;
  G4int nColumns = 2;

  do
    {
      in >> a;
  
      if (a != -1 && a != -2)
    {
      if (k%nColumns == 0)
            {
         argEnergies->push_back(a*unitEnergies);
            }
      else if (k%nColumns == 1)
            {
         argData->push_back(a*unitData);
            }
          k++;
    }
    }
  while (a != -2);
 
  SetEnergiesData(argEnergies, argData, 0);

  if (randomSet) BuildPdf();
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

NumberOfComponents()

virtual size_t G4EMDataSet::NumberOfComponents ( void  ) const

inlinevirtual

Implements G4VEMDataSet.

Definition at line 95 of file G4EMDataSet.hh.

{ return 0; }

operator=()

G4EMDataSet& G4EMDataSet::operator= ( const G4EMDataSet &  right )

private

Here is the caller graph for this function:

PrintData()

void G4EMDataSet::PrintData ( void  ) const

virtual

Implements G4VEMDataSet.

Definition at line 178 of file G4EMDataSet.cc.

{
  size_t size = energies->size();
  for (size_t i(0); i<size; i++)
    {
      G4cout << "Point: " << ((*energies)[i]/unitEnergies)
         << " - Data value: " << ((*data)[i]/unitData);
      if (pdf != 0) G4cout << " - PDF : " << (*pdf)[i];
      G4cout << G4endl; 
    }
}

RandomSelect()

G4double G4EMDataSet::RandomSelect ( G4int  componentId = 0 ) const

virtual

Implements G4VEMDataSet.

Definition at line 511 of file G4EMDataSet.cc.

{
  G4double value = 0.;
  // Random select a X value according to the cumulative probability distribution
  // derived from the data

  if (!pdf) {
    G4Exception("G4EMDataSet::RandomSelect",
            "em1012",FatalException,"PDF has not been created for this data set");
    return value;
  }

  G4double x = G4UniformRand();

  // Locate the random value in the X vector based on the PDF
  size_t bin = FindLowerBound(x,pdf);

  // Interpolate the PDF to calculate the X value: 
  // linear interpolation in the first bin (to avoid problem with 0),
  // interpolation with associated data set algorithm in other bins

  G4LinInterpolation linearAlgo;
  if (bin == 0) value = linearAlgo.Calculate(x, bin, *pdf, *energies);
  else value = algorithm->Calculate(x, bin, *pdf, *energies);

  //  G4cout << x << " random bin "<< bin << " - " << value << G4endl;
  return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SaveData()

G4bool G4EMDataSet::SaveData ( const G4String &  fileName ) const

virtual

Implements G4VEMDataSet.

Definition at line 360 of file G4EMDataSet.cc.

{
  // The file is organized into two columns:
  // 1st column is the energy
  // 2nd column is the corresponding value
  // The file terminates with the pattern: -1   -1
  //                                       -2   -2
 
  G4String fullFileName(FullFileName(name));
  std::ofstream out(fullFileName);

  if (!out.is_open())
    {
      G4String message("cannot open \"");
      message+=fullFileName;
      message+="\"";
      G4Exception("G4EMDataSet::SaveData",
            "em1012",FatalException,message);
    }
 
  out.precision(10);
  out.width(15);
  out.setf(std::ofstream::left);
  
  if (energies!=0 && data!=0)
    {
      G4DataVector::const_iterator i(energies->begin());
      G4DataVector::const_iterator endI(energies->end());
      G4DataVector::const_iterator j(data->begin());
  
      while (i!=endI)
    {
      out.precision(10);
      out.width(15);
      out.setf(std::ofstream::left);
      out << ((*i)/unitEnergies) << ' ';

      out.precision(10);
      out.width(15);
      out.setf(std::ofstream::left);
      out << ((*j)/unitData) << std::endl;

      i++;
      j++;
    }
    }
 
  out.precision(10);
  out.width(15);
  out.setf(std::ofstream::left);
  out << -1.f << ' ';

  out.precision(10);
  out.width(15);
  out.setf(std::ofstream::left);
  out << -1.f << std::endl;

  out.precision(10);
  out.width(15);
  out.setf(std::ofstream::left);
  out << -2.f << ' ';

  out.precision(10);
  out.width(15);
  out.setf(std::ofstream::left);
  out << -2.f << std::endl;

  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetEnergiesData()

void G4EMDataSet::SetEnergiesData ( G4DataVector *  xData, G4DataVector *  data, G4int  componentId  )

virtual

Implements G4VEMDataSet.

Definition at line 190 of file G4EMDataSet.cc.

{
  if(!dataX || !dataY) {
    G4Exception("G4EMDataSet::SetEnergiesData",
            "em1012",FatalException,"new interpolation == 0");
  } else {
    if (dataX->size() != dataY->size()) { 
      G4Exception("G4EMDataSet::SetEnergiesData",
          "em1012",FatalException,"different size for energies and data");
    } else {

      delete energies; 
      energies = dataX;

      delete data; 
      data = dataY;
      //G4cout << "Size of energies: " << energies->size() << G4endl 
      //<< "Size of data: " << data->size() << G4endl;
    }
  } 
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetLogEnergiesData()

void G4EMDataSet::SetLogEnergiesData ( G4DataVector *  xData, G4DataVector *  data, G4DataVector *  xLogData, G4DataVector *  Logdata, G4int  componentId  )

virtual

Implements G4VEMDataSet.

Definition at line 214 of file G4EMDataSet.cc.

{
  if(!dataX || !dataY || !data_logX || !data_logY) {
    G4Exception("G4EMDataSet::SetEnergiesData",
            "em1012",FatalException,"new interpolation == 0");
  } else {
    if (dataX->size() != dataY->size() ||
    dataX->size() != data_logX->size() ||
    dataX->size() != data_logY->size()) {
      G4Exception("G4EMDataSet::SetEnergiesData",
          "em1012",FatalException,"different size for energies and data");
    } else {

      delete energies; 
      energies = dataX;

      delete data; 
      data = dataY;

      delete log_energies; 
      log_energies = data_logX;

      delete log_data; 
      log_data = data_logY;
      //G4cout << "Size of energies: " << energies->size() << G4endl 
      //<< "Size of data: " << data->size() << G4endl;
    }
  } 
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

algorithm

G4VDataSetAlgorithm* G4EMDataSet::algorithm

private

Definition at line 141 of file G4EMDataSet.hh.

data

G4DataVector* G4EMDataSet::data

private

Definition at line 137 of file G4EMDataSet.hh.

energies

G4DataVector* G4EMDataSet::energies

private

Definition at line 136 of file G4EMDataSet.hh.

log_data

G4DataVector* G4EMDataSet::log_data

private

Definition at line 139 of file G4EMDataSet.hh.

log_energies

G4DataVector* G4EMDataSet::log_energies

private

Definition at line 138 of file G4EMDataSet.hh.

pdf

G4DataVector* G4EMDataSet::pdf

private

Definition at line 146 of file G4EMDataSet.hh.

randomSet

G4bool G4EMDataSet::randomSet

private

Definition at line 147 of file G4EMDataSet.hh.

unitData

G4double G4EMDataSet::unitData

private

Definition at line 144 of file G4EMDataSet.hh.

unitEnergies

G4double G4EMDataSet::unitEnergies

private

Definition at line 143 of file G4EMDataSet.hh.

z

G4int G4EMDataSet::z

private

Definition at line 134 of file G4EMDataSet.hh.

---

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

• G4EMDataSet.hh
• G4EMDataSet.cc