From 533486f87d9703d40aa02a4b26ff2c6c66f95bce Mon Sep 17 00:00:00 2001
From: Nicolas de Sereville <deserevi@ipno.in2p3.fr>
Date: Tue, 5 Jan 2016 22:23:41 +0100
Subject: [PATCH] + Change documentation directory structure, create README
file and update *.tex files
---
Documentation/detectors/README.md | 4 +++
.../{Cats.tex => detectors/cats.tex} | 13 +++----
.../{CATS_det.png => detectors/cats_fig1.png} | Bin
.../{Gaspard.tex => detectors/gaspard.tex} | 33 +++++++++---------
.../{Paris.tex => detectors/paris.tex} | 32 ++++++++---------
.../paris_fig1.eps} | 0
.../paris_fig2.eps} | 0
.../paris_fig3.eps} | 0
.../paris_fig4.eps} | 0
9 files changed, 43 insertions(+), 39 deletions(-)
create mode 100644 Documentation/detectors/README.md
rename Documentation/{Cats.tex => detectors/cats.tex} (95%)
rename Documentation/{CATS_det.png => detectors/cats_fig1.png} (100%)
rename Documentation/{Gaspard.tex => detectors/gaspard.tex} (92%)
rename Documentation/{Paris.tex => detectors/paris.tex} (92%)
rename Documentation/{Parismodule1.eps => detectors/paris_fig1.eps} (100%)
rename Documentation/{Paris3by3.eps => detectors/paris_fig2.eps} (100%)
rename Documentation/{FullParisNoShield.eps => detectors/paris_fig3.eps} (100%)
rename Documentation/{FullParis.eps => detectors/paris_fig4.eps} (100%)
diff --git a/Documentation/detectors/README.md b/Documentation/detectors/README.md
new file mode 100644
index 000000000..f53550d44
--- /dev/null
+++ b/Documentation/detectors/README.md
@@ -0,0 +1,4 @@
+This directory contains the documentation for individual detectors. Please,
+consider to add documentation if you plan to implement a new detector in
+NPTool. This will make things easier in case somebody else wants to use your
+work.
diff --git a/Documentation/Cats.tex b/Documentation/detectors/cats.tex
similarity index 95%
rename from Documentation/Cats.tex
rename to Documentation/detectors/cats.tex
index 50506cc45..365173156 100644
--- a/Documentation/Cats.tex
+++ b/Documentation/detectors/cats.tex
@@ -15,6 +15,7 @@
}
\maketitle
+\pagebreak
\tableofcontents
\pagebreak
@@ -26,7 +27,7 @@ In the experiment, we have used two CATS\footnote{Chambre \`A Trajectoire de Sac
The maximum count rate for this detector is about $10^5$ particles per second if the beam is not too focused on one part of the detector.
\begin{figure}[h!]
\begin{center}
-\includegraphics[scale=0.35]{CATS_det.png}
+\includegraphics[scale=0.35]{cats_fig1.png}
\caption{\textit{Characteristics of a CATS detector}}
\label{fig:CATS}
\end{center}
@@ -83,21 +84,21 @@ We usually have two detectors in an experiment to reconstruct the position of th
The following command line should be executed:
\begin{verbatim}
- ./Analysis -D yyy.detector -R RunToTreat.txt -C calibration.txt
+ npanalysis -D yyy.detector -R RunToTreat.txt -C calibration.txt
\end{verbatim}
-where yyy.detector is the input file describing the detector geometry used in NPSimulation. All these input files are based on keywords and can be found in the \$NPTool/Inputs subdirectories. The RunToTreat.txt file contains the name of the files (either from NPSimulation or from real experiment) which should be analysed. The name of the tree should also be specified. An example of such a file is given here:
+where yyy.detector is the input file describing the detector geometry used in NPSimulation. All these input files are based on keywords and can be found in the \$NPTOOL/Inputs subdirectories. The RunToTreat.txt file contains the name of the files (either from NPSimulation or from real experiment) which should be analysed. The name of the tree should also be specified. An example of such a file is given here:
\begin{verbatim}
TTreeName
- AutoTree
+ AutoTree
RootFileName
- ../../NPData/cats_mask_e644.root
+ ../../NPData/cats_mask_e644.root
\end{verbatim}
\subsection{Results of the analysis}
-The results of the anaysis are stored in a ROOT file in the \$NPTool/Output/Analysis
+The results of the anaysis are stored in a ROOT file in the \$NPTOOL/Output/Analysis
directory.
The results you should obtain are displayed in the following Figures. Run the
diff --git a/Documentation/CATS_det.png b/Documentation/detectors/cats_fig1.png
similarity index 100%
rename from Documentation/CATS_det.png
rename to Documentation/detectors/cats_fig1.png
diff --git a/Documentation/Gaspard.tex b/Documentation/detectors/gaspard.tex
similarity index 92%
rename from Documentation/Gaspard.tex
rename to Documentation/detectors/gaspard.tex
index 6a51ea965..2c5d79917 100644
--- a/Documentation/Gaspard.tex
+++ b/Documentation/detectors/gaspard.tex
@@ -2,7 +2,7 @@
\usepackage[margin=2cm]{geometry}
\usepackage[T1]{fontenc}
-\usepackage [isolatin]{inputenc}
+%\usepackage [isolatin]{inputenc}
\usepackage{graphicx}
\usepackage{listings}
@@ -20,12 +20,11 @@
\section{Introduction}
The Gaspard project is developed within the NPTool framework which is a
modular package allowing to perform Geant4 simulations and to analyse the
-results of the simulations. It is strongly encouraged to read the general
-NPTool documentation that you can find in this directory.
+results of the simulations.
Concerning the status for Gaspard simulations, the charged particles tracker
is now finished and the coupling with the PARIS gamma-ray calorimeter is
-done. Both the tracker and the calorimeter have different available geomtries.
+done. Both the tracker and the calorimeter have different available geometries.
\section{NPSimulation}
@@ -48,12 +47,12 @@ GaspardTrackerTrapezoid and GaspardTrackerDummyShape classes).
To run NPSimulation the following command line should be executed:
\begin{verbatim}
- Simulation -E xxx.reaction -D yyy.detector
+ npsimulation -E xxx.reaction -D yyy.detector
\end{verbatim}
where xxx.reaction is an input file describing the event generator and
yyy.detector is an input file describing the detector geometry. All these
-input files are based on keywords and can be found in the \$NPTool/Inputs
+input files are based on keywords and can be found in the \$NPTOOL/Inputs
subdirectories.
\subsubsection{Event Generators}
@@ -148,7 +147,7 @@ activated independently using the keywords {\it FIRSTSTAGE},
\subsection{Results of the simulation}
The results of the simulation are in the ROOT format and the output file
-is stored in the \$NPTool/Output/Simulation directory. The output ROOT file
+is stored in the \$NPTOOL/Output/Simulation directory. The output ROOT file
contains three classes:
\begin{itemize}
\item {TInitialConditions:}
@@ -226,32 +225,32 @@ ReadConfiguration()} method.
\section{NPAnalysis}
\subsection{General}
-A set of general ROOT macros are available in the \$NPTool/NPAnalysis/macros
+A set of general ROOT macros are available in the \$NPTOOL/Projects/macros
directory. You can for example obtain some control plots about the shooting
conditions of the random variables. You can also calculate the geometrical
efficiency of your setup.
The macros in this directory should be independant of the setup which is simulated.
Specific macros to Gaspard tracker should be placed in the
-\$NPTool/NPAnalysis/Gaspard/macros directory.
+\$NPTOOL/Projects/Gaspard/macros directory.
\subsection{Gaspard}
-The main analysis tool for the Gaspard tracker is in the \$NPTool/NPAnalysis/Gaspard
+The main analysis tool for the Gaspard tracker is in the \$NPTOOL/Projects/Gaspard
directory. For the moment the main feature is the reconstruction of the excitation
energy.
\subsubsection{Running the analysis}
-To run NPAnalysis the following command line should be executed:
+The following command line should be executed:
\begin{verbatim}
- ./Analysis -E xxx.reaction -D yyy.detector -R RunToTreat.txt
+ npnalysis -E xxx.reaction -D yyy.detector -R RunToTreat.txt
\end{verbatim}
where xxx.reaction is the input file describing the event generator used in
NPSimulation and yyy.detector is the input file describing the detector geometry
used in NPSimulation. All these input files are based on keywords and can be found
-in the \$NPTool/Inputs subdirectories. The RunToTreat.txt file contains the
+in the \$NPTOOL/Inputs subdirectories. The RunToTreat.txt file contains the
name of the files (either from NPSimulation or from real experiment) which should
be analysed. The name of the tree should also be specified. An example
of such a file is given here:
@@ -267,24 +266,24 @@ of such a file is given here:
\subsubsection{Results of the analysis}
-The results of the anaysis are stored in a ROOT file in the \$NPTool/Output/Analysis
+The results of the anaysis are stored in a ROOT file in the \$NPTOOL/Output/Analysis
directory. For the moment the main feature available is the reconstruction of the
excitation energy.
\subsubsection{Structure of the analysis}
The analysis package now deals with Gaspard trackers including different shapes.
-The main analysis program is the \$NPTool/NPAnalysis/Gaspard/src/Analysis.cc
+The main analysis program is the \$NPTOOL/NPAnalysis/Gaspard/src/Analysis.cc
file where the user is in charge to code the specific functionalities he is
interested in. This includes to treat cases with multiplicity greater than one,
calculate the excitation energy, check the effect of beam tracker detector
positioning resolution, ...
-However, all the basic treatments of the analysis are done in \$NPTool/NPLib/GASPARD.
+However, all the basic treatments of the analysis are done in \$NPTOOL/NPLib/Detectors/GASPARD.
These basic treatments calculate the total energy deposited in the telescope and
associate for each pixel number the cartesian coordinates of the pixel middle.
-The structure in \$NPLib/GASPARD is very similar to the NPSimulation structure
+The structure in \$NPLib/Detectors/GASPARD is very similar to the NPSimulation structure
for Gaspard. The GaspardTracker.\{h,cxx\} class derives from the VDetector class
and holds ($i$) the GaspardTrackerData object to be analysed, ($ii$) the
GaspardTrackerPhysics object with the results of the basic treatement and ($iii$)
diff --git a/Documentation/Paris.tex b/Documentation/detectors/paris.tex
similarity index 92%
rename from Documentation/Paris.tex
rename to Documentation/detectors/paris.tex
index 5f902da88..342af26fb 100644
--- a/Documentation/Paris.tex
+++ b/Documentation/detectors/paris.tex
@@ -1,6 +1,6 @@
\documentclass[a4paper,12pt]{article}
\usepackage[T1]{fontenc}
-\usepackage [isolatin]{inputenc}
+%\usepackage [isolatin]{inputenc}
\usepackage{epsfig}
\usepackage{graphicx}
\usepackage{listings}
@@ -11,8 +11,8 @@
\author{Marc Labiche\\ \\
STFC Daresbury Laboratory,\\
marc.labiche@stfc.ac.uk\\ \\}
-
\maketitle
+
\pagebreak
\tableofcontents
\pagebreak
@@ -38,7 +38,7 @@ GASPARD program, thus many details described here are similar to the GASPARD doc
\begin{figure*}[ht]
\begin{center}
-\psfig{figure=Parismodule1.eps,width=10cm,height=5cm,angle=0}
+\psfig{figure=paris_fig1.eps,width=10cm,height=5cm,angle=0}
\end{center}
\caption{Two drawings of a single phoswich module. The LaBr$_{3}$ scintillator is in blue
and the NaI scintillator is in red }
@@ -71,7 +71,7 @@ files ShieldPhParis.\{hh,cc\}.
\begin{figure*}[ht]
\begin{center}
-\psfig{figure=Paris3by3.eps,width=12cm,height=5cm,angle=0}
+\psfig{figure=paris_fig2.eps,width=12cm,height=5cm,angle=0}
\end{center}
\caption{Two drawings of a 3$\times$3 cluster. The LaBr$_{3}$ scintillator is in blue and
the NaI scintillator is in red }
@@ -89,7 +89,7 @@ ShieldPhParis classes).
\begin{figure*}[ht]
\begin{center}
-\psfig{figure=FullParisNoShield.eps,width=8cm,height=8cm,angle=0}
+\psfig{figure=paris_fig3.eps,width=8cm,height=8cm,angle=0}
\end{center}
\caption{Spherical configuration of Paris, without shielding.}
\label{fig:Paris1}
@@ -97,7 +97,7 @@ ShieldPhParis classes).
\begin{figure*}[ht]
\begin{center}
-\psfig{figure=FullParis.eps,width=8cm,height=8cm,angle=0}
+\psfig{figure=paris_fig4.eps,width=8cm,height=8cm,angle=0}
\end{center}
\caption{Spherical configuration of Paris, with shielding.}
\label{fig:Paris2}
@@ -108,13 +108,13 @@ As for other NPTool simulations, to run Paris simulations the following command
be executed:
\begin{verbatim}
- Simulation -D yyy.detector -E xxx.reaction
+ npsimulation -D yyy.detector -E xxx.reaction
\end{verbatim}
where xxx.reaction is an input file describing the event generator and
yyy.detector is an input file describing the detector geometry. All these
input files are based on keywords and can be found in the
-\$NPTool/Inputs subdirectories.
+\$NPTOOL/Inputs subdirectories.
\subsubsection{Event Generators}
In the distributed version, a source of $\gamma$-ray either at rest or in motion along the
@@ -201,7 +201,7 @@ an example.
The electromagnetic physics process used by default in NPTool is the standard GEANT4 physics
list. The user can however choose a different physics list amongst the Standard, Low Energy
-and Penelope physics list by modifying the file: \$NPTool/NPSimulation/src/PhysicList.cc.
+and Penelope physics list by modifying the file: \$NPTOOL/NPSimulation/src/PhysicList.cc.
As an example,in order to choose the low energy physics list (recommended), open the
PhysicList.cc file and comment and uncomment the relevant lines as follow:
@@ -273,7 +273,7 @@ PhysicList.cc file and comment and uncomment the relevant lines as follow:
\subsection{Simulation output}
Again, as in other NPTool simulations, the results of the simulations are in the ROOT format
-and the output file is stored in the \$NPTool/Output/Simulation directory. If the PARIS
+and the output file is stored in the \$NPTOOL/Output/Simulation directory. If the PARIS
geometry input file includes the NaI Shield, the output ROOT file contains four classes:
\begin{itemize}
@@ -312,24 +312,24 @@ geometry input file includes the NaI Shield, the output ROOT file contains four
Only a very preliminary analysis code is provided with this release.
\subsection{Paris}
-The analysis code for the Paris array is in the \$NPTool/NPAnalysis/Paris
+The analysis code for the Paris array is in the \$NPTOOL/Projects/Paris
directory. For the moment the main feature is the photopeak efficiency as function of the
$\gamma$-ray incoming energy. The photopeak efficiency in each layer of the array is
calculated as well as for the NaI sheild. The full photopeak efficiencies, with and without
add-back correction between the different layers, are also determined.
\subsubsection{Running the analysis}
-To run NPAnalysis the following command line should be executed in the
-\$NPTool/NPAnalysis/Paris directory:
+The following command line should be executed in the
+\$NPTOOL/Projects/Paris directory:
\begin{verbatim}
- ./Analysis -D yyy.detector -E xxx.reaction -R RunToTreat.txt
+ npanalysis -D yyy.detector -E xxx.reaction -R RunToTreat.txt
\end{verbatim}
where xxx.reaction is the input file describing the event generator used in
NPSimulation and yyy.detector is the input file describing the detector geometry
used in NPSimulation. All these input files are based on keywords and can be found
-in the \$NPTool/Inputs subdirectories. The RunToTreat.txt file contains the
+in the \$NPTOOL/Inputs subdirectories. The RunToTreat.txt file contains the
name of the files (either from NPSimulation or from real experiment) which should
be analysed. The name of the tree should also be specified. An example
of such a file is given here:
@@ -344,7 +344,7 @@ of such a file is given here:
\subsubsection{Results of the analysis}
-The results of the analysis are stored in a ROOT file in the \$NPTool/Output/Analysis
+The results of the analysis are stored in a ROOT file in the \$NPTOOL/Output/Analysis
directory.
diff --git a/Documentation/Parismodule1.eps b/Documentation/detectors/paris_fig1.eps
similarity index 100%
rename from Documentation/Parismodule1.eps
rename to Documentation/detectors/paris_fig1.eps
diff --git a/Documentation/Paris3by3.eps b/Documentation/detectors/paris_fig2.eps
similarity index 100%
rename from Documentation/Paris3by3.eps
rename to Documentation/detectors/paris_fig2.eps
diff --git a/Documentation/FullParisNoShield.eps b/Documentation/detectors/paris_fig3.eps
similarity index 100%
rename from Documentation/FullParisNoShield.eps
rename to Documentation/detectors/paris_fig3.eps
diff --git a/Documentation/FullParis.eps b/Documentation/detectors/paris_fig4.eps
similarity index 100%
rename from Documentation/FullParis.eps
rename to Documentation/detectors/paris_fig4.eps
--
GitLab