G4DataSet Class Reference

#include <G4DataSet.hh>

Inheritance diagram for G4DataSet:

Collaboration diagram for G4DataSet:

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

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
	G4DataSet ()
	G4DataSet (const G4DataSet &copy)
G4DataSet &	operator= (const G4DataSet &right)

Private Attributes
G4int	z
G4DataVector *	energies
G4DataVector *	data
G4IInterpolator *	algorithm
G4double	unitEnergies
G4double	unitData
G4DataVector *	pdf
G4bool	randomSet

Detailed Description

Definition at line 54 of file G4DataSet.hh.

Constructor & Destructor Documentation

G4DataSet() [1/4]

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

Definition at line 47 of file G4DataSet.cc.

                           : 
  z(Z),
  energies(0),
  data(0),
  algorithm(algo),
  unitEnergies(xUnit),
  unitData(yUnit),
  pdf(0),
  randomSet(random)
{
  if (algorithm == 0) G4Exception("G4DataSet::G4DataSet",
                  "pii00000101",
                  FatalException,
                  "Interpolation == 0");
  if (randomSet) BuildPdf();
}

Here is the call graph for this function:

G4DataSet() [2/4]

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

Definition at line 68 of file G4DataSet.cc.

                           :
  z(argZ),
  energies(dataX),
  data(dataY),
  algorithm(algo),
  unitEnergies(xUnit),
  unitData(yUnit),
  pdf(0),
  randomSet(random)
{
  if (algorithm == 0) G4Exception("G4DataSet::G4DataSet",
                  "pii00000110",
                  FatalException,
                  "Interpolation == 0");

  if ((energies == 0) ^ (data == 0))
    G4Exception("G4DataSet::G4DataSet",
        "pii00000111-",
        FatalException,  
        "different size for energies and data (zero case)");

  if (energies == 0) return;
  
  if (energies->size() != data->size()) 
    G4Exception("G4DataSet::G4DataSet",
        "pii00000112",
        FatalException, 
        "different size for energies and data");

  if (randomSet) BuildPdf();
}

Here is the call graph for this function:

~G4DataSet()

G4DataSet::~G4DataSet ( )

virtual

Definition at line 106 of file G4DataSet.cc.

{ 
  delete algorithm;
  if (energies) delete energies;
  if (data) delete data;
  if (pdf) delete pdf;
}

G4DataSet() [3/4]

G4DataSet::G4DataSet ( )

private

Here is the caller graph for this function:

G4DataSet() [4/4]

G4DataSet::G4DataSet ( const G4DataSet &  copy )

private

Member Function Documentation

AddComponent()

virtual void G4DataSet::AddComponent ( G4IDataSet *  )

inlinevirtual

Implements G4IDataSet.

Definition at line 79 of file G4DataSet.hh.

{}

BuildPdf()

void G4DataSet::BuildPdf ( )

privatevirtual

Definition at line 353 of file G4DataSet.cc.

