include/Geant4/G4DataSet.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 //
0028 // Author: Maria Grazia Pia (Maria.Grazia.Pia@cern.ch)
0029 //
0030 // History:
0031 // -----------
0032 // 31 Jul 2001   MGP        Created as G4EMDataSet
0033 // 31 Jul 2008   MGP        Revised and renamed to G4DataSet
0034 //
0035 // -------------------------------------------------------------------
0036
0037 // Class description:
0038 // Leaf data set
0039 // Applies a Composite design pattern for data library management
0040
0041 // -------------------------------------------------------------------
0042
0043 #ifndef  G4DATASET_HH
0044 #define  G4DATASET_HH 1
0045
0046 #include <CLHEP/Units/SystemOfUnits.h>
0047
0048 #include "globals.hh"
0049 #include "G4IDataSet.hh"
0050
0051 class G4IInterpolator;
0052
0053 class G4DataSet : public G4IDataSet
0054 {
0055 public:
0056   G4DataSet(G4int argZ,
0057         G4IInterpolator* algo,
0058         G4double xUnit=CLHEP::MeV,
0059         G4double yUnit=CLHEP::barn,
0060         G4bool random=false);
0061
0062   G4DataSet(G4int argZ,
0063         G4DataVector* xData,
0064         G4DataVector* data,
0065         G4IInterpolator* algo,
0066         G4double xUnit=CLHEP::MeV,
0067         G4double yUnit=CLHEP::barn,
0068         G4bool random=false);
0069
0070   virtual ~G4DataSet();
0071
0072   virtual G4double FindValue(G4double x, G4int componentId=0) const;
0073
0074   virtual void PrintData(void) const;
0075
0076   virtual const G4IDataSet* GetComponent(G4int /* componentId */) const { return 0; }
0077
0078   virtual void AddComponent(G4IDataSet* /* dataSet */) {}
0079
0080   virtual size_t NumberOfComponents(void) const { return 0; }
0081
0082   virtual const G4DataVector& GetEnergies(G4int /* componentId */) const { return *energies; }
0083   virtual const G4DataVector& GetData(G4int /* componentId */) const { return *data; }
0084   virtual void SetEnergiesData(G4DataVector* xData, G4DataVector* data, G4int componentId);
0085
0086   virtual G4bool LoadData(const G4String& fileName);
0087   virtual G4bool SaveData(const G4String& fileName) const;
0088
0089   virtual G4double RandomSelect(G4int componentId = 0) const;
0090
0091
0092 private:
0093
0094   size_t FindLowerBound(G4double energy) const;
0095   size_t FindLowerBound(G4double x, G4DataVector* values) const;
0096
0097   G4double IntegrationFunction(G4double x);
0098
0099   virtual void BuildPdf();
0100
0101   G4String FullFileName(const G4String& fileName) const;
0102
0103   // Hide copy constructor and assignment operator
0104   G4DataSet();
0105   G4DataSet(const G4DataSet& copy);
0106   G4DataSet& operator=(const G4DataSet& right);
0107
0108   G4int z;
0109
0110   G4DataVector* energies;            // Owned pointer
0111   G4DataVector* data;                // Owned pointer
0112
0113   G4IInterpolator* algorithm;    // Owned pointer
0114
0115   G4double unitEnergies;
0116   G4double unitData;
0117
0118   G4DataVector* pdf;
0119   G4bool randomSet;
0120 };
0121 #endif /* G4DATASET_HH */