First commit

kk17m · Jun 25, 2024 · d7f347d · d7f347d
1 parent 078d208
commit d7f347d
Show file tree

Hide file tree

Showing 12 changed files with 243 additions and 26 deletions.
diff --git a/SDD.in b/SDD.in
@@ -54,4 +54,4 @@
 
 /run/printProgress 1000000
 
-#/run/beamOn  50000000
+/run/beamOn  50000000
diff --git a/include/SDDActionInitialization.hh b/include/SDDActionInitialization.hh
@@ -23,6 +23,18 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
 //
 /// \file SDDActionInitialization.hh
 /// \brief Definition of the SDDActionInitialization class
@@ -32,8 +44,6 @@
 
 #include "G4VUserActionInitialization.hh"
 
-/// Action initialization class.
-
 class SDDActionInitialization : public G4VUserActionInitialization
 {
   public:

diff --git a/include/SDDDetectorConstruction.hh b/include/SDDDetectorConstruction.hh
@@ -23,6 +23,18 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
 //
 /// \file SDDDetectorConstruction.hh
 /// \brief Definition of the SDDDetectorConstruction class

diff --git a/include/SDDDetectorHit.hh b/include/SDDDetectorHit.hh
@@ -1,5 +1,48 @@
-#ifndef DetectorHit_HH
-#define DetectorHit_HH
+//
+// ********************************************************************
+// * License and Disclaimer                                           *
+// *                                                                  *
+// * The  Geant4 software  is  copyright of the Copyright Holders  of *
+// * the Geant4 Collaboration.  It is provided  under  the terms  and *
+// * conditions of the Geant4 Software License,  included in the file *
+// * LICENSE and available at  http://cern.ch/geant4/license .  These *
+// * include a list of copyright holders.                             *
+// *                                                                  *
+// * Neither the authors of this software system, nor their employing *
+// * institutes,nor the agencies providing financial support for this *
+// * work  make  any representation or  warranty, express or implied, *
+// * regarding  this  software system or assume any liability for its *
+// * use.  Please see the license in the file  LICENSE  and URL above *
+// * for the full disclaimer and the limitation of liability.         *
+// *                                                                  *
+// * This  code  implementation is the result of  the  scientific and *
+// * technical work of the GEANT4 collaboration.                      *
+// * By using,  copying,  modifying or  distributing the software (or *
+// * any work based  on the software)  you  agree  to acknowledge its *
+// * use  in  resulting  scientific  publications,  and indicate your *
+// * acceptance of all terms of the Geant4 Software license.          *
+// ********************************************************************
+//
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
+//
+/// \file SDDDetectorHit.hh
+/// \brief Definition of the SDDDetectorHit class
+//
+//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
+
+#ifndef SDDDetectorHit_HH
+#define SDDDetectorHit_HH
 
 #include "G4VHit.hh"
 #include "G4THitsCollection.hh"

diff --git a/include/SDDDetectorSD.hh b/include/SDDDetectorSD.hh
@@ -1,5 +1,48 @@
-#ifndef DetectorSD_HH
-#define DetectorSD_HH
+//
+// ********************************************************************
+// * License and Disclaimer                                           *
+// *                                                                  *
+// * The  Geant4 software  is  copyright of the Copyright Holders  of *
+// * the Geant4 Collaboration.  It is provided  under  the terms  and *
+// * conditions of the Geant4 Software License,  included in the file *
+// * LICENSE and available at  http://cern.ch/geant4/license .  These *
+// * include a list of copyright holders.                             *
+// *                                                                  *
+// * Neither the authors of this software system, nor their employing *
+// * institutes,nor the agencies providing financial support for this *
+// * work  make  any representation or  warranty, express or implied, *
+// * regarding  this  software system or assume any liability for its *
+// * use.  Please see the license in the file  LICENSE  and URL above *
+// * for the full disclaimer and the limitation of liability.         *
+// *                                                                  *
+// * This  code  implementation is the result of  the  scientific and *
+// * technical work of the GEANT4 collaboration.                      *
+// * By using,  copying,  modifying or  distributing the software (or *
+// * any work based  on the software)  you  agree  to acknowledge its *
+// * use  in  resulting  scientific  publications,  and indicate your *
+// * acceptance of all terms of the Geant4 Software license.          *
+// ********************************************************************
+//
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
+//
+/// \file SDDDetectorSD.hh
+/// \brief Definition of the SDDDetectorSD class
+//
+//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
+
+#ifndef SDDDetectorSD_HH
+#define SDDDetectorSD_HH
 
 #include "G4VSensitiveDetector.hh"
 #include "SDDDetectorConstruction.hh"

diff --git a/include/SDDEventAction.hh b/include/SDDEventAction.hh
@@ -23,9 +23,23 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
 //
 /// \file SDDEventAction.hh
 /// \brief Definition of the SDDEventAction class
+//
+//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
 #ifndef SDDEventAction_h
 #define SDDEventAction_h 1

diff --git a/include/SDDHistoManager.hh b/include/SDDHistoManager.hh
@@ -23,11 +23,22 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-/// \file HistoManager.hh
-/// \brief Definition of the HistoManager class
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
+//
+/// \file SDDHistoManager.hh
+/// \brief Definition of the SDDHistoManager class
 //
-// 
-//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo...... 
 
 #ifndef HistoManager_h

diff --git a/include/SDDPhysicsList.hh b/include/SDDPhysicsList.hh
@@ -23,12 +23,22 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-/// \file electromagnetic/TestEm5/include/PhysicsList.hh
-/// \brief Definition of the PhysicsList class
+// GEANT4 tag $Name: SDD-01-00
 //
-// $Id: PhysicsList.hh 82340 2014-06-16 14:13:44Z gcosmo $
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
+//
+/// \file SDDPhysicsList.hh
+/// \brief Definition of the SDDPhysicsList class
 //
-//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
 #ifndef PhysicsList_h

diff --git a/include/SDDPrimaryGeneratorAction.hh b/include/SDDPrimaryGeneratorAction.hh
@@ -23,9 +23,23 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
 //
 /// \file SDDPrimaryGeneratorAction.hh
 /// \brief Definition of the SDDPrimaryGeneratorAction class
+//
+//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
 #ifndef SDDPrimaryGeneratorAction_h
 #define SDDPrimaryGeneratorAction_h 1

diff --git a/include/SDDRun.hh b/include/SDDRun.hh
@@ -23,15 +23,26 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-/// \file Run.hh
-/// \brief Definition of the Run class
+// GEANT4 tag $Name: SDD-01-00
 //
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
+//
+/// \file SDDRun.hh
+/// \brief Definition of the SDDRun class
 //
-//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
-#ifndef Run_h
-#define Run_h 1
+#ifndef SDDRun_h
+#define SDDRun_h 1
 
 #include "G4Run.hh"
 #include "G4VProcess.hh"

diff --git a/include/SDDRunAction.hh b/include/SDDRunAction.hh
@@ -23,6 +23,18 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
 //
 /// \file SDDRunAction.hh
 /// \brief Definition of the SDDRunAction class
@@ -40,12 +52,6 @@ class SDDRun;
 class G4Timer;
 class SDDHistoManager;
 
-/// Run action class
-///
-/// In EndOfRunAction(), it calculates the dose in the selected volume 
-/// from the energy deposit accumulated via stepping and event actions.
-/// The computed dose is then printed on the screen.
-
 class SDDRunAction : public G4UserRunAction
 {
   public:

diff --git a/include/SDDdigitize.hh b/include/SDDdigitize.hh
@@ -1,3 +1,46 @@
+//
+// ********************************************************************
+// * License and Disclaimer                                           *
+// *                                                                  *
+// * The  Geant4 software  is  copyright of the Copyright Holders  of *
+// * the Geant4 Collaboration.  It is provided  under  the terms  and *
+// * conditions of the Geant4 Software License,  included in the file *
+// * LICENSE and available at  http://cern.ch/geant4/license .  These *
+// * include a list of copyright holders.                             *
+// *                                                                  *
+// * Neither the authors of this software system, nor their employing *
+// * institutes,nor the agencies providing financial support for this *
+// * work  make  any representation or  warranty, express or implied, *
+// * regarding  this  software system or assume any liability for its *
+// * use.  Please see the license in the file  LICENSE  and URL above *
+// * for the full disclaimer and the limitation of liability.         *
+// *                                                                  *
+// * This  code  implementation is the result of  the  scientific and *
+// * technical work of the GEANT4 collaboration.                      *
+// * By using,  copying,  modifying or  distributing the software (or *
+// * any work based  on the software)  you  agree  to acknowledge its *
+// * use  in  resulting  scientific  publications,  and indicate your *
+// * acceptance of all terms of the Geant4 Software license.          *
+// ********************************************************************
+//
+// GEANT4 tag $Name: SDD-01-00
+//
+// Author: Kunal Kumar (kunal.kumar@ovgu.de)
+//
+// Citation: Kumar K, Fachet M, Hoeschen C. High-Spatial-Resolution Benchtop X-ray Fluorescence Imaging through Bragg-Diffraction-Based Focusing with Bent Mosaic Graphite Crystals: A Simulation Study. Int J Mol Sci. 2024 Apr 26;25(9):4733. doi: 10.3390/ijms25094733. PMID: 38731956; PMCID: PMC11083219.
+//
+// DOI: 10.3390/ijms25094733; PMID: 38731956; PMCID: PMC11083219
+//
+// History:
+// -----------
+// 15 Nov 2023 - Kunal Kumar:     Created. Built using B1 base example
+// -------------------------------------------------------------------
+//
+/// \file SDDdigitize.hh
+/// \brief Definition of the SDDdigitize class
+//
+//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
+
 #ifndef SDDdigitize_HH
 #define SDDdigitize_HH