{
  pdf = new G4DataVector;
  G4Integrator <G4DataSet, G4double(G4DataSet::*)(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, &G4DataSet::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 G4DataSet::FindLowerBound ( G4double  energy ) const

private

Definition at line 303 of file G4DataSet.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 G4DataSet::FindLowerBound ( G4double  x, G4DataVector *  values  ) const

private

Definition at line 320 of file G4DataSet.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 G4DataSet::FindValue ( G4double  x, G4int  componentId = 0  ) const

virtual

Implements G4IDataSet.

Definition at line 114 of file G4DataSet.cc.

{
  if (!energies) G4Exception("G4DataSet::FindValue",
                 "pii00000120",
                 FatalException,  
                 "energies == 0");
  if (energies->empty()) return 0;
  if (energy <= (*energies)[0]) return (*data)[0];

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

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

Here is the call graph for this function:

FullFileName()

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

private

Definition at line 337 of file G4DataSet.cc.

{
  char* path = getenv("G4PIIDATA");
  if (!path)
    G4Exception("G4DataSet::FullFileName",
        "pii00000160",
          FatalException,
        "G4PIIDATA environment variable not set");
  
  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 G4IDataSet* G4DataSet::GetComponent ( G4int  ) const

inlinevirtual

Implements G4IDataSet.

Definition at line 77 of file G4DataSet.hh.

{ return 0; }

GetData()

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

inlinevirtual

Implements G4IDataSet.

Definition at line 84 of file G4DataSet.hh.

{ return *data; }

Here is the call graph for this function:

GetEnergies()

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

inlinevirtual

Implements G4IDataSet.

Definition at line 83 of file G4DataSet.hh.

{ return *energies; }

IntegrationFunction()

G4double G4DataSet::IntegrationFunction ( G4double  x )

private

Definition at line 411 of file G4DataSet.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 G4DataSet::LoadData ( const G4String &  fileName )

virtual

Implements G4IDataSet.

Definition at line 176 of file G4DataSet.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(fileName));
  std::ifstream in(fullFileName);

  if (!in.is_open())
    {

      std::ostringstream message;
      message << "G4DataSet::LoadData - data file " << fullFileName << " not found";

      G4Exception("G4CompositeDataSet::LoadData",
          "pii00000140",
          FatalException,
          message.str().c_str());
    }

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

  G4double a;
  bool energyColumn(true);

  do
    {
      in >> a;
  
      if (a!=-1 && a!=-2)
    {
      if (energyColumn)
        {
          // std::cout << fullFileName << ", a = " << a <<std::endl;
          argEnergies->push_back(a*unitEnergies);
        }
      else
        argData->push_back(a*unitData);
      energyColumn=(!energyColumn);
    }
    }
  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 G4DataSet::NumberOfComponents ( void  ) const

inlinevirtual

Implements G4IDataSet.

Definition at line 81 of file G4DataSet.hh.

{ return 0; }

operator=()

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

private

Here is the caller graph for this function:

PrintData()

void G4DataSet::PrintData ( void  ) const

virtual

Implements G4IDataSet.

Definition at line 131 of file G4DataSet.cc.

{
  if (!energies)
    {
      G4cout << "Data not available." << G4endl;
    }
  else
    {
      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 G4DataSet::RandomSelect ( G4int  componentId = 0 ) const

virtual

Implements G4IDataSet.

Definition at line 383 of file G4DataSet.cc.

{
  // Random select a X value according to the cumulative probability distribution
  // derived from the data

  if (!pdf) G4Exception("G4DataSet::RandomSelect",
            "pii00000170",
            FatalException, 
            "PDF has not been created for this data set");

  G4double value = 0.;
  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 G4DataSet::SaveData ( const G4String &  fileName ) const

virtual

Implements G4IDataSet.

Definition at line 229 of file G4DataSet.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())
    {
 
      std::ostringstream message;
      message << "G4DataSet:: SaveData - cannot open " << fullFileName;

      G4Exception("G4CompositeDataSet::SaveData",
          "pii00000150",
          FatalException,
          message.str().c_str());

    }
 
  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 G4DataSet::SetEnergiesData ( G4DataVector *  xData, G4DataVector *  data, G4int  componentId  )

virtual

Implements G4IDataSet.

Definition at line 151 of file G4DataSet.cc.

{
  if (energies) delete energies;
  energies = dataX;

  if (data) delete data;
  data = dataY;
 
  if ((energies == 0) ^ (data==0)) 
    G4Exception("G4DataSet::SetEnergiesData",
        "pii00000130",
        FatalException, 
        "different size for energies and data (zero case)");

  if (energies == 0) return;
  
  if (energies->size() != data->size()) 
    G4Exception("G4DataSet::SetEnergiesData",
        "pii00000131",
        FatalException, 
        "different size for energies and data");
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

algorithm

G4IInterpolator* G4DataSet::algorithm

private

Definition at line 114 of file G4DataSet.hh.

data

G4DataVector* G4DataSet::data

private

Definition at line 112 of file G4DataSet.hh.

energies

G4DataVector* G4DataSet::energies

private

Definition at line 111 of file G4DataSet.hh.

pdf

G4DataVector* G4DataSet::pdf

private

Definition at line 119 of file G4DataSet.hh.

randomSet

G4bool G4DataSet::randomSet

private

Definition at line 120 of file G4DataSet.hh.

unitData

G4double G4DataSet::unitData

private

Definition at line 117 of file G4DataSet.hh.

unitEnergies

G4double G4DataSet::unitEnergies

private

Definition at line 116 of file G4DataSet.hh.

z

G4int G4DataSet::z

private

Definition at line 109 of file G4DataSet.hh.

---

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

• G4DataSet.hh
• G4DataSet.cc