G4EMDataSet Class Reference

#include <G4EMDataSet.hh>

Inheritance 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

---

Detailed Description

Definition at line 58 of file G4EMDataSet.hh.

---

Constructor & Destructor Documentation

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.

References FatalException, G4EMDataSet(), and G4Exception().

Referenced by G4EMDataSet().

                                       : 
  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(); }
}

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.

References FatalException, G4EMDataSet(), and G4Exception().

                                       :
  z(argZ),
  energies(dataX),
  data(dataY),
  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 ((energies == 0) ^ (data == 0)) {
    G4Exception("G4EMDataSet::G4EMDataSet",
                    "em1012",FatalException,"different size for energies and data (zero case)");
  } else if (energies->size() != data->size()) { 
    G4Exception("G4EMDataSet::G4EMDataSet",
                    "em1012",FatalException,"different size for energies and data");
  } else if (randomSet) {
    BuildPdf();
  }
}

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 116 of file G4EMDataSet.cc.

References FatalException, G4EMDataSet(), and G4Exception().

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

G4EMDataSet::~G4EMDataSet

(

)

[virtual]

Definition at line 157 of file G4EMDataSet.cc.

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

---

Member Function Documentation

virtual void G4EMDataSet::AddComponent

(

G4VEMDataSet *

)

[inline, virtual]

Implements G4VEMDataSet.

Definition at line 93 of file G4EMDataSet.hh.

{}

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

Implements G4VEMDataSet.

Definition at line 168 of file G4EMDataSet.cc.

References G4VDataSetAlgorithm::Calculate(), FatalException, and G4Exception().

{
  if (!energies) {
   G4Exception("G4EMDataSet::FindValue",
                    "em1012",FatalException,"energies == 0");
    return 0.0;
  } else if (energies->empty()) {
    return 0.0;
  } else 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);
}

virtual const G4VEMDataSet* G4EMDataSet::GetComponent

(

G4int

)

const [inline, virtual]

Implements G4VEMDataSet.

Definition at line 91 of file G4EMDataSet.hh.

{ return 0; }

virtual const G4DataVector& G4EMDataSet::GetData

(

G4int

)

const [inline, virtual]

Implements G4VEMDataSet.

Definition at line 98 of file G4EMDataSet.hh.

{ return *data; }

virtual const G4DataVector& G4EMDataSet::GetEnergies

(

G4int

)

const [inline, virtual]

Implements G4VEMDataSet.

Definition at line 97 of file G4EMDataSet.hh.

{ return *energies; }

virtual const G4DataVector& G4EMDataSet::GetLogData

(

G4int

)

const [inline, virtual]

Implements G4VEMDataSet.

Definition at line 100 of file G4EMDataSet.hh.

{ return *log_data; }

virtual const G4DataVector& G4EMDataSet::GetLogEnergies

(

G4int

)

const [inline, virtual]

Implements G4VEMDataSet.

Definition at line 99 of file G4EMDataSet.hh.

{ return *log_energies; }

G4bool G4EMDataSet::LoadData

(

const G4String &

fileName

)

[virtual]

Implements G4VEMDataSet.

Definition at line 292 of file G4EMDataSet.cc.

References FatalException, and G4Exception().

{
 // 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;
}

G4bool G4EMDataSet::LoadNonLogData

(

const G4String &

fileName

)

[virtual]

Implements G4VEMDataSet.

Definition at line 350 of file G4EMDataSet.cc.

References FatalException, G4Exception(), and SetEnergiesData().

{
 // 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;
}

virtual size_t G4EMDataSet::NumberOfComponents

(

void

)

const [inline, virtual]

Implements G4VEMDataSet.

Definition at line 95 of file G4EMDataSet.hh.

{ return 0; }

void G4EMDataSet::PrintData

(

void

)

const [virtual]

Implements G4VEMDataSet.

Definition at line 193 of file G4EMDataSet.cc.

References G4cout, and G4endl.

{
  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; 
        }
    }
}

G4double G4EMDataSet::RandomSelect

(

G4int

componentId = 0

)

const [virtual]

Implements G4VEMDataSet.

Definition at line 555 of file G4EMDataSet.cc.

References G4VDataSetAlgorithm::Calculate(), G4LinInterpolation::Calculate(), FatalException, G4Exception(), and G4UniformRand.

{
  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;
}

G4bool G4EMDataSet::SaveData

(

const G4String &

fileName

)

const [virtual]

Implements G4VEMDataSet.

Definition at line 404 of file G4EMDataSet.cc.

References FatalException, and G4Exception().

{
  // 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;
}

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

Implements G4VEMDataSet.

Definition at line 213 of file G4EMDataSet.cc.

References FatalException, and G4Exception().

Referenced by LoadNonLogData().

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

  if (data) { delete data; }
  data = dataY;
 
  if ((energies == 0) ^ (data==0)) {
    G4Exception("G4EMDataSet::SetEnergiesData",
                    "em1012",FatalException,"different size for energies and data (zero case)");
    return;
  } else if (energies == 0) { return; }

  //G4cout << "Size of energies: " << energies->size() << G4endl << "Size of data: " << data->size() << G4endl;
  if (energies->size() != data->size()) { 
   G4Exception("G4EMDataSet::SetEnergiesData",
                    "em1012",FatalException,"different size for energies and data");
  }
}

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

Implements G4VEMDataSet.

Definition at line 236 of file G4EMDataSet.cc.

References FatalException, and G4Exception().

{
  //Load of the actual energy and data values  
  if (energies) { delete energies; }
  energies = dataX;
  if (data) { delete data; }
  data = dataY;
  //Load of the logarithmic energy and data values
  if (log_energies) { delete log_energies; }
  log_energies = data_logX;
  if (log_data) { delete log_data; }
  log_data = data_logY;

  //Check if data loaded properly from data files
  if ( !energies ) {
    if(data || log_energies || log_data ) { 
      G4Exception("G4EMDataSet::SetLogEnergiesData",
                    "em1012",FatalException,"inconsistent data");
    }
    return;
  } else {
    if ( !data ) {
      G4Exception("G4EMDataSet::SetLogEnergiesData",
                    "em1012",FatalException,"only energy, no data");
      return; 
    } else if (energies->size() != data->size()) { 
      G4Exception("G4EMDataSet::SetLogEnergiesData",
                    "em1012",FatalException,"different size for energies and data");
      return;
    }
    //G4cout << "Size of energies: " << energies->size() << G4endl << "Size of data: " << data->size() << G4endl << G4endl;

    //Check if logarithmic data loaded properly from data files 
    if ( !log_energies ) {
      if(log_data) {
        G4Exception("G4EMDataSet::SetLogEnergiesData",
                    "em1012",FatalException,"inconsistence of log_data");
      }
      return;
    } else {
      if ( !log_data ) { 
        G4Exception("G4EMDataSet::SetLogEnergiesData",
                    "em1012",FatalException,"only log_energies, no data");
      } else if ((log_energies->size() != log_data->size()) || (log_energies->size() != data->size())) { 
        G4Exception("G4EMDataSet::SetLogEnergiesData",
                    "em1012",FatalException,"different size for log energies and data");
      }
    }
  }
  //G4cout << "Size of log energies: " << log_energies->size() << G4endl << "Size of log data: " << log_data->size() << G4endl;  
}

---

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

• G4EMDataSet.hh
• G4EMDataSet.cc

